Skip to content

Parsing

Parse File
client.parsing.create(ParsingCreateParams { tier, version, organization_id, 18 more } params, RequestOptionsoptions?): ParsingCreateResponse { id, project_id, status, 7 more }
POST/api/v2/parse
Get Parse Job
client.parsing.get(stringjobID, ParsingGetParams { expand, image_filenames, organization_id, project_id } query?, RequestOptionsoptions?): ParsingGetResponse { job, forms, images_content_metadata, 9 more }
GET/api/v2/parse/{job_id}
List Parse Jobs
client.parsing.list(ParsingListParams { created_at_on_or_after, created_at_on_or_before, job_ids, 5 more } query?, RequestOptionsoptions?): PaginatedCursor<ParsingListResponse { id, project_id, status, 7 more } >
GET/api/v2/parse
Cancel Parse Job
client.parsing.cancel(stringjobID, ParsingCancelParams { organization_id, project_id } params?, RequestOptionsoptions?): ParsingCancelResponse { id, project_id, status, 7 more }
POST/api/v2/parse/{job_id}/cancel
Delete Parse Job
client.parsing.delete(stringjobID, ParsingDeleteParams { organization_id, project_id } params?, RequestOptionsoptions?): ParsingDeleteResponse { id, project_id }
DELETE/api/v2/parse/{job_id}
List Parse Versions
client.parsing.listVersions(RequestOptionsoptions?): ParsingListVersionsResponse { agentic, agentic_plus, cost_effective, 2 more }
GET/api/v2/parse/versions
ModelsExpand Collapse
BBox { h, w, x, 6 more }

Bounding box with coordinates and optional metadata.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

CodeItem { md, value, bbox, 2 more }
md: string

Markdown representation preserving formatting

value: string

Code content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

language?: string | null

Programming language identifier

type?: "code"

Code block item type

FailPageMode = "blank_page" | "error_message" | "raw_text"

Enum for representing the different available page error handling modes.

One of the following:
"blank_page"
"error_message"
"raw_text"

List of items within the footer

One of the following:
CodeItem { md, value, bbox, 2 more }
md: string

Markdown representation preserving formatting

value: string

Code content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

language?: string | null

Programming language identifier

type?: "code"

Code block item type

HeadingItem { level, md, value, 2 more }
level: number

Heading level (1-6)

md: string

Markdown representation preserving formatting

value: string

Heading text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "heading"

Heading item type

ImageItem { caption, md, url, 2 more }
caption: string

Image caption

md: string

Markdown representation preserving formatting

url: string

URL to the image

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "image"

Image item type

Markdown representation preserving formatting

Display text of the link

URL of the link

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

Link item type

ListItem { items, md, ordered, 2 more }
items: Array<TextItem { md, value, bbox, type } | ListItem { items, md, ordered, 2 more } >

List of nested text or list items

One of the following:
TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

ListItem { items, md, ordered, 2 more }
md: string

Markdown representation preserving formatting

ordered: boolean

Whether the list is ordered or unordered

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "list"

List item type

TableItem { csv, html, md, 6 more }
csv: string

CSV representation of the table

html: string

HTML representation of the table

md: string

Markdown representation preserving formatting

rows: Array<Array<string | number | null>>

Table data as array of arrays (string, number, or null)

One of the following:
string
number
bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

merged_from_pages?: Array<number> | null

List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])

merged_into_page?: number | null

Populated when merged into another table. Page number where the full merged table begins (used on empty tables).

parse_concerns?: Array<ParseConcern> | null

Quality concerns detected during table extraction, indicating the table may have issues

details: string

Human-readable details about the concern

type: string

Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)

type?: "table"

Table item type

TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

Markdown representation preserving formatting

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

Page footer container

Form { json, list }

One form detected on a page, in two representations of the same content.

json: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Structured representation: an ordered tree of sections, fields, and tables

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

list: FormListItem { items, md, ordered, type }

Flattened list representation of the same content

items: Array<FormListTextItem { md, value, type } | FormListItem { items, md, ordered, type } >

Nested lines and sub-lists, in the form’s reading order

One of the following:
FormListTextItem { md, value, type }

One line of a form’s list representation.

md: string

Markdown representation of the line

value: string

Line content (e.g. ‘[1a] Wages: 29,513’)

type?: "text"

Text line

FormListItem = FormListItem { items, md, ordered, type }
md: string

Markdown representation of this list

ordered: boolean

Whether the list is ordered

type?: "list"

