Skip to main content
The DocIntell API is a RESTful API that allows you to ingest documents, track extraction jobs, and receive webhook notifications.

​
Base URL

https://api.docintell.com

​
Authentication

All endpoints (except /health) require Bearer token authentication: 
Authorization: Bearer dk_live_YOUR_API_KEY
See Authentication for details on obtaining and managing API keys.

​
API Endpoints

Documents

Upload and manage PDF documents

Jobs

Track extraction job status

Webhooks

Configure webhook notifications

API Keys

Manage API keys programmatically

System

Health check endpoints

​
OpenAPI Specification

The API is documented using OpenAPI 3.0. You can access the specification at:
  • JSON: https://api.docintell.com/openapi.json
  • Swagger UI: https://api.docintell.com/docs
  • ReDoc: https://api.docintell.com/redoc

​
Response Format

All responses are JSON. Successful responses return the requested data: 
{
  "document_id": "019370ab-c123-7def-8901-234567890abc",
  "status": "completed"
}
Error responses follow RFC 7807 (Problem Details): 
{
  "error": "error_code",
  "message": "Human-readable description",
  "details": {}
}

​
Rate Limits

OperationLimit
Document Ingestion100/hour
Job Status Checks1,000/hour
Rate limit headers are included in every response: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1701612000

​
Pagination

List endpoints support pagination:
ParameterTypeDefaultDescription
pageinteger1Page number (1-indexed)
per_pageinteger20Items per page (max 100)
Response includes pagination metadata: 
{
  "documents": [...],
  "total": 42,
  "page": 1,
  "per_page": 20
}

​
SDKs & Examples

Python

Python examples

TypeScript

TypeScript examples

cURL

cURL examples