Skip to main content
Extract returns your extracted data as structured JSON matching your schema. The response format differs depending on whether citations are enabled.

Response Structure

Without Citations (Default)

When citations are disabled (the default), result contains an array of objects with your extracted values directly:

Top-Level Fields


Accessing Values

Without Citations

When citations are disabled, access values directly from the result array:

With Citations

When citations are enabled, values are wrapped in objects with value and citations fields:
When a field cannot be extracted, it may appear as null or be absent entirely, depending on whether it was marked as required in your schema.

Citations

When settings.citations.enabled is true, the response format changes. The result becomes an object (not an array), and each value is wrapped with citation data:

Citation Fields

Bounding Box Coordinates

All coordinates are normalized to the range [0, 1] relative to page dimensions: To convert to pixel coordinates, multiply by the page dimensions:

Array Citations

For array fields, each item in the array has its own citations. The structure mirrors the data:
Each field within each array item has its own citation pointing to where that specific value was found.

Spreadsheet Citations

Excel and other spreadsheet formats use a different coordinate system because they have cells, not continuous pages.

Coordinate Differences

Example Spreadsheet Citation

This citation points to cell B5 on the first sheet. To convert to Excel notation, add 1 to top for the row number and map left to a letter (0 = A, 1 = B, etc.).

Confidence Scores

Confidence indicates how certain the extraction is about a value. Each citation includes both summary and detailed confidence information.

Summary Confidence

The confidence field provides a quick assessment:
Values are either "high" or "low" based on internal thresholds.

Granular Confidence

The granular_confidence object provides detailed numerical scores:
Use granular confidence when you need to set custom thresholds or debug extraction issues. Low parse_confidence suggests the source document may have OCR or layout problems. Low extract_confidence suggests the schema description may need refinement.

Usage and Credits

The usage object shows what was processed and what it cost:
Credit calculation varies based on:
  • Number of pages processed
  • Whether agentic parsing modes were used
  • Whether optimize_for_latency was enabled (2x multiplier)
  • Spreadsheet complexity (cell count for Excel files)
See Credit Usage for detailed pricing.

Complete Example


Extract Overview

Quick start and parameters.

Citations Guide

Working with source locations.

Array Extraction

Handle long documents with repeating data.

Best Practices

Schema design and prompt tips.