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
| Field | Type | Description |
|---|---|---|
job_id | string | Unique identifier for this extraction job. Use this to retrieve results later or reference in support requests. |
result | array or object | Without citations: an array containing your extracted data. With citations: an object with wrapped values. |
usage.num_pages | integer | Number of document pages processed. |
usage.num_fields | integer | Total number of fields extracted, including nested fields in arrays. |
usage.credits | number | Credits consumed for this extraction. |
studio_link | string | Link to view and debug this extraction in Reducto Studio. |
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 withvalue and citations fields:
null or be absent entirely, depending on whether it was marked as required in your schema.
Citations
Whensettings.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
| Field | Description |
|---|---|
type | Block type where the value was found: Text, Table, Key Value, etc. |
content | The source text from which the value was extracted. May differ slightly from the extracted value due to formatting normalization. |
bbox | Bounding box coordinates for the source location. |
confidence | Overall confidence as "high" or "low". |
granular_confidence | Detailed confidence breakdown with extract_confidence (0-1) and parse_confidence (0-1). |
parentBlock | The larger Parse block containing this citation. Useful for context when the citation is very granular. |
Bounding Box Coordinates
All coordinates are normalized to the range [0, 1] relative to page dimensions:| Field | Description |
|---|---|
left | Distance from the left edge. 0 is the left margin, 1 is the right margin. |
top | Distance from the top edge. 0 is the top, 1 is the bottom. |
width | Width as a fraction of page width. |
height | Height as a fraction of page height. |
page | Page number (1-indexed) in the processed document. |
original_page | Page number in the original document. Differs from page when using page_range to process a subset. |
Array Citations
For array fields, each item in the array has its own citations. The structure mirrors the data:Spreadsheet Citations
Excel and other spreadsheet formats use a different coordinate system because they have cells, not continuous pages.Coordinate Differences
| Aspect | PDFs/Images | Spreadsheets |
|---|---|---|
| Coordinate system | Normalized 0-1 range | Cell positions (1-indexed) |
left | Fraction of page width | Column number (1 = A, 2 = B, etc.) |
top | Fraction of page height | Row number |
width | Fraction of page width | Number of columns spanned |
height | Fraction of page height | Number of rows spanned |
page | Page number | Sheet index (1 = first sheet) |
Example Spreadsheet Citation
Confidence Scores
Confidence indicates how certain the extraction is about a value. Each citation includes both summary and detailed confidence information.Summary Confidence
Theconfidence field provides a quick assessment:
"high" or "low" based on internal thresholds.
Granular Confidence
Thegranular_confidence object provides detailed numerical scores:
| Score | Description |
|---|---|
extract_confidence | How confident the extraction LLM is about this value (0-1). May be null for array items. |
parse_confidence | How confident the parsing stage was about the source text (0-1). Reflects OCR and layout detection quality. |
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
Theusage object shows what was processed and what it cost:
| Field | Description |
|---|---|
num_pages | Document pages that were processed. Affected by page_range settings. |
num_fields | Total leaf fields extracted. A schema with 5 scalar fields and an array of 10 objects with 2 fields each would report 25 fields. |
credits | Credits charged. Based on pages processed plus complexity factors like agentic modes and latency optimization. |
- Number of pages processed
- Whether agentic parsing modes were used
- Whether
optimize_for_latencywas enabled (2x multiplier) - Spreadsheet complexity (cell count for Excel files)
Complete Example
Full response with citations enabled
Full response with citations enabled
Related
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.