Skip to navigation
APIsLegacyDocument Intelligence

Initialise Job

View as Markdown

Legacy API. The /doc-digitization/job/v1 endpoints remain available for existing integrations. For new integrations, use the Document Intelligence API under /doc-ai/v1.

Creates a new Document Intelligence job.

Supported Languages (BCP-47 format):

  • hi-IN: Hindi (default)
  • en-IN: English
  • bn-IN: Bengali
  • gu-IN: Gujarati
  • kn-IN: Kannada
  • ml-IN: Malayalam
  • mr-IN: Marathi
  • od-IN: Odia
  • pa-IN: Punjabi
  • ta-IN: Tamil
  • te-IN: Telugu
  • ur-IN: Urdu
  • as-IN: Assamese
  • brx-IN: Bodo
  • doi-IN: Dogri
  • ks-IN: Kashmiri
  • kok-IN: Konkani
  • mai-IN: Maithili
  • mni-IN: Manipuri
  • ne-IN: Nepali
  • sa-IN: Sanskrit
  • sat-IN: Santali
  • sd-IN: Sindhi

Output Formats (delivered as ZIP file):

  • html: Structured HTML files with layout preservation
  • md: Markdown files (default)
  • json: Structured JSON files for programmatic processing

Authentication

api-subscription-keystring
API Key authentication via header

Request

This endpoint expects an object.
job_parametersobjectOptional

Configuration parameters for the Document Intelligence job including language and output format. Defaults to Hindi (hi-IN) and Markdown output if omitted.

Response

Successful Response
job_idstringformat: "uuid"

Unique job identifier (UUID)

storage_container_typeenum
Storage Container Type
Allowed values:
job_parametersobject
Job configuration parameters
job_stateenum
Current state of the document intelligence job

Errors

400
Bad Request Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error