List node

FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField = FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField = FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField = FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField = FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField = FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

FormListItem { items, md, ordered, type }

The list representation of form content: nested lists of rendered field lines.

items: Array<FormListTextItem { md, value, type } | FormListItem { items, md, ordered, type } >

Nested lines and sub-lists, in the form’s reading order

One of the following:
FormListTextItem { md, value, type }

One line of a form’s list representation.

md: string

Markdown representation of the line

value: string

Line content (e.g. ‘[1a] Wages: 29,513’)

type?: "text"

Text line

FormListItem = FormListItem { items, md, ordered, type }
md: string

Markdown representation of this list

ordered: boolean

Whether the list is ordered

type?: "list"

List node

FormListTextItem { md, value, type }

One line of a form’s list representation.

md: string

Markdown representation of the line

value: string

Line content (e.g. ‘[1a] Wages: 29,513’)

type?: "text"

Text line

FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection = FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }
FormSection = FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

FormSection = FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection = FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
FormSection = FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable = FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable = FormTable { rows, id, bbox, 3 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable = FormTable { rows, id, bbox, 3 more }
FormSection { items, id, label, type }
FormTable = FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable = FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems = FormTableCellItems { items }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems = FormTableCellItems { items }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems = FormTableCellItems { items }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems = FormTableCellItems { items }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems = FormTableCellItems { items }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

HeaderItem { items, md, bbox, type }
items: Array<CodeItem { md, value, bbox, 2 more } | HeadingItem { level, md, value, 2 more } | ImageItem { caption, md, url, 2 more } | 4 more>

List of items within the header

One of the following:
CodeItem { md, value, bbox, 2 more }
md: string

Markdown representation preserving formatting

value: string

Code content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

language?: string | null

Programming language identifier

type?: "code"

Code block item type

HeadingItem { level, md, value, 2 more }
level: number

Heading level (1-6)

md: string

Markdown representation preserving formatting

value: string

Heading text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "heading"

Heading item type

ImageItem { caption, md, url, 2 more }
caption: string

Image caption

md: string

Markdown representation preserving formatting

url: string

URL to the image

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "image"

Image item type

Markdown representation preserving formatting

Display text of the link

URL of the link

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

Link item type

ListItem { items, md, ordered, 2 more }
items: Array<TextItem { md, value, bbox, type } | ListItem { items, md, ordered, 2 more } >

List of nested text or list items

One of the following:
TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

ListItem { items, md, ordered, 2 more }
md: string

Markdown representation preserving formatting

ordered: boolean

Whether the list is ordered or unordered

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "list"

List item type

TableItem { csv, html, md, 6 more }
csv: string

CSV representation of the table

html: string

HTML representation of the table

md: string

Markdown representation preserving formatting

rows: Array<Array<string | number | null>>

Table data as array of arrays (string, number, or null)

One of the following:
string
number
bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

merged_from_pages?: Array<number> | null

List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])

merged_into_page?: number | null

Populated when merged into another table. Page number where the full merged table begins (used on empty tables).

parse_concerns?: Array<ParseConcern> | null

Quality concerns detected during table extraction, indicating the table may have issues

details: string

Human-readable details about the concern

type: string

Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)

type?: "table"

Table item type

TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

md: string

Markdown representation preserving formatting

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "header"

Page header container

HeadingItem { level, md, value, 2 more }
level: number

Heading level (1-6)

md: string

Markdown representation preserving formatting

value: string

Heading text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "heading"

Heading item type

ImageItem { caption, md, url, 2 more }
caption: string

Image caption

md: string

Markdown representation preserving formatting

url: string

URL to the image

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "image"

Image item type

Markdown representation preserving formatting

Display text of the link

URL of the link

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

Link item type

ListItem { items, md, ordered, 2 more }
items: Array<TextItem { md, value, bbox, type } | ListItem { items, md, ordered, 2 more } >

List of nested text or list items

One of the following:
TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

ListItem = ListItem { items, md, ordered, 2 more }
md: string

Markdown representation preserving formatting

ordered: boolean

Whether the list is ordered or unordered

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "list"

List item type

LlamaParseSupportedFileExtensions = ".abw" | ".awt" | ".azw" | 144 more

Enum for supported file extensions.

