BatchJobResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/llamaparse/main/json-schema/llamaparse-batchjobresponse-schema.json",
  "title": "BatchJobResponse",
  "description": "Response schema for a batch processing job.",
  "properties": {
    "status": {
      "$ref": "#/components/schemas/BatchJobStatus",
      "description": "Current job status"
    },
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "title": "Effective At"
    },
    "job_record_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Record Id",
      "description": "The job record ID associated with this status, if any."
    },
    "error_message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error Message",
      "description": "Error message for the latest job attempt, if any."
    },
    "id": {
      "type": "string",
      "title": "Id",
      "description": "Unique identifier for the batch job",
      "examples": [
        "bjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
      ]
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created At",
      "description": "Creation datetime"
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At",
      "description": "Update datetime"
    },
    "project_id": {
      "type": "string",
      "title": "Project Id",
      "description": "Project this job belongs to",
      "examples": [
        "proj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
      ]
    },
    "directory_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Directory Id",
      "description": "Directory being processed",
      "examples": [
        "dir-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
      ]
    },
    "job_type": {
      "$ref": "#/components/schemas/BatchJobType",
      "description": "Type of processing operation (parse or classify)"
    },
    "total_items": {
      "type": "integer",
      "title": "Total Items",
      "description": "Total number of items in the job"
    },
    "processed_items": {
      "type": "integer",
      "title": "Processed Items",
      "description": "Number of items processed so far",
      "default": 0
    },
    "failed_items": {
      "type": "integer",
      "title": "Failed Items",
      "description": "Number of items that failed processing",
      "default": 0
    },
    "skipped_items": {
      "type": "integer",
      "title": "Skipped Items",
      "description": "Number of items skipped (already processed or size limit)",
      "default": 0
    },
    "workflow_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Workflow Id",
      "description": "Async job tracking ID"
    },
    "started_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Started At",
      "description": "Timestamp when job processing started"
    },
    "completed_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Completed At",
      "description": "Timestamp when job completed"
    }
  },
  "type": "object",
  "required": [
    "status",
    "id",
    "project_id",
    "job_type",
    "total_items"
  ]
}