Interactive API Reference: Explore all endpoints with the interactive API playground in the navigation. This page covers API-wide conventions and standards.
Base URL
Error Codes
400 - Bad Request
400 - Bad Request
Common Codes:
FILE_TOO_LARGE: File exceeds 20MB limitBAD_REQUEST: Invalid request parametersINVALID_REQUEST: Request format or content is invalidINVALID_SCHEMA: JSON schema is malformedINVALID_FILE_FORMAT: Unsupported file formatINVALID_DOCUMENT_TYPE: Document type not supportedINVALID_JOB_STATE: Job not in valid state for operationMISSING_REQUIRED_FIELD: Required field is missingMAX_RETRIES_EXCEEDED: Job retry limit reached
401 - Unauthorized
401 - Unauthorized
404 - Not Found
404 - Not Found
Common Codes:
NOT_FOUND: Resource not foundFILE_NOT_FOUND: File ID does not existJOB_NOT_FOUND: Job ID does not existTEMPLATE_NOT_FOUND: Template ID does not exist
429 - Rate Limited
429 - Rate Limited
Common Codes:
QUOTA_EXCEEDED: Plan limits reached (monthly/daily quota)RATE_LIMITED: Too many requests per minuteRATE_LIMIT_EXCEEDED: Rate limit threshold exceeded
500 - Internal Server Error
500 - Internal Server Error
Common Codes:
PROCESSING_FAILED: Document processing errorJOB_PROCESSING_FAILED: Job execution failedTEMPLATE_OPERATION_FAILED: Template operation errorINTERNAL_ERROR: Unexpected server errorSERVICE_UNAVAILABLE: Service temporarily unavailable
Pagination
List endpoints support pagination with these parameters:page: Page number (starts at 1)limit: Items per page (max 20, default 10)
Webhooks
For async operations, configure webhooks to receive notifications:Best Practices
Use File IDs
Upload once, reference by ID for multiple operations
Implement Retry Logic
Handle transient errors with exponential backoff
Monitor Rate Limits
Check rate limit headers and adjust request rate
Use Async for Large Files
Use async endpoints for documents over 5 pages
SDK and Libraries
Official SDKs are coming soon. For now, use standard HTTP clients in your preferred language.