Extract

An Extraction pulls precise fields out of a document. By providing a standard JSON Schema, you instruct the language model to locate, format, and return a matching JSON object, turning unstructured documents into structured records.

{
  "totalAmount": 450,
  "invoiceNumber": "..."
}

• Schema Adherence: the output is validated against your JSON Schema.
• Complex Data Extraction: extract nested arrays (like invoice line items) or deep hierarchical objects.
• Contextual Instructions: add instructions to guide the model on specific fields.

🏗️ ConfigurationCopy Anchor Link

An Extraction is an Operation: it parses the Document, then extracts the fields.

The model reads the first 20,000 characters of the parsed Document; when it is longer, the Output reports truncated: true.

🛠️ Extract from a DocumentCopy Anchor Link

For every field and parameter, see the Extractions reference.

Submit an ExtractionCopy Anchor Link

curl -X POST "https://api.axelered.com/v1/extractions?wait=30" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@/path/to/invoice.pdf" \
  -F 'config={
    "outputSchema": {
      "type": "object",
      "properties": {
        "invoiceNumber": { "type": "string" },
        "totalAmount": { "type": "number" }
      },
      "required": ["invoiceNumber", "totalAmount"]
    },
    "tier": "accurate",
    "parsing": { "tier": "accurate" }
  }'

Once the Extraction is done, the extracted object is in its output:

{
  "status": "done",
  "output": {
    "value": { "invoiceNumber": "INV-0042", "totalAmount": 450 },
    "truncated": false
  }
}

List, Read & DeleteCopy Anchor Link

• List Extractions: newest first, optionally for one Document with ?documentId=. Lists leave out the output.
• Read Extraction: status, credits and output, with optional wait.
• Delete Extraction: hide an Extraction. Its Document is kept.