Execute a predefined extractor on a document to extract specific information. Each extractor is designed to identify and extract particular types of data from documents.
Request Bearer token authentication. Example: Bearer YOUR_API_KEY
Path Parameters The unique identifier (slug) of the extractor to use
Body Parameters Optional webhook URL to receive processing status updates
Example Request curl -X POST https://api.doctly.ai/api/v1/e/invoice-extractor \ -H "Authorization: Bearer YOUR_API_KEY" \
-F "file=@invoice.pdf" \
-F "callback_url=https://your-domain.com/webhook"
Response Unique identifier for the document
Size of the file in bytes
ISO 8601 timestamp of creation
Current processing status: PENDING, PROCESSING, COMPLETED, FAILED, or EXPIRED
Number of pages in the document
Information about the extractor used.
Unique identifier for the extractor
Display name of the extractor
URL-friendly identifier for the extractor
Example Responses 200 OK
404 Not Found
422 Unprocessable Entity
{ "id" : "123e4567-e89b-12d3-a456-426614174000" ,
"file_name" : "invoice.pdf" ,
"file_size" : 1048576 ,
"created_at" : "2024-03-21T13:45:00Z" ,
"status" : "PENDING" ,
"page_count" : 12 ,
"extractor_id" : "987fcdeb-a654-3210-9876-543210987654" ,
"extractor" : {
"id" : "987fcdeb-a654-3210-9876-543210987654" ,
"name" : "Invoice Extractor" ,
"slug" : "invoice-extractor"
}
} Webhook Notifications If a callback_url is provided, you will receive POST requests with status updates:
Each extractor is designed for specific types of documents. Using the wrong extractor may result in incomplete or incorrect data extraction.
