API Reference
API Introduction
Getting started with the Flint API
API Introduction
The Flint API provides programmatic access to all document processing capabilities, enabling seamless integration with your existing systems.
Base URL
All API requests are made to:
https://api.flint.comAuthentication
The Flint API uses API keys for authentication. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEYRate Limits
- Standard tier: 100 requests per minute
- Professional tier: 500 requests per minute
- Enterprise tier: Custom limits
Response Format
All API responses return JSON:
{
"success": true,
"data": {
// Response data
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"request_id": "req_abc123"
}
}Error Handling
Errors follow a consistent format:
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid document format",
"details": {
// Additional error details
}
}
}Common HTTP Status Codes
200 OK- Request successful201 Created- Resource created400 Bad Request- Invalid request parameters401 Unauthorized- Invalid or missing API key429 Too Many Requests- Rate limit exceeded500 Internal Server Error- Server error
Next Steps
- Authentication - Set up API authentication
- Documents API - Process and manage documents
- Templates - Create smart data extraction templates
- OCR & Processing - Extract text and data from documents
- Webhooks - Receive real-time updates
- Organizations - Manage team members and permissions