Theme switcher

Upload a new document

Header Parameters

Authorizationstring

A security token used to authenticate the API request.

Body Parameters

docIdstring Required

External document ID

fieldsstring

Stringified JSON, array of Field schema objects. Note that string values cannot exceed 5000 characters.

filestring Required

File object

uploadPathstring

"/" separated path to the folder to contain the uploaded file. Will create the specified folder structure if it does not already exist.

runCustomModelsboolean

Whether to run custom models on the uploaded document. Default is "false".

Default value
false

Response

202
Object
Request has been accepted

Response Attributes

statusstring Required

Represents the current status of the API request.

Enum values:
IN_PROGRESSREADYFAILED
evisortIdstring Required

Evisort document handler ID (string). GET /documents returns this same id as an integer.

400
Object
Invalid request parameters

Response Attributes

errorstring

Indicates any errors that occurred during the API request.

401
Object
Access token is missing or invalid

Response Attributes

errorstring

Indicates any errors that occurred during the API request.

403
Object
Forbidden

Response Attributes

errorstring

Indicates any errors that occurred during the API request.

500
Object
Internal/Unexpected Error

Response Attributes

errorstring

Indicates any errors that occurred during the API request.

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot