EndpointsDocument Intelligence

Create Upload URL

View as Markdown
Creates a direct-upload handle for a file to be processed later. **Flow:** 1. Call this endpoint with the MIME type you will upload (e.g. `application/pdf`). 2. Upload the file using the returned `method`, `url` and `headers` before `expires_at`. 3. Pass the returned `upload_id` through the `upload_ids` field on a later digitise or extract job request. When `content_type` is set, the upload's `Content-Type` header must match it.

Authentication

api-subscription-keystring
API Key authentication via header

Request

This endpoint expects an object.
content_typestringOptional

MIME type the client will PUT; when set, the upload’s Content-Type header must match.

Response

Created
upload_idstring

Handle for the uploaded file. Pass it through upload_ids on a later digitise or extract job request.

methodstring

HTTP method to use for the upload (e.g. PUT).

urlstring
Presigned URL to upload the file to.
expires_atstring
Timestamp after which the upload URL is no longer valid.
headersmap from strings to strings
Headers that must be sent with the upload request.

Errors

400
Bad Request Error
402
Payment Required Error
403
Forbidden Error
429
Too Many Requests Error
503
Service Unavailable Error