Endpoint
Authentication
Requireswrite:extractions scope.
Request
Headers
| Header | Value | Required |
|---|---|---|
X-API-Key | Your API key | Yes |
Body
Form data with file uploads:| Field | Type | Required | Description |
|---|---|---|---|
files | file | Yes | One or more files to upload (can repeat for multiple files) |
Supported File Types
- PDF:
.pdf - Word:
.docx - Images:
.jpg,.jpeg,.png,.tiff
File Size Limits
- Maximum file size: 50 MB per file
- Maximum files per request: 10 files
Response
Success Response (200)
Returns an array of document IDs:Examples
Error Responses
400 Bad Request
Invalid file type or size:401 Unauthorized
Missing or invalid API key:413 Payload Too Large
File exceeds size limit:500 Internal Server Error
Server error during upload:Best Practices
Batch Upload for Efficiency
Batch Upload for Efficiency
Upload multiple files in a single request instead of making multiple requests. This is faster and more efficient.
Check File Size Before Upload
Check File Size Before Upload
Validate file sizes client-side to avoid failed uploads and improve user experience.
Handle Upload Errors
Handle Upload Errors
Implement retry logic with exponential backoff for failed uploads, especially for large files.
Store Document IDs
Store Document IDs
Save the returned document IDs for future extraction requests. Document IDs are permanent and can be used repeatedly.
Rate Limits
Upload endpoint is subject to rate limits based on your subscription tier. Contact support for higher limits.Notes
- Uploaded documents are stored securely and retained for 90 days
- Document IDs are permanent and don’t change
- Multiple uploads of the same file (within 5 minutes) return the same document ID
- Files are automatically processed for OCR and layout analysis