One of the following:
".abw"
".awt"
".azw"
".azw3"
".azw4"
".bmp"
".cb7"
".cbc"
".cbr"
".cbz"
".cgm"
".chm"
".csv"
".cwk"
".dbf"
".dif"
".djvu"
".doc"
".docm"
".docx"
".dot"
".dotm"
".dotx"
".epub"
".et"
".eth"
".fb2"
".fbz"
".fodg"
".fodp"
".fods"
".fodt"
".fopd"
".gif"
".heic"
".heif"
".htm"
".html"
".htmlz"
".hwp"
".jpeg"
".jpg"
".key"
".lit"
".lrf"
".lwp"
".m4a"
".mcw"
".md"
".mobi"
".mp3"
".mp4"
".mpeg"
".mpga"
".mw"
".mwd"
".numbers"
".odf"
".odg"
".odp"
".ods"
".odt"
".otg"
".otp"
".ots"
".ott"
".pages"
".pbd"
".pdb"
".pdf"
".pml"
".png"
".pot"
".potm"
".potx"
".ppt"
".pptm"
".pptx"
".prc"
".prn"
".psw"
".qpw"
".rb"
".rtf"
".sda"
".sdd"
".sdp"
".sdw"
".sgl"
".slk"
".snb"
".stc"
".std"
".sti"
".stw"
".svg"
".sxc"
".sxd"
".sxg"
".sxi"
".sxm"
".sxw"
".sylk"
".tcr"
".tif"
".tiff"
".tsv"
".txtz"
".uof"
".uop"
".uos"
".uos1"
".uos2"
".uot"
".vdx"
".vor"
".vsd"
".vsdm"
".vsdx"
".wav"
".wb1"
".wb2"
".wb3"
".webm"
".webp"
".wk1"
".wk2"
".wk3"
".wk4"
".wks"
".wn"
".wpd"
".wps"
".wpt"
".wq1"
".wq2"
".wri"
".xhtm"
".xlr"
".xls"
".xlsb"
".xlsm"
".xlsx"
".xlw"
".xml"
".yxmd"
".zabw"
ParsingJob { id, status, error_code, error_message }

A parse job (v1).

id: string

Unique parse job identifier

status: StatusEnum

Current job status

One of the following:
"CANCELLED"
"ERROR"
"PARTIAL_SUCCESS"
"PENDING"
"SUCCESS"
error_code?: string | null

Machine-readable error code when failed

error_message?: string | null

Human-readable error details when failed

ParsingLanguages = "abq" | "ady" | "af" | 83 more

Enum for representing the languages supported by the parser.

One of the following:
"abq"
"ady"
"af"
"ang"
"ar"
"as"
"ava"
"az"
"be"
"bg"
"bgc"
"bh"
"bho"
"bn"
"bs"
"ch_sim"
"ch_tra"
"che"
"cs"
"cy"
"da"
"dar"
"de"
"en"
"es"
"et"
"fa"
"fr"
"ga"
"gom"
"hi"
"hr"
"hu"
"id"
"inh"
"is"
"it"
"ja"
"kbd"
"kn"
"ko"
"ku"
"la"
"lbe"
"lez"
"lt"
"lv"
"mah"
"mai"
"mi"
"mn"
"mni"
"mr"
"ms"
"mt"
"ne"
"new"
"nl"
"no"
"oc"
"pi"
"pl"
"pt"
"ro"
"rs_cyrillic"
"rs_latin"
"ru"
"sa"
"sck"
"sk"
"sl"
"sq"
"sv"
"sw"
"ta"
"tab"
"te"
"th"
"tjk"
"tl"
"tr"
"ug"
"uk"
"ur"
"uz"
"vi"
ParsingMode = "parse_document_with_agent" | "parse_document_with_llm" | "parse_document_with_lvm" | 5 more

Enum for representing the mode of parsing to be used.

One of the following:
"parse_document_with_agent"
"parse_document_with_llm"
"parse_document_with_lvm"
"parse_page_with_agent"
"parse_page_with_layout_agent"
"parse_page_with_llm"
"parse_page_with_lvm"
"parse_page_without_llm"
StatusEnum = "CANCELLED" | "ERROR" | "PARTIAL_SUCCESS" | 2 more

Enum for representing the status of a job

One of the following:
"CANCELLED"
"ERROR"
"PARTIAL_SUCCESS"
"PENDING"
"SUCCESS"
TableItem { csv, html, md, 6 more }
csv: string

CSV representation of the table

html: string

HTML representation of the table

md: string

Markdown representation preserving formatting

rows: Array<Array<string | number | null>>

Table data as array of arrays (string, number, or null)

