Documents API
Create, retrieve, and manage document processing jobs
The Documents API allows you to upload, process, and manage documents. This is the core of DocuRift's functionality and the primary way you'll interact with our service. Whether you're processing a single invoice or thousands of shipping documents, these endpoints handle all your document extraction needs.
The Documents API supports both synchronous and asynchronous processing modes. Synchronous processing returns results immediately and is ideal for interactive applications. Asynchronous processing queues documents for background processing and notifies you via webhooks when complete, making it perfect for batch processing and high-volume workflows.
Overview
Documents go through a three-step processing pipeline when uploaded to DocuRift:
- Upload - Submit a document file (PDF, PNG, JPEG)
- Process - AI extracts structured data from the document
- Retrieve - Access the extracted data via the API
Available Endpoints
Process (Sync)
Process a document and get results immediately
Process (Async)
Submit for background processing with webhook notification
Get Document
Retrieve processed document data by ID
List Documents
Query your document processing history
Delete Document
Permanently remove a processed document
Sync vs Async Processing
| Feature | Sync | Async | |---------|------|-------| | Response Time | Immediate (2-10s) | Background | | Max File Size | 10 MB | 50 MB | | Webhook Support | No | Yes | | Best For | Small documents, real-time apps | Large documents, batch processing |
Common Headers
All document endpoints require authentication:
X-API-Key: frc_your_api_key_here
Content-Type: multipart/form-data
Rate Limits
- Free tier: 10 requests per minute
- Paid plans: Up to 1000 requests per minute
See API Keys for more details on rate limiting.