Skip to content
Developer Documentation
API Reference

Parsing

Parse File
parsing.create(ParsingCreateParams**kwargs) -> ParsingCreateResponse
POST/api/v2/parse
Get Parse Job
parsing.get(strjob_id, ParsingGetParams**kwargs) -> ParsingGetResponse
GET/api/v2/parse/{job_id}
List Parse Jobs
parsing.list(ParsingListParams**kwargs) -> SyncPaginatedCursor[ParsingListResponse]
GET/api/v2/parse
ModelsExpand Collapse
class BBox: …

Bounding box with coordinates and optional metadata.

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

class CodeItem: …
md: str

Markdown representation preserving formatting

value: str

Code content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

language: Optional[str]

Programming language identifier

type: Optional[Literal["code"]]

Code block item type

Literal["raw_text", "blank_page", "error_message"]

Enum for representing the different available page error handling modes.

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

List of items within the footer

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

class HeadingItem: …
level: int

Heading level (1-6)

md: str

Markdown representation preserving formatting

value: str

Heading text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["heading"]]

Heading item type

class ListItem: …
items: List[Item]

List of nested text or list items

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

md: str

Markdown representation preserving formatting

ordered: bool

Whether the list is ordered or unordered

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["list"]]

List item type

class CodeItem: …
md: str

Markdown representation preserving formatting

value: str

Code content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

language: Optional[str]

Programming language identifier

type: Optional[Literal["code"]]

Code block item type

class TableItem: …
csv: str

CSV representation of the table

html: str

HTML representation of the table

md: str

Markdown representation preserving formatting

rows: List[List[Union[str, float, null]]]

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

One of the following:
str
float
bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

merged_from_pages: Optional[List[int]]

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

merged_into_page: Optional[int]

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

parse_concerns: Optional[List[ParseConcern]]

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

details: str

Human-readable details about the concern

type: str

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

type: Optional[Literal["table"]]

Table item type

class ImageItem: …
caption: str

Image caption

md: str

Markdown representation preserving formatting

url: str

URL to the image

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["image"]]

Image item type

Markdown representation preserving formatting

text: str

Display text of the link

URL of the link

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

Link item type

Markdown representation preserving formatting

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

Page footer container

class HeaderItem: …
items: List[Item]

List of items within the header

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

class HeadingItem: …
level: int

Heading level (1-6)

md: str

Markdown representation preserving formatting

value: str

Heading text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["heading"]]

Heading item type

class ListItem: …
items: List[Item]

List of nested text or list items

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

md: str

Markdown representation preserving formatting

ordered: bool

Whether the list is ordered or unordered

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["list"]]

List item type

class CodeItem: …
md: str

Markdown representation preserving formatting

value: str

Code content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

language: Optional[str]

Programming language identifier

type: Optional[Literal["code"]]

Code block item type

class TableItem: …
csv: str

CSV representation of the table

html: str

HTML representation of the table

md: str

Markdown representation preserving formatting

rows: List[List[Union[str, float, null]]]

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

One of the following:
str
float
bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

merged_from_pages: Optional[List[int]]

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

merged_into_page: Optional[int]

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

parse_concerns: Optional[List[ParseConcern]]

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

details: str

Human-readable details about the concern

type: str

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

type: Optional[Literal["table"]]

Table item type

class ImageItem: …
caption: str

Image caption

md: str

Markdown representation preserving formatting

url: str

URL to the image

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["image"]]

Image item type

Markdown representation preserving formatting

text: str

Display text of the link

URL of the link

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

Link item type

md: str

Markdown representation preserving formatting

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["header"]]

Page header container

class HeadingItem: …
level: int

Heading level (1-6)

md: str

Markdown representation preserving formatting

value: str

Heading text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["heading"]]

Heading item type

class ImageItem: …
caption: str

Image caption

md: str

Markdown representation preserving formatting

url: str

URL to the image

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["image"]]

Image item type

