Skip to main content
GET
/
status
/
{job_id}
Get Job Status
curl --request GET \
  --url https://{base_url}/status/{job_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "PREDICT",
  "status": "IN_QUEUE",
  "execution_time": 123,
  "delay_time": 123,
  "file": {
    "id": "<string>",
    "filename": "<string>",
    "type": "<string>",
    "total_pages": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "preview_url": "<string>",
    "preview_expires_at": "2023-11-07T05:31:56Z"
  },
  "config": {
    "template_id": "<string>",
    "parser_mode": "LITE",
    "extraction_mode": "<string>",
    "use_chunk": true,
    "chunk_strategy": "<string>",
    "chunk_size": 123,
    "page_ranges": [
      {}
    ],
    "enable_citations": true
  },
  "output": {
    "type": "json",
    "extraction": {},
    "confidences": {
      "average": 123,
      "fields": {}
    },
    "annotations": {
      "blocks": [
        {
          "type": "HEADER",
          "bbox": [
            123
          ],
          "page": 123,
          "confidence": 123,
          "width": 123,
          "height": 123
        }
      ],
      "words": [
        {
          "text": "<string>",
          "bbox": [
            123
          ],
          "page": 123,
          "confidence": 123,
          "width": 123,
          "height": 123
        }
      ],
      "lines": [
        {
          "text": "<string>",
          "bbox": [
            123
          ],
          "page": 123,
          "confidence": 123,
          "width": 123,
          "height": 123
        }
      ],
      "markdown": [
        "<string>"
      ]
    },
    "markdown": [
      "<string>"
    ],
    "url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  },
  "error": {
    "code": "PROCESSING_ERROR",
    "message": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

job_id
string
required

Job identifier

Response

Job status and results (response structure varies by job type)

PREDICT job status response with extraction results

id
string<uuid>
required

Job identifier

type
enum<string>
required

Job type

Available options:
PREDICT
status
enum<string>
required

Current job status

Available options:
IN_QUEUE,
IN_PROGRESS,
COMPLETED,
FAILED,
CANCELLED
execution_time
integer

Processing time in milliseconds (0 if not started)

delay_time
integer

Queue wait time in milliseconds (creation to worker start)

file
object

Detailed file information

config
object

Job configuration details (PREDICT jobs only)

output
object
error
object

Error details for failed jobs