Parsing

Parse File

ParsingCreateResponse parsing().create(, )

POST/api/v2/parse

Get Parse Job

ParsingGetResponse parsing().get(, )

GET/api/v2/parse/{job_id}

List Parse Jobs

ParsingListPage parsing().list(, )

GET/api/v2/parse

ModelsExpand Collapse

class BBox:

Bounding box with coordinates and optional metadata.

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

class CodeItem:

String md

Markdown representation preserving formatting

String value

Code content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<String> language

Programming language identifier

Optional<Type> type

Code block item type

enum FailPageMode:

Enum for representing the different available page error handling modes.

RAW_TEXT("raw_text")

BLANK_PAGE("blank_page")

ERROR_MESSAGE("error_message")

class FooterItem:

List<Item> items

List of items within the footer

One of the following:

class TextItem:

String md

Markdown representation preserving formatting

String value

Text content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Text item type

class HeadingItem:

long level

Heading level (1-6)

String md

Markdown representation preserving formatting

String value

Heading text content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Heading item type

class ListItem:

List<Item> items

List of nested text or list items

One of the following:

class TextItem:

String md

Markdown representation preserving formatting

String value

Text content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Text item type

ListItem

String md

Markdown representation preserving formatting

boolean ordered

Whether the list is ordered or unordered

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

List item type

class CodeItem:

String md

Markdown representation preserving formatting

String value

Code content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<String> language

Programming language identifier

Optional<Type> type

Code block item type

class TableItem:

String csv

CSV representation of the table

String html

HTML representation of the table

String md

Markdown representation preserving formatting

List<List<Row>> rows

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

One of the following:

String

double

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<List<Long>> mergedFromPages

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

Optional<Long> mergedIntoPage

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

Optional<List<ParseConcern>> parseConcerns

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

String details

Human-readable details about the concern

String type

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

Optional<Type> type

Table item type

class ImageItem:

String caption

Image caption

String md

Markdown representation preserving formatting

String url

URL to the image

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Image item type

class LinkItem:

String md

Markdown representation preserving formatting

String text

Display text of the link

String url

URL of the link

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Link item type

String md

Markdown representation preserving formatting

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Page footer container

class HeaderItem:

List<Item> items

List of items within the header

One of the following:

class TextItem:

String md

Markdown representation preserving formatting

String value

Text content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Text item type

class HeadingItem:

long level

Heading level (1-6)

String md

Markdown representation preserving formatting

String value

Heading text content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Heading item type

class ListItem:

List<Item> items

List of nested text or list items

One of the following:

class TextItem:

String md

Markdown representation preserving formatting

String value

Text content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Text item type

ListItem

String md

Markdown representation preserving formatting

boolean ordered

Whether the list is ordered or unordered

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

List item type

class CodeItem:

String md

Markdown representation preserving formatting

String value

Code content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<String> language

Programming language identifier

Optional<Type> type

Code block item type

class TableItem:

String csv

CSV representation of the table

String html

HTML representation of the table

String md

Markdown representation preserving formatting

List<List<Row>> rows

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

One of the following:

String

double

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<List<Long>> mergedFromPages

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

Optional<Long> mergedIntoPage

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

Optional<List<ParseConcern>> parseConcerns

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

String details

Human-readable details about the concern

String type

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

Optional<Type> type

Table item type

class ImageItem:

String caption

Image caption

String md

Markdown representation preserving formatting

String url

URL to the image

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Image item type

class LinkItem:

String md

Markdown representation preserving formatting

String text

Display text of the link

String url

URL of the link

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Link item type

String md

Markdown representation preserving formatting

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Page header container

class HeadingItem:

long level

Heading level (1-6)

String md

Markdown representation preserving formatting

String value

Heading text content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Heading item type

class ImageItem:

String caption

Image caption

String md

Markdown representation preserving formatting

String url

URL to the image

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Image item type

class LinkItem:

String md

Markdown representation preserving formatting

String text

Display text of the link

String url

URL of the link

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Link item type

class ListItem:

List<Item> items