One of the following:
string
number
bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

merged_from_pages?: Array<number> | null

List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])

merged_into_page?: number | null

Populated when merged into another table. Page number where the full merged table begins (used on empty tables).

parse_concerns?: Array<ParseConcern> | null

Quality concerns detected during table extraction, indicating the table may have issues

details: string

Human-readable details about the concern

type: string

Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)

type?: "table"

Table item type

TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

ParsingCreateResponse { id, project_id, status, 7 more }

A parse job.

id: string

Unique parse job identifier

project_id: string

Project this job belongs to

status: "CANCELLED" | "COMPLETED" | "FAILED" | 2 more

Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED

One of the following:
"CANCELLED"
"COMPLETED"
"FAILED"
"PENDING"
"RUNNING"
created_at?: string | null

Creation datetime

formatdate-time
error_message?: string | null

Error details when status is FAILED

name?: string | null

Optional display name for this parse job

tier?: string | null

Parsing tier used for this job

updated_at?: string | null

Update datetime

formatdate-time
usage?: Usage | null

Usage recorded against a job.

credits?: number | null

Total credits billed against this job. Null until billing has recorded it.

user_metadata?: Record<string, string> | null

Key/value tags associated with this job.

ParsingGetResponse { job, forms, images_content_metadata, 9 more }

Parse result response with job status and optional content or metadata.

The job field is always included. Other fields are included based on expand parameters.

job: Job { id, project_id, status, 7 more }

Parse job status and metadata

id: string

Unique parse job identifier

project_id: string

Project this job belongs to

status: "CANCELLED" | "COMPLETED" | "FAILED" | 2 more

Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED

One of the following:
"CANCELLED"
"COMPLETED"
"FAILED"
"PENDING"
"RUNNING"
created_at?: string | null

Creation datetime

formatdate-time
error_message?: string | null

Error details when status is FAILED

name?: string | null

Optional display name for this parse job

tier?: string | null

Parsing tier used for this job

updated_at?: string | null

Update datetime

formatdate-time
usage?: Usage | null

Usage recorded against a job.

credits?: number | null

Total credits billed against this job. Null until billing has recorded it.

user_metadata?: Record<string, string> | null

Key/value tags associated with this job.

forms?: Forms | null

Per-page form analysis results (one entry per page).

pages: Array<FormsResultPage { forms, page_number, success, 2 more } | FailedFormsPage { error, page_number, success } >

List of form pages or failed page entries

One of the following:
FormsResultPage { forms, page_number, success, 2 more }

Forms found on one page. Pages without form content have an empty forms list.

forms: Array<Form { json, list } >

Forms detected on the page

json: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Structured representation: an ordered tree of sections, fields, and tables

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }

A fillable grid printed on the form: repeating records or a row-by-column matrix.

rows: Array<Array<string | FormTableCellItems { items } | null>>

Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell’s own form nodes

One of the following:
string
FormTableCellItems { items }

A table cell holding its own form nodes (e.g. a checkbox column).

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Form nodes inside the cell

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }
FormSection { items, id, label, type }

A grouping of form content, in the form’s reading order.

items: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } >

Child form nodes in reading order

One of the following:
FormField { field, id, bbox, 5 more }

One labeled form entry: a text input, checkbox, select group, or signature line.

field: "checkbox" | "multi_select" | "signature" | 2 more

Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature

One of the following:
"checkbox"
"multi_select"
"signature"
"single_select"
"text"
id?: string | null

Field number/letter printed on the form (e.g. ‘1a’), if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the field’s fillable area on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

isEmpty?: boolean | null

True for a printed-but-blank text field (mutually exclusive with value)

label?: string | null

Printed field caption, if any

type?: "field"

Form field node

value?: string | boolean | null

Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups

One of the following:
string
boolean
valueItems?: Array<FormField { field, id, bbox, 5 more } | FormSection { items, id, label, type } | FormTable { rows, id, bbox, 3 more } > | null

Options of a single_select/multi_select group (only on select fields)

