Sign in

v2

latestOpenAPI 3.1.02026-07-2628105122.0 KB
documentIntelligence

Get Document Intelligence Job Status

Returns the current status of a job with page-level metrics.

Job States:

  • Accepted: Job created, awaiting file upload
  • Pending: File uploaded, waiting to start
  • Running: Processing in progress
  • Completed: All pages processed successfully
  • PartiallyCompleted: Some pages succeeded, some failed
  • Failed: All pages failed or job-level error

Page Metrics: Response includes detailed progress: total pages, pages processed, succeeded, failed, and per-page errors.

get/doc-digitization/job/v1/{job_id}/status

Path parameters

job_idstring uuid required

The unique identifier of the job

Headers

api-subscription-keystring required

Response

Successful Response

job_idstring uuid required

Job identifier (UUID)

job_state'Accepted' | 'Pending' | 'Running' | 'Completed' | 'PartiallyCompleted' | 'Failed' required

Current state of the document intelligence job

created_atstring date-time required

Job creation timestamp (ISO 8601)

updated_atstring date-time required

Last update timestamp (ISO 8601)

storage_container_type'Azure' | 'Local' | 'Google' | 'Azure_V1' required
total_filesinteger

Total input files (always 1)

successful_files_countinteger

Files that completed successfully

failed_files_countinteger

Files that failed

error_messagestring

Job-level error message