Skip to navigation

Get Download Links

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.

Returns presigned URLs for downloading output files.

Method: POST only. A GET request to this path returns 405 Method Not Allowed.

Prerequisites:

  • Job must be in Completed or PartiallyCompleted state
  • Failed jobs have no output available

Authentication

api-subscription-keystring
API Key authentication via header

Path parameters

job_idstringRequiredformat: "uuid"
The unique identifier of the job

Response

Successful Response
job_idstringformat: "uuid"

Job identifier (UUID)

job_stateenum
Current job state
storage_container_typeenum
Storage backend type
Allowed values:
download_urlsmap from strings to objects
Map of filename to presigned download URL details
error_codestring or nullOptional
error_messagestring or nullOptional

Errors

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