One of the following:
FormField { field, id, bbox, 5 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
FormSection { items, id, label, type }
FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form (e.g. ‘Part III’), if any

label?: string | null

Printed section heading, if any

type?: "section"

Form section node

FormTable { rows, id, bbox, 3 more }
id?: string | null

Identifier printed on the form, if any

bbox?: Array<BBox { h, w, x, 6 more } > | null

Bounding boxes of the table’s fillable regions on the page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

columns?: Array<string> | null

Printed column headers in order, if any

label?: string | null

Printed table caption, if any

type?: "table"

Form table node

list: FormListItem { items, md, ordered, type }

Flattened list representation of the same content

items: Array<FormListTextItem { md, value, type } | FormListItem { items, md, ordered, type } >

Nested lines and sub-lists, in the form’s reading order

One of the following:
FormListTextItem { md, value, type }

One line of a form’s list representation.

md: string

Markdown representation of the line

value: string

Line content (e.g. ‘[1a] Wages: 29,513’)

type?: "text"

Text line

FormListItem = FormListItem { items, md, ordered, type }
md: string

Markdown representation of this list

ordered: boolean

Whether the list is ordered

type?: "list"

List node

page_number: number

Page number of the document

success: true

Success indicator

page_height?: number | null

Height of the page in points

page_width?: number | null

Width of the page in points

FailedFormsPage { error, page_number, success }

A page whose processing failed.

error: string

Error message describing the failure

page_number: number

Page number of the document

success: false

Failure indicator

images_content_metadata?: ImagesContentMetadata | null

Metadata for all extracted images.

images: Array<Image>

List of image metadata with presigned URLs

filename: string

Image filename (e.g., ‘image_0.png’)

index: number

Index of the image in the extraction order

bbox?: Bbox | null

Bounding box for an image on its page.

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

category?: "embedded" | "layout" | "screenshot" | null

Image category: ‘screenshot’ (full page), ‘embedded’ (images in document), or ‘layout’ (cropped from layout detection)

One of the following:
"embedded"
"layout"
"screenshot"
content_type?: string | null

MIME type of the image

presigned_url?: string | null

Presigned URL to download the image

Deprecatedsize_bytes?: number | null

Deprecated: always returns None. Will be removed in a future release.

total_count: number

Total number of extracted images

items?: Items | null

Structured JSON result (if requested)

pages: Array<StructuredResultPage { items, page_height, page_number, 3 more } | FailedStructuredPage { error, page_number, success } >

List of structured pages or failed page entries

One of the following:
StructuredResultPage { items, page_height, page_number, 3 more }

Successfully parsed page in structured items output.

items: Array<CodeItem { md, value, bbox, 2 more } | FooterItem { items, md, bbox, type } | HeaderItem { items, md, bbox, type } | 6 more>

List of structured items on the page

One of the following:
CodeItem { md, value, bbox, 2 more }
md: string

Markdown representation preserving formatting

value: string

Code content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

language?: string | null

Programming language identifier

type?: "code"

Code block item type

List of items within the footer

One of the following:
CodeItem { md, value, bbox, 2 more }
md: string

Markdown representation preserving formatting

value: string

Code content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

language?: string | null

Programming language identifier

type?: "code"

Code block item type

HeadingItem { level, md, value, 2 more }
level: number

Heading level (1-6)

md: string

Markdown representation preserving formatting

value: string

Heading text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "heading"

Heading item type

ImageItem { caption, md, url, 2 more }
caption: string

Image caption

md: string

Markdown representation preserving formatting

url: string

URL to the image

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "image"

Image item type

Markdown representation preserving formatting

Display text of the link

URL of the link

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

Link item type

ListItem { items, md, ordered, 2 more }
items: Array<TextItem { md, value, bbox, type } | ListItem { items, md, ordered, 2 more } >

List of nested text or list items

One of the following:
TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

ListItem { items, md, ordered, 2 more }
md: string

Markdown representation preserving formatting

ordered: boolean

Whether the list is ordered or unordered

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "list"

List item type

TableItem { csv, html, md, 6 more }
csv: string

CSV representation of the table

html: string

HTML representation of the table

md: string

Markdown representation preserving formatting

rows: Array<Array<string | number | null>>

Table data as array of arrays (string, number, or null)

One of the following:
string
number
bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

merged_from_pages?: Array<number> | null

List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])

merged_into_page?: number | null

Populated when merged into another table. Page number where the full merged table begins (used on empty tables).

parse_concerns?: Array<ParseConcern> | null

Quality concerns detected during table extraction, indicating the table may have issues

details: string

Human-readable details about the concern

type: string

Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)

type?: "table"

Table item type

TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

Markdown representation preserving formatting

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

Page footer container

HeaderItem { items, md, bbox, type }
items: Array<CodeItem { md, value, bbox, 2 more } | HeadingItem { level, md, value, 2 more } | ImageItem { caption, md, url, 2 more } | 4 more>