List of nested text or list items

One of the following:

class TextItem:

String md

Markdown representation preserving formatting

String value

Text content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Text item type

ListItem

String md

Markdown representation preserving formatting

boolean ordered

Whether the list is ordered or unordered

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

List item type

enum LlamaParseSupportedFileExtensions:

Enum for supported file extensions.

PDF(".pdf")

ABW(".abw")

AWT(".awt")

CGM(".cgm")

CWK(".cwk")

DOC(".doc")

DOCM(".docm")

DOCX(".docx")

DOT(".dot")

DOTM(".dotm")

DOTX(".dotx")

FODG(".fodg")

FODP(".fodp")

FOPD(".fopd")

FODT(".fodt")

FB2(".fb2")

HWP(".hwp")

LWP(".lwp")

MCW(".mcw")

MW(".mw")

MWD(".mwd")

ODF(".odf")

ODT(".odt")

OTG(".otg")

OTT(".ott")

PAGES(".pages")

PBD(".pbd")

PSW(".psw")

RTF(".rtf")

SDA(".sda")

SDD(".sdd")

SDP(".sdp")

SDW(".sdw")

SGL(".sgl")

STD(".std")

STW(".stw")

SXD(".sxd")

SXG(".sxg")

SXM(".sxm")

SXW(".sxw")

UOF(".uof")

UOP(".uop")

UOT(".uot")

VOR(".vor")

WPD(".wpd")

WPS(".wps")

WPT(".wpt")

WRI(".wri")

WN(".wn")

XML(".xml")

ZABW(".zabw")

KEY(".key")

ODP(".odp")

ODG(".odg")

OTP(".otp")

POT(".pot")

POTM(".potm")

POTX(".potx")

PPT(".ppt")

PPTM(".pptm")

PPTX(".pptx")

STI(".sti")

SXI(".sxi")

VSD(".vsd")

VSDM(".vsdm")

VSDX(".vsdx")

VDX(".vdx")

BMP(".bmp")

GIF(".gif")

HEIC(".heic")

HEIF(".heif")

JPG(".jpg")

JPEG(".jpeg")

PNG(".png")

SVG(".svg")

TIF(".tif")

TIFF(".tiff")

WEBP(".webp")

HTM(".htm")

HTML(".html")

XHTM(".xhtm")

CSV(".csv")

DBF(".dbf")

DIF(".dif")

ET(".et")

ETH(".eth")

FODS(".fods")

NUMBERS(".numbers")

ODS(".ods")

OTS(".ots")

PRN(".prn")

QPW(".qpw")

SLK(".slk")

STC(".stc")

SXC(".sxc")

SYLK(".sylk")

TSV(".tsv")

UOS1(".uos1")

UOS2(".uos2")

UOS(".uos")

WB1(".wb1")

WB2(".wb2")

WB3(".wb3")

WK1(".wk1")

WK2(".wk2")

WK3(".wk3")

WK4(".wk4")

WKS(".wks")

WQ1(".wq1")

WQ2(".wq2")

XLR(".xlr")

XLS(".xls")

XLSB(".xlsb")

XLSM(".xlsm")

XLSX(".xlsx")

XLW(".xlw")

AZW(".azw")

AZW3(".azw3")

AZW4(".azw4")

CB7(".cb7")

CBC(".cbc")

CBR(".cbr")

CBZ(".cbz")

CHM(".chm")

DJVU(".djvu")

EPUB(".epub")

FBZ(".fbz")

HTMLZ(".htmlz")

LIT(".lit")

LRF(".lrf")

MD(".md")

MOBI(".mobi")

PDB(".pdb")

PML(".pml")

PRC(".prc")

RB(".rb")

SNB(".snb")

TCR(".tcr")

TXTZ(".txtz")

M4A(".m4a")

MP3(".mp3")

MP4(".mp4")

MPEG(".mpeg")

MPGA(".mpga")

WAV(".wav")

WEBM(".webm")

YXMD(".yxmd")

class ParsingJob:

A parse job (v1).