Markdown representation preserving formatting

text: str

Display text of the link

URL of the link

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

Link item type

class ListItem: …
items: List[Item]

List of nested text or list items

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

md: str

Markdown representation preserving formatting

ordered: bool

Whether the list is ordered or unordered

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["list"]]

List item type

Literal[".pdf", ".abw", ".awt", 144 more]

Enum for supported file extensions.

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

A parse job (v1).

id: str

Unique parse job identifier

status: StatusEnum

Current job status

One of the following:
"PENDING"
"SUCCESS"
"ERROR"
"PARTIAL_SUCCESS"
"CANCELLED"
error_code: Optional[str]

Machine-readable error code when failed

error_message: Optional[str]

Human-readable error details when failed

Literal["af", "az", "bs", 83 more]

Enum for representing the languages supported by the parser.

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

Enum for representing the mode of parsing to be used.

One of the following:
"parse_page_without_llm"
"parse_page_with_llm"
"parse_page_with_lvm"
"parse_page_with_agent"
"parse_page_with_layout_agent"
"parse_document_with_llm"
"parse_document_with_lvm"
"parse_document_with_agent"
Literal["PENDING", "SUCCESS", "ERROR", 2 more]

Enum for representing the status of a job

One of the following:
"PENDING"
"SUCCESS"
"ERROR"
"PARTIAL_SUCCESS"
"CANCELLED"
class TableItem: …
csv: str

CSV representation of the table

html: str

HTML representation of the table

md: str

Markdown representation preserving formatting

rows: List[List[Union[str, float, null]]]

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

One of the following:
str
float
bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

merged_from_pages: Optional[List[int]]

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

merged_into_page: Optional[int]

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

parse_concerns: Optional[List[ParseConcern]]

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

details: str

Human-readable details about the concern

type: str

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

type: Optional[Literal["table"]]

Table item type

class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

class ParsingCreateResponse: …

A parse job.

id: str

Unique parse job identifier

project_id: str

Project this job belongs to

status: Literal["PENDING", "RUNNING", "COMPLETED", 2 more]

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

One of the following:
"PENDING"
"RUNNING"
"COMPLETED"
"FAILED"
"CANCELLED"
created_at: Optional[datetime]

Creation datetime

formatdate-time
error_message: Optional[str]

Error details when status is FAILED

name: Optional[str]

Optional display name for this parse job

tier: Optional[str]

Parsing tier used for this job

updated_at: Optional[datetime]

Update datetime

formatdate-time
user_metadata: Optional[Dict[str, str]]

Key/value tags associated with this job.

class ParsingGetResponse: …

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

Parse job status and metadata

id: str

Unique parse job identifier

project_id: str

Project this job belongs to

status: Literal["PENDING", "RUNNING", "COMPLETED", 2 more]

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

One of the following:
"PENDING"
"RUNNING"
"COMPLETED"
"FAILED"
"CANCELLED"
created_at: Optional[datetime]

Creation datetime

formatdate-time
error_message: Optional[str]

Error details when status is FAILED

name: Optional[str]

Optional display name for this parse job

tier: Optional[str]

Parsing tier used for this job

updated_at: Optional[datetime]

Update datetime

formatdate-time
user_metadata: Optional[Dict[str, str]]

Key/value tags associated with this job.

images_content_metadata: Optional[ImagesContentMetadata]

Metadata for all extracted images.

images: List[ImagesContentMetadataImage]

List of image metadata with presigned URLs

filename: str

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

index: int

Index of the image in the extraction order

bbox: Optional[ImagesContentMetadataImageBbox]

Bounding box for an image on its page.

h: int

Height of the bounding box

w: int

Width of the bounding box

x: int

X coordinate of the bounding box

y: int

Y coordinate of the bounding box

category: Optional[Literal["screenshot", "embedded", "layout"]]

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

One of the following:
"screenshot"
"embedded"
"layout"
content_type: Optional[str]