List of items within the header

One of the following:
CodeItem { md, value, bbox, 2 more }
md: string

Markdown representation preserving formatting

value: string

Code content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

language?: string | null

Programming language identifier

type?: "code"

Code block item type

HeadingItem { level, md, value, 2 more }
level: number

Heading level (1-6)

md: string

Markdown representation preserving formatting

value: string

Heading text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "heading"

Heading item type

ImageItem { caption, md, url, 2 more }
caption: string

Image caption

md: string

Markdown representation preserving formatting

url: string

URL to the image

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "image"

Image item type

Markdown representation preserving formatting

Display text of the link

URL of the link

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

Link item type

ListItem { items, md, ordered, 2 more }
items: Array<TextItem { md, value, bbox, type } | ListItem { items, md, ordered, 2 more } >

List of nested text or list items

One of the following:
TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

ListItem { items, md, ordered, 2 more }
md: string

Markdown representation preserving formatting

ordered: boolean

Whether the list is ordered or unordered

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "list"

List item type

TableItem { csv, html, md, 6 more }
csv: string

CSV representation of the table

html: string

HTML representation of the table

md: string

Markdown representation preserving formatting

rows: Array<Array<string | number | null>>

Table data as array of arrays (string, number, or null)

One of the following:
string
number
bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

merged_from_pages?: Array<number> | null

List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])

merged_into_page?: number | null

Populated when merged into another table. Page number where the full merged table begins (used on empty tables).

parse_concerns?: Array<ParseConcern> | null

Quality concerns detected during table extraction, indicating the table may have issues

details: string

Human-readable details about the concern

type: string

Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)

type?: "table"

Table item type

TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

md: string

Markdown representation preserving formatting

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "header"

Page header container

HeadingItem { level, md, value, 2 more }
level: number

Heading level (1-6)

md: string

Markdown representation preserving formatting

value: string

Heading text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "heading"

Heading item type

ImageItem { caption, md, url, 2 more }
caption: string

Image caption

md: string

Markdown representation preserving formatting

url: string

URL to the image

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "image"

Image item type

Markdown representation preserving formatting

Display text of the link

URL of the link

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

Link item type

ListItem { items, md, ordered, 2 more }
items: Array<TextItem { md, value, bbox, type } | ListItem { items, md, ordered, 2 more } >

List of nested text or list items

One of the following:
TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

ListItem { items, md, ordered, 2 more }
md: string

Markdown representation preserving formatting

ordered: boolean

Whether the list is ordered or unordered

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "list"

List item type

TableItem { csv, html, md, 6 more }
csv: string

CSV representation of the table

html: string

HTML representation of the table

md: string

Markdown representation preserving formatting

rows: Array<Array<string | number | null>>

Table data as array of arrays (string, number, or null)

One of the following:
string
number
bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

merged_from_pages?: Array<number> | null

List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])

merged_into_page?: number | null

Populated when merged into another table. Page number where the full merged table begins (used on empty tables).

parse_concerns?: Array<ParseConcern> | null

Quality concerns detected during table extraction, indicating the table may have issues

details: string

Human-readable details about the concern

type: string

Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)

type?: "table"

Table item type

TextItem { md, value, bbox, type }
md: string

Markdown representation preserving formatting

value: string

Text content

bbox?: Array<BBox { h, w, x, 6 more } > | null

List of bounding boxes

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

confidence?: number | null

Confidence score

end_index?: number | null

End index in the text

label?: string | null

Label for the bounding box

r?: number | null

Optional visual text rotation angle in degrees. Omitted when unrotated.

start_index?: number | null

Start index in the text

type?: "text"

Text item type

page_height: number

Height of the page in points

page_number: number

Page number of the document

page_width: number

Width of the page in points

success: true

Success indicator

revisions?: Array<Revision> | null

Extracted revisions and comments on the page

content: string

Revision or comment content

revision_bbox: RevisionBbox { h, w, x, y }

Bounding box of the printed revision balloon

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

target: string

Best available target text in the page content

target_bbox: TargetBbox { h, w, x, y }

Union bounding box of the target spans

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

type: "comment" | "deleted" | "formatted" | 3 more

Type of revision

One of the following:
"comment"
"deleted"
"formatted"
"inserted"
"moved_from"
"moved_to"
author?: string | null

Revision author, when available

end_index?: number | null

Exclusive end offset in final page markdown

minimum0
start_index?: number | null

Inclusive start offset in final page markdown