String id

Unique parse job identifier

StatusEnum status

Current job status

One of the following:

PENDING("PENDING")

SUCCESS("SUCCESS")

ERROR("ERROR")

PARTIAL_SUCCESS("PARTIAL_SUCCESS")

CANCELLED("CANCELLED")

Optional<String> errorCode

Machine-readable error code when failed

Optional<String> errorMessage

Human-readable error details when failed

enum ParsingLanguages:

Enum for representing the languages supported by the parser.

AF("af")

AZ("az")

BS("bs")

CS("cs")

CY("cy")

DA("da")

DE("de")

EN("en")

ES("es")

ET("et")

FR("fr")

GA("ga")

HR("hr")

HU("hu")

ID("id")

IS("is")

IT("it")

KU("ku")

LA("la")

LT("lt")

LV("lv")

MI("mi")

MS("ms")

MT("mt")

NL("nl")

NO("no")

OC("oc")

PI("pi")

PL("pl")

PT("pt")

RO("ro")

RS_LATIN("rs_latin")

SK("sk")

SL("sl")

SQ("sq")

SV("sv")

SW("sw")

TL("tl")

TR("tr")

UZ("uz")

VI("vi")

AR("ar")

FA("fa")

UG("ug")

UR("ur")

BN("bn")

AS("as")

MNI("mni")

RU("ru")

RS_CYRILLIC("rs_cyrillic")

BE("be")

BG("bg")

UK("uk")

MN("mn")

ABQ("abq")

ADY("ady")

KBD("kbd")

AVA("ava")

DAR("dar")

INH("inh")

CHE("che")

LBE("lbe")

LEZ("lez")

TAB("tab")

TJK("tjk")

HI("hi")

MR("mr")

NE("ne")

BH("bh")

MAI("mai")

ANG("ang")

BHO("bho")

MAH("mah")

SCK("sck")

NEW("new")

GOM("gom")

SA("sa")

BGC("bgc")

TH("th")

CH_SIM("ch_sim")

CH_TRA("ch_tra")

JA("ja")

KO("ko")

TA("ta")

TE("te")

KN("kn")

enum ParsingMode:

Enum for representing the mode of parsing to be used.

PARSE_PAGE_WITHOUT_LLM("parse_page_without_llm")

PARSE_PAGE_WITH_LLM("parse_page_with_llm")

PARSE_PAGE_WITH_LVM("parse_page_with_lvm")

PARSE_PAGE_WITH_AGENT("parse_page_with_agent")

PARSE_PAGE_WITH_LAYOUT_AGENT("parse_page_with_layout_agent")

PARSE_DOCUMENT_WITH_LLM("parse_document_with_llm")

PARSE_DOCUMENT_WITH_LVM("parse_document_with_lvm")

PARSE_DOCUMENT_WITH_AGENT("parse_document_with_agent")

enum StatusEnum:

Enum for representing the status of a job

PENDING("PENDING")

SUCCESS("SUCCESS")

ERROR("ERROR")

PARTIAL_SUCCESS("PARTIAL_SUCCESS")

CANCELLED("CANCELLED")

class TableItem:

String csv

CSV representation of the table

String html

HTML representation of the table

String md

Markdown representation preserving formatting

List<List<Row>> rows

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

One of the following:

String

double

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<List<Long>> mergedFromPages

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

Optional<Long> mergedIntoPage

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

Optional<List<ParseConcern>> parseConcerns

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

String details

Human-readable details about the concern

String type

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

Optional<Type> type

Table item type

class TextItem:

String md

Markdown representation preserving formatting

String value

Text content

Optional<List<BBox>> bbox

List of bounding boxes

double h

Height of the bounding box

double w

Width of the bounding box

double x

X coordinate of the bounding box

double y

Y coordinate of the bounding box

Optional<Double> confidence

Confidence score

Optional<Long> endIndex

End index in the text

Optional<String> label

Label for the bounding box

Optional<Double> r

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

Optional<Long> startIndex

Start index in the text

Optional<Type> type

Text item type