MIME type of the image

presigned_url: Optional[str]

Presigned URL to download the image

Deprecatedsize_bytes: Optional[int]

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

total_count: int

Total number of extracted images

items: Optional[Items]

Structured JSON result (if requested)

pages: List[ItemsPage]

List of structured pages or failed page entries

One of the following:
class ItemsPageStructuredResultPage: …
items: List[ItemsPageStructuredResultPageItem]

List of structured items on the page

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

class HeadingItem: …
level: int

Heading level (1-6)

md: str

Markdown representation preserving formatting

value: str

Heading text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["heading"]]

Heading item type

class ListItem: …
items: List[Item]

List of nested text or list items

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

md: str

Markdown representation preserving formatting

ordered: bool

Whether the list is ordered or unordered

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["list"]]

List item type

class CodeItem: …
md: str

Markdown representation preserving formatting

value: str

Code content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

language: Optional[str]

Programming language identifier

type: Optional[Literal["code"]]

Code block item type

class TableItem: …
csv: str

CSV representation of the table

html: str

HTML representation of the table

md: str

Markdown representation preserving formatting

rows: List[List[Union[str, float, null]]]

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

One of the following:
str
float
bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

merged_from_pages: Optional[List[int]]

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

merged_into_page: Optional[int]

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

parse_concerns: Optional[List[ParseConcern]]

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

details: str

Human-readable details about the concern

type: str

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

type: Optional[Literal["table"]]

Table item type

class ImageItem: …
caption: str

Image caption

md: str

Markdown representation preserving formatting

url: str

URL to the image

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["image"]]

Image item type

Markdown representation preserving formatting

text: str

Display text of the link

URL of the link

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

Link item type

class HeaderItem: …
items: List[Item]

List of items within the header

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

class HeadingItem: …
level: int

Heading level (1-6)

md: str

Markdown representation preserving formatting

value: str

Heading text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["heading"]]

Heading item type

class ListItem: …
items: List[Item]

List of nested text or list items

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

md: str

Markdown representation preserving formatting

ordered: bool

Whether the list is ordered or unordered

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["list"]]

List item type

class CodeItem: …
md: str

Markdown representation preserving formatting

value: str

Code content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

language: Optional[str]

Programming language identifier

type: Optional[Literal["code"]]

Code block item type

class TableItem: …
csv: str

CSV representation of the table

html: str

HTML representation of the table

md: str

Markdown representation preserving formatting

rows: List[List[Union[str, float, null]]]

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

One of the following:
str
float
bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

merged_from_pages: Optional[List[int]]

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

merged_into_page: Optional[int]

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

parse_concerns: Optional[List[ParseConcern]]

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

details: str

Human-readable details about the concern

type: str

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

type: Optional[Literal["table"]]

Table item type

class ImageItem: …
caption: str

Image caption

md: str

Markdown representation preserving formatting

url: str

URL to the image

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["image"]]

Image item type

Markdown representation preserving formatting

text: str

Display text of the link

URL of the link

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

Link item type

md: str

Markdown representation preserving formatting

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["header"]]

Page header container

List of items within the footer

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

class HeadingItem: …
level: int

Heading level (1-6)

md: str

Markdown representation preserving formatting

value: str

Heading text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["heading"]]

Heading item type

class ListItem: …
items: List[Item]

List of nested text or list items

One of the following:
class TextItem: …
md: str

Markdown representation preserving formatting

value: str

Text content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["text"]]

Text item type

md: str

Markdown representation preserving formatting

ordered: bool

Whether the list is ordered or unordered

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["list"]]

List item type

class CodeItem: …
md: str

Markdown representation preserving formatting

value: str

Code content

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

language: Optional[str]

Programming language identifier

type: Optional[Literal["code"]]

Code block item type

class TableItem: …
csv: str

CSV representation of the table

html: str

HTML representation of the table

md: str

Markdown representation preserving formatting

rows: List[List[Union[str, float, null]]]

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