minimum0
target_spans?: Array<TargetSpan> | null

Disconnected target spans, when present

target: string

Text covered by this target span

target_bbox: TargetBbox { h, w, x, y }

Bounding box of this target span

h: number

Height of the bounding box

w: number

Width of the bounding box

x: number

X coordinate of the bounding box

y: number

Y coordinate of the bounding box

end_index?: number | null

Exclusive end offset in final page markdown

minimum0
start_index?: number | null

Inclusive start offset in final page markdown

minimum0
FailedStructuredPage { error, page_number, success }
error: string

Error message describing the failure

page_number: number

Page number of the document

success: false

Failure indicator

job_metadata?: Record<string, unknown> | null

Job execution metadata (if requested)

markdown?: Markdown | null

Markdown result (if requested)

pages: Array<MarkdownResultPage { markdown, page_number, success, 3 more } | FailedMarkdownPage { error, page_number, success } >

List of markdown pages or failed page entries

One of the following:
MarkdownResultPage { markdown, page_number, success, 3 more }
markdown: string

Markdown content of the page

page_number: number

Page number of the document

success: true

Success indicator

Footer of the page in markdown

header?: string | null

Header of the page in markdown

line_numbers?: Array<LineNumber> | null

Printed line numbers linked to final page markdown

end_index: number

Zero-based exclusive UTF-16 code-unit offset in final page markdown

minimum0
line_number: string

Printed source line number

start_index: number

Zero-based inclusive UTF-16 code-unit offset in final page markdown

minimum0
FailedMarkdownPage { error, page_number, success }
error: string

Error message describing the failure

page_number: number

Page number of the document

success: false

Failure indicator

markdown_full?: string | null

Full raw markdown content (if requested)

metadata?: Metadata | null

Result containing metadata (page level and general) for the parsed document.

pages: Array<Page>

List of page metadata entries

page_number: number

Page number of the document

confidence?: number | null

Confidence score for the page parsing (0-1)

cost_optimized?: boolean | null

Whether cost-optimized parsing was used for the page

original_orientation_angle?: number | null

Original orientation angle of the page in degrees

printed_page_number?: string | null

Printed page number as it appears in the document

slide_section_name?: string | null

Section name from presentation slides

speaker_notes?: string | null

Speaker notes from presentation slides

triggered_auto_mode?: boolean | null

Whether auto mode was triggered for the page

document?: Document | null

Document-level metadata information.

confidence?: number | null

Mean confidence score across pages scored by the high-effort confidence judge (0-1)

confidence_breakdown?: ConfidenceBreakdown | null

Coverage and worst-page details for document confidence.

min_page_score: number

Lowest confidence score among pages scored by the high-effort confidence judge

scored_pages: number

Number of pages successfully scored by the high-effort confidence judge

total_pages: number

Total number of pages in the parsed document

raw_parameters?: Record<string, unknown> | null
result_content_metadata?: Record<string, ResultContentMetadata> | null

Metadata including size, existence, and presigned URLs for result files

size_bytes: number

Size of the result file in bytes

exists?: boolean

Whether the result file exists in S3

presigned_url?: string | null

Presigned URL to download the result file

text?: Text | null

Plain text result (if requested)

pages: Array<Page>

List of text pages

page_number: number

Page number of the document

text: string

Plain text content of the page

text_full?: string | null

Full raw text content (if requested)

ParsingListResponse { id, project_id, status, 7 more }

A parse job.

id: string

Unique parse job identifier

project_id: string

Project this job belongs to

status: "CANCELLED" | "COMPLETED" | "FAILED" | 2 more

Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED

One of the following:
"CANCELLED"
"COMPLETED"
"FAILED"
"PENDING"
"RUNNING"
created_at?: string | null

Creation datetime

formatdate-time
error_message?: string | null

Error details when status is FAILED

name?: string | null

Optional display name for this parse job

tier?: string | null

Parsing tier used for this job

updated_at?: string | null

Update datetime

formatdate-time
usage?: Usage | null

Usage recorded against a job.

credits?: number | null

Total credits billed against this job. Null until billing has recorded it.

user_metadata?: Record<string, string> | null

Key/value tags associated with this job.

ParsingCancelResponse { id, project_id, status, 7 more }

A parse job.

id: string

Unique parse job identifier

project_id: string

Project this job belongs to

status: "CANCELLED" | "COMPLETED" | "FAILED" | 2 more

Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED

One of the following:
"CANCELLED"
"COMPLETED"
"FAILED"
"PENDING"
"RUNNING"
created_at?: string | null

Creation datetime

formatdate-time
error_message?: string | null

Error details when status is FAILED

name?: string | null

Optional display name for this parse job

tier?: string | null

Parsing tier used for this job

updated_at?: string | null

Update datetime

formatdate-time
usage?: Usage | null

Usage recorded against a job.

credits?: number | null

Total credits billed against this job. Null until billing has recorded it.

user_metadata?: Record<string, string> | null

Key/value tags associated with this job.

ParsingDeleteResponse { id, project_id }

Confirmation that a parse job was deleted.

A deleted job can no longer be fetched, so the response echoes back what it was rather than pointing at it. Returning the identifiers instead of an empty body lets a caller assert on the delete it just made without a follow-up request.

id: string

Identifier of the deleted parse job

project_id: string

Project the deleted job belonged to

ParsingListVersionsResponse { agentic, agentic_plus, cost_effective, 2 more }

Versions accepted by the parse API, grouped by tier.

agentic: Array<"2026-09-09" | "2026-09-07" | "2026-08-19" | 42 more>

Versions for the agentic tier

One of the following:
"2026-09-09"
"2026-09-07"
"2026-08-19"
"2026-07-24"
"2026-07-23"
"2026-07-15"
"2026-06-18"
"2026-06-11"
"2026-06-04"
"2026-06-01"
"2026-05-26"
"2026-05-21"
"2026-05-20"
"2026-05-19"
"2026-05-13"
"2026-05-11"
"2026-05-06"
"2026-05-04"
"2026-04-27"
"2026-04-22"
"2026-04-09"
"2026-04-06"
"2026-04-02"
"2026-03-31"
"2026-03-30"
"2026-03-27"
"2026-03-25"
"2026-03-23"
"2026-03-22"
"2026-03-20"
"2026-03-11"
"2026-03-10"
"2026-03-09"
"2026-03-03"
"2026-03-02"
"2026-02-26"
"2026-02-24"
"2026-01-30"
"2026-01-22"
"2026-01-21"
"2026-01-16"
"2026-01-08"
"2025-12-31"
"2025-12-18"
"2025-12-11"
agentic_plus: Array<"2026-08-19" | "2026-07-08" | "2026-06-18" | 37 more>

Versions for the agentic_plus tier

One of the following:
"2026-08-19"
"2026-07-08"
"2026-06-18"
"2026-06-11"
"2026-06-04"
"2026-06-01"
"2026-05-26"
"2026-05-21"
"2026-05-20"
"2026-05-19"
"2026-05-11"
"2026-05-06"
"2026-05-04"
"2026-05-01"
"2026-04-27"
"2026-04-19"
"2026-04-14"
"2026-04-09"
"2026-04-02"
"2026-03-31"
"2026-03-26"
"2026-03-25"
"2026-03-22"
"2026-03-20"
"2026-03-17"
"2026-03-12"
"2026-03-10"
"2026-03-09"
"2026-03-02"
"2026-02-26"
"2026-02-24"
"2026-01-30"
"2026-01-29"
"2026-01-24"
"2026-01-22"
"2026-01-21"
"2026-01-16"
"2025-12-31"
"2025-12-18"
"2025-12-11"
cost_effective: Array<"2026-08-19" | "2026-08-11" | "2026-08-08" | 12 more>

Versions for the cost_effective tier

One of the following:
"2026-08-19"
"2026-08-11"
"2026-08-08"
"2026-07-23"
"2026-06-26"
"2026-06-18"
"2026-06-17"
"2026-06-11"
"2026-06-08"
"2026-06-05"
"2026-05-28"
"2026-04-09"
"2026-03-31"
"2026-03-27"
"2026-03-25"
fast: Array<"2026-06-15" | "2025-12-11">

Versions for the fast tier

One of the following:
"2026-06-15"
"2025-12-11"
latest: Latest { agentic, agentic_plus, cost_effective, fast }

Version latest currently resolves to, per tier

agentic: string

Version latest resolves to for the agentic tier

agentic_plus: string

Version latest resolves to for the agentic_plus tier

cost_effective: string

Version latest resolves to for the cost_effective tier

fast: string

Version latest resolves to for the fast tier

Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/for-agents/mcp/ - Other LlamaIndex tooling for agents — the LlamaParse Platform MCP server, agent skills and plugins, and the n8n node — is mapped at https://developers.llamaindex.ai/for-agents/