Sign in

v2

latestOpenAPI 3.1.02026-07-2628105122.0 KB
documentIntelligence

Start Document Intelligence Job

Validates the uploaded file and starts processing.

Validation Checks:

  • File must be uploaded before starting
  • File size must not exceed 200 MB
  • PDF must be parseable by the PDF parser
  • ZIP must contain only JPEG/PNG images
  • ZIP must be flat (no nested folders beyond one level)
  • ZIP must contain at least one valid image
  • Page/image count must not exceed 10 (returns 400 with invalid_request_error if exceeded)
  • User must have sufficient credits

Processing: Job runs asynchronously. Poll the status endpoint or use webhook callback for completion notification.

post/doc-digitization/job/v1/{job_id}/start

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