Appearance
Upload document to project
Upload a document to the system.
Endpoint
POST /api/v1/external/projects/{projectUuid}/documentsHeaders
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer token for authentication |
| Content-Type | string | Yes | Must be multipart/form-data |
| Accept | string | No | Must be application/json |
Request Body
The request should be sent as multipart/form-data with the following fields:
| Field | Type | Required | Description |
|---|---|---|---|
| files[] | file | Yes | The document files to upload |
| classify | boolean | No | Request 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
| Parameter | Type | Required | Description |
|---|---|---|---|
| projectUuid | string | Yes | The 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"
}