Skip to main content
POST
/
v0
/
documents
/
optimize
Bulk optimize multiple documents
curl --request POST \
  --url https://api.avidoai.com/v0/documents/optimize \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "documentIds": [
    "123e4567-e89b-12d3-a456-426614174000",
    "223e4567-e89b-12d3-a456-426614174001",
    "323e4567-e89b-12d3-a456-426614174002"
  ]
}'
{
  "success": [
    "123e4567-e89b-12d3-a456-426614174000",
    "223e4567-e89b-12d3-a456-426614174001"
  ],
  "failed": []
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

Body

application/json

Request body for bulk optimizing multiple documents

​
documentIds
string<uuid>[]
required

Array of document IDs to optimize. Maximum 100 documents per request.

Required array length: 1 - 100 elements
Example:
[
  "123e4567-e89b-12d3-a456-426614174000",
  "223e4567-e89b-12d3-a456-426614174001"
]

Response

Bulk optimization request processed

Response containing success and failure information

​
success
string<uuid>[]
required

Array of document IDs that were successfully queued

Example:
["123e4567-e89b-12d3-a456-426614174000"]
​
failed
object[]
required

Array of document IDs that failed with reasons

⌘I