One of the following:
str
float
bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

merged_from_pages: Optional[List[int]]

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

merged_into_page: Optional[int]

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

parse_concerns: Optional[List[ParseConcern]]

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

details: str

Human-readable details about the concern

type: str

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

type: Optional[Literal["table"]]

Table item type

class ImageItem: …
caption: str

Image caption

md: str

Markdown representation preserving formatting

url: str

URL to the image

bbox: Optional[List[BBox]]

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

type: Optional[Literal["image"]]

Image item type

Markdown representation preserving formatting

text: str

Display text of the link

URL of the link

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

Link item type

Markdown representation preserving formatting

List of bounding boxes

h: float

Height of the bounding box

w: float

Width of the bounding box

x: float

X coordinate of the bounding box

y: float

Y coordinate of the bounding box

confidence: Optional[float]

Confidence score

end_index: Optional[int]

End index in the text

label: Optional[str]

Label for the bounding box

r: Optional[float]

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

start_index: Optional[int]

Start index in the text

Page footer container

page_height: float

Height of the page in points

page_number: int

Page number of the document

page_width: float

Width of the page in points

success: Literal[true]

Success indicator

class ItemsPageFailedStructuredPage: …
error: str

Error message describing the failure

page_number: int

Page number of the document

success: Literal[false]

Failure indicator

job_metadata: Optional[Dict[str, object]]

Job execution metadata (if requested)

markdown: Optional[Markdown]

Markdown result (if requested)

pages: List[MarkdownPage]

List of markdown pages or failed page entries

One of the following:
class MarkdownPageMarkdownResultPage: …
markdown: str

Markdown content of the page

page_number: int

Page number of the document

success: Literal[true]

Success indicator

Footer of the page in markdown

header: Optional[str]

Header of the page in markdown

class MarkdownPageFailedMarkdownPage: …
error: str

Error message describing the failure

page_number: int

Page number of the document

success: Literal[false]

Failure indicator

markdown_full: Optional[str]

Full raw markdown content (if requested)

metadata: Optional[Metadata]

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

pages: List[MetadataPage]

List of page metadata entries

page_number: int

Page number of the document

confidence: Optional[float]

Confidence score for the page parsing (0-1)

cost_optimized: Optional[bool]

Whether cost-optimized parsing was used for the page

original_orientation_angle: Optional[int]

Original orientation angle of the page in degrees

printed_page_number: Optional[str]

Printed page number as it appears in the document

slide_section_name: Optional[str]

Section name from presentation slides

speaker_notes: Optional[str]

Speaker notes from presentation slides

triggered_auto_mode: Optional[bool]

Whether auto mode was triggered for the page

raw_parameters: Optional[Dict[str, object]]
result_content_metadata: Optional[Dict[str, ResultContentMetadata]]

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

size_bytes: int

Size of the result file in bytes

exists: Optional[bool]

Whether the result file exists in S3

presigned_url: Optional[str]

Presigned URL to download the result file

text: Optional[Text]

Plain text result (if requested)

pages: List[TextPage]

List of text pages

page_number: int

Page number of the document

text: str

Plain text content of the page

text_full: Optional[str]

Full raw text content (if requested)

class ParsingListResponse: …

A parse job.

id: str

Unique parse job identifier

project_id: str

Project this job belongs to

status: Literal["PENDING", "RUNNING", "COMPLETED", 2 more]

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

One of the following:
"PENDING"
"RUNNING"
"COMPLETED"
"FAILED"
"CANCELLED"
created_at: Optional[datetime]

Creation datetime

formatdate-time
error_message: Optional[str]

Error details when status is FAILED

name: Optional[str]

Optional display name for this parse job

tier: Optional[str]

Parsing tier used for this job

updated_at: Optional[datetime]

Update datetime

formatdate-time
user_metadata: Optional[Dict[str, str]]

Key/value tags associated with this job.

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/python/shared/mcp/