Skip to content

Upload document to project ​

Upload a document to the system.

Endpoint ​

POST /api/v1/external/projects/{projectUuid}/documents

Headers ​

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token for authentication
Content-TypestringYesMust be multipart/form-data
AcceptstringNoMust be application/json

Request Body ​

The request should be sent as multipart/form-data with the following fields:

FieldTypeRequiredDescription
files[]fileYesThe document files to upload
classifybooleanNoRequest classification and splitting according to the project settings. Explicit false bypasses classification. If omitted, follows Classify and split files uploaded from the app by default (off when unset).

Classification can produce several documents or hold a file for review. Off still holds a multi-document file when classification was requested. See Document splitting API for the policy, application endpoints and metadata.

Parameters ​

ParameterTypeRequiredDescription
projectUuidstringYesThe UUID of the project to upload the document to. Can be found in the Recognito application.

Response ​

Success Response (200 OK) ​

json
{
  "status": "success"
}

The response contains no document UUID or request ID. Splitting does not change this response or webhook payloads.

Error Response (400 Bad Request) ​

json
{
  "error": "string",
  "message": "string"
}

Example ​

Request ​

bash
curl -X POST https://apiv2.recognito.io/api/v1/external/projects/{projectUuid}/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "files[]=@/path/to/document.pdf" \
  -F "files[]=@/path/to/document2.pdf" \
  -F "classify=true"

Response ​

json
{
  "status": "success"
}