Skip to main content
POST
/
api
/
extractor
/
v1
/
extract
curl -X POST https://api.example.com/api/extractor/v1/extract \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/document.pdf",
    "schema": {
      "fields": [
        {"name": "invoice_number", "type": "string"},
        {"name": "total_amount", "type": "number"}
      ]
    }
  }'

{
  "data": {},
  "confidence": 0.5
}
This API requires authentication. See our Authentication Guide for details.

​
Features

  • Supports PDF and image files (jpg, jpeg, png)
  • Accepts URLs or base64-encoded file content
  • Maximum file size: 10MB
  • Supports both direct schema and template-based extraction

​
Input Options

  1. Document URL
  2. Base64 encoded file content
  3. Direct extraction schema or template ID
curl -X POST https://api.example.com/api/extractor/v1/extract \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/document.pdf",
    "schema": {
      "fields": [
        {"name": "invoice_number", "type": "string"},
        {"name": "total_amount", "type": "number"}
      ]
    }
  }'

Body

application/json · Request Data · object

Response

Successful Response

​
data
object
required
​
confidence
number
required
Required range: 0 <= x <= 1
⌘I