For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CommunityAPI StatusAPI PricingSign Up
DocumentationAPI ReferencesCookbookIntegrationDeveloper Tools
DocumentationAPI ReferencesCookbookIntegrationDeveloper Tools
  • API Reference
    • Introduction
    • Authentication
    • Access to Beta APIs
    • Meta Prompt Guide
  • Endpoints
      • POSTCreate Document Intelligence Job
      • POSTGet Document Intelligence Upload URLs
      • POSTStart Document Intelligence Job
      • GETGet Document Intelligence Job Status
      • POSTGet Document Intelligence Download URLs
LogoLogo
CommunityAPI StatusAPI PricingSign Up
EndpointsDocument Intelligence

Create Document Intelligence Job

||View as Markdown|
POST
https://api.sarvam.ai/doc-digitization/job/v1
POST
/doc-digitization/job/v1
$curl -X POST https://api.sarvam.ai/doc-digitization/job/v1 \
>     -H "api-subscription-key: <apiSubscriptionKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "job_id": "string",
3  "storage_container_type": "Azure",
4  "job_parameters": {
5    "language": "hi-IN",
6    "output_format": "html"
7  },
8  "job_state": "Accepted"
9}
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 - `or-IN`: Odia - `pa-IN`: Punjabi - `ta-IN`: Tamil - `te-IN`: Telugu - `ur-IN`: Urdu - `as-IN`: Assamese - `bodo-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
Was this page helpful?
Previous

Get Document Intelligence Upload URLs

Next
Built with

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
  • or-IN: Odia
  • pa-IN: Punjabi
  • ta-IN: Tamil
  • te-IN: Telugu
  • ur-IN: Urdu
  • as-IN: Assamese
  • bodo-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.

callbackobject or nullOptional
Optional webhook for completion notification

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