API Reference

Parsing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Parse Job

client.Parsing.Get(ctx, jobID, query) (*ParsingGetResponse, error)

GET/api/v2/parse/{job_id}

Retrieve a parse job with optional expanded content.

By default returns job metadata only. Use expand to include parsed content:

• text — plain text output
• markdown — markdown output
• items — structured page-by-page output
• job_metadata — usage and processing details

Content metadata fields (e.g. text_content_metadata) return presigned URLs for downloading large results.

ParametersExpand Collapse

jobID string

query ParsingGetParams

Expand param.Field[[]string]Optional

Fields to include: text, markdown, items, metadata, forms, job_metadata, text_content_metadata, markdown_content_metadata, items_content_metadata, metadata_content_metadata, forms_content_metadata, raw_words_content_metadata, xlsx_content_metadata, output_pdf_content_metadata, images_content_metadata. Metadata fields include presigned URLs.

ImageFilenames param.Field[string]Optional

Filter to specific image filenames (optional). Example: image_0.png,image_1.jpg

OrganizationID param.Field[string]Optional

ProjectID param.Field[string]Optional

ReturnsExpand Collapse

type ParsingGetResponse struct{…}

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 ParsingGetResponseJob

Parse job status and metadata

ID string

Unique parse job identifier

ProjectID string

Project this job belongs to

Status string

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

One of the following:

const ParsingGetResponseJobStatusCancelled ParsingGetResponseJobStatus = "CANCELLED"

const ParsingGetResponseJobStatusCompleted ParsingGetResponseJobStatus = "COMPLETED"

const ParsingGetResponseJobStatusFailed ParsingGetResponseJobStatus = "FAILED"

const ParsingGetResponseJobStatusPending ParsingGetResponseJobStatus = "PENDING"

const ParsingGetResponseJobStatusRunning ParsingGetResponseJobStatus = "RUNNING"

CreatedAt TimeOptional

Creation datetime

formatdate-time

ErrorMessage stringOptional

Error details when status is FAILED

Name stringOptional

Optional display name for this parse job

Tier stringOptional

Parsing tier used for this job

UpdatedAt TimeOptional

Update datetime

formatdate-time

UserMetadata map[string, string]Optional

Key/value tags associated with this job.

Forms ParsingGetResponseFormsOptional

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

Pages []ParsingGetResponseFormsPageUnion

List of form pages or failed page entries

One of the following:

type ParsingGetResponseFormsPageFormsResultPage struct{…}

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

Forms []Form

Forms detected on the page

Json []FormJsonUnion

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

One of the following:

type FormField struct{…}

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

Field FormFieldField

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

One of the following:

const FormFieldFieldCheckbox FormFieldField = "checkbox"

const FormFieldFieldMultiSelect FormFieldField = "multi_select"

const FormFieldFieldSignature FormFieldField = "signature"

const FormFieldFieldSingleSelect FormFieldField = "single_select"

const FormFieldFieldText FormFieldField = "text"

ID stringOptional

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

IsEmpty boolOptional

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

Label stringOptional

Printed field caption, if any

Type FormFieldTypeOptional

Form field node

Value FormFieldValueUnionOptional

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

bool

ValueItems []FormFieldValueItemUnionOptional

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

One of the following:

type FormField FormField

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

type FormSection struct{…}

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

ID stringOptional

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

Label stringOptional

Printed section heading, if any

Type FormSectionTypeOptional

Form section node

type FormTable struct{…}

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

ID stringOptional

Identifier printed on the form, if any

Columns []stringOptional

Printed column headers in order, if any

Label stringOptional

Printed table caption, if any

Type FormTableTypeOptional

Form table node

type FormSection struct{…}

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

ID stringOptional

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

Label stringOptional

Printed section heading, if any

Type FormSectionTypeOptional

Form section node

type FormTable struct{…}

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

ID stringOptional

Identifier printed on the form, if any

Columns []stringOptional

Printed column headers in order, if any

Label stringOptional

Printed table caption, if any

Type FormTableTypeOptional

Form table node

List FormListItem

Flattened list representation of the same content

Items []FormListItemItemUnion

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

One of the following:

type FormListTextItem struct{…}

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 FormListTextItemTypeOptional

Text line

type FormListItem FormListItem

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

Md string

Markdown representation of this list

Ordered bool

Whether the list is ordered

Type FormListItemTypeOptional

List node

PageNumber int64

Page number of the document

Success bool

Success indicator

type ParsingGetResponseFormsPageFailedFormsPage struct{…}

A page whose processing failed.

Error string

Error message describing the failure

PageNumber int64

Page number of the document

Success bool

Failure indicator

ImagesContentMetadata ParsingGetResponseImagesContentMetadataOptional

Metadata for all extracted images.

Images []ParsingGetResponseImagesContentMetadataImage

List of image metadata with presigned URLs

Filename string

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

Index int64

Index of the image in the extraction order

Bbox ParsingGetResponseImagesContentMetadataImageBboxOptional

Bounding box for an image on its page.

H int64

Height of the bounding box

W int64

Width of the bounding box

X int64

X coordinate of the bounding box

Y int64

Y coordinate of the bounding box

Category stringOptional

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

One of the following:

const ParsingGetResponseImagesContentMetadataImageCategoryEmbedded ParsingGetResponseImagesContentMetadataImageCategory = "embedded"

const ParsingGetResponseImagesContentMetadataImageCategoryLayout ParsingGetResponseImagesContentMetadataImageCategory = "layout"

const ParsingGetResponseImagesContentMetadataImageCategoryScreenshot ParsingGetResponseImagesContentMetadataImageCategory = "screenshot"

ContentType stringOptional

MIME type of the image

PresignedURL stringOptional

Presigned URL to download the image

DeprecatedSizeBytes int64Optional

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

TotalCount int64

Total number of extracted images

Items ParsingGetResponseItemsOptional

Structured JSON result (if requested)

Pages []ParsingGetResponseItemsPageUnion

List of structured pages or failed page entries

One of the following:

type ParsingGetResponseItemsPageStructuredResultPage struct{…}

Items []ParsingGetResponseItemsPageStructuredResultPageItemUnion

List of structured items on the page

One of the following:

type CodeItem struct{…}

Md string

Markdown representation preserving formatting

Value string

Code content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Language stringOptional

Programming language identifier

Type CodeItemTypeOptional

Code block item type

type FooterItem struct{…}

Items []FooterItemItemUnion

List of items within the footer

One of the following:

type CodeItem struct{…}

Md string

Markdown representation preserving formatting

Value string

Code content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Language stringOptional

Programming language identifier

Type CodeItemTypeOptional

Code block item type

type HeadingItem struct{…}

Level int64

Heading level (1-6)

Md string

Markdown representation preserving formatting

Value string

Heading text content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type HeadingItemTypeOptional

Heading item type

type ImageItem struct{…}

Caption string

Image caption

Md string

Markdown representation preserving formatting

URL string

URL to the image

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type ImageItemTypeOptional

Image item type

type LinkItem struct{…}

Md string

Markdown representation preserving formatting

Text string

Display text of the link

URL string

URL of the link

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type LinkItemTypeOptional

Link item type

type ListItem struct{…}

Items []ListItemItemUnion

List of nested text or list items

One of the following:

type TextItem struct{…}

Md string

Markdown representation preserving formatting

Value string

Text content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type TextItemTypeOptional

Text item type

type ListItem ListItem

Md string

Markdown representation preserving formatting

Ordered bool

Whether the list is ordered or unordered

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type ListItemTypeOptional

List item type

type TableItem struct{…}

Csv string

CSV representation of the table

HTML string

HTML representation of the table

Md string

Markdown representation preserving formatting

Rows [][]*TableItemRowUnion

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

One of the following:

string

float64

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

MergedFromPages []int64Optional

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

MergedIntoPage int64Optional

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

ParseConcerns []TableItemParseConcernOptional

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 TableItemTypeOptional

Table item type

type TextItem struct{…}

Md string

Markdown representation preserving formatting

Value string

Text content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type TextItemTypeOptional

Text item type

Md string

Markdown representation preserving formatting

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type FooterItemTypeOptional

Page footer container

type HeaderItem struct{…}

Items []HeaderItemItemUnion

List of items within the header

One of the following:

type CodeItem struct{…}

Md string

Markdown representation preserving formatting

Value string

Code content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Language stringOptional

Programming language identifier

Type CodeItemTypeOptional

Code block item type

type HeadingItem struct{…}

Level int64

Heading level (1-6)

Md string

Markdown representation preserving formatting

Value string

Heading text content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type HeadingItemTypeOptional

Heading item type

type ImageItem struct{…}

Caption string

Image caption

Md string

Markdown representation preserving formatting

URL string

URL to the image

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type ImageItemTypeOptional

Image item type

type LinkItem struct{…}

Md string

Markdown representation preserving formatting

Text string

Display text of the link

URL string

URL of the link

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type LinkItemTypeOptional

Link item type

type ListItem struct{…}

Items []ListItemItemUnion

List of nested text or list items

One of the following:

type TextItem struct{…}

Md string

Markdown representation preserving formatting

Value string

Text content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type TextItemTypeOptional

Text item type

type ListItem ListItem

Md string

Markdown representation preserving formatting

Ordered bool

Whether the list is ordered or unordered

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type ListItemTypeOptional

List item type

type TableItem struct{…}

Csv string

CSV representation of the table

HTML string

HTML representation of the table

Md string

Markdown representation preserving formatting

Rows [][]*TableItemRowUnion

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

One of the following:

string

float64

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

MergedFromPages []int64Optional

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

MergedIntoPage int64Optional

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

ParseConcerns []TableItemParseConcernOptional

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 TableItemTypeOptional

Table item type

type TextItem struct{…}

Md string

Markdown representation preserving formatting

Value string

Text content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type TextItemTypeOptional

Text item type

Md string

Markdown representation preserving formatting

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type HeaderItemTypeOptional

Page header container

type HeadingItem struct{…}

Level int64

Heading level (1-6)

Md string

Markdown representation preserving formatting

Value string

Heading text content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type HeadingItemTypeOptional

Heading item type

type ImageItem struct{…}

Caption string

Image caption

Md string

Markdown representation preserving formatting

URL string

URL to the image

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type ImageItemTypeOptional

Image item type

type LinkItem struct{…}

Md string

Markdown representation preserving formatting

Text string

Display text of the link

URL string

URL of the link

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type LinkItemTypeOptional

Link item type

type ListItem struct{…}

Items []ListItemItemUnion

List of nested text or list items

One of the following:

type TextItem struct{…}

Md string

Markdown representation preserving formatting

Value string

Text content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type TextItemTypeOptional

Text item type

type ListItem ListItem

Md string

Markdown representation preserving formatting

Ordered bool

Whether the list is ordered or unordered

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type ListItemTypeOptional

List item type

type TableItem struct{…}

Csv string

CSV representation of the table

HTML string

HTML representation of the table

Md string

Markdown representation preserving formatting

Rows [][]*TableItemRowUnion

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

One of the following:

string

float64

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

MergedFromPages []int64Optional

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

MergedIntoPage int64Optional

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

ParseConcerns []TableItemParseConcernOptional

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 TableItemTypeOptional

Table item type

type TextItem struct{…}

Md string

Markdown representation preserving formatting

Value string

Text content

Bbox []BBoxOptional

List of bounding boxes

H float64

Height of the bounding box

W float64

Width of the bounding box

X float64

X coordinate of the bounding box

Y float64

Y coordinate of the bounding box

Confidence float64Optional

Confidence score

EndIndex int64Optional

End index in the text

Label stringOptional

Label for the bounding box

R float64Optional

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

StartIndex int64Optional

Start index in the text

Type TextItemTypeOptional

Text item type

PageHeight float64

Height of the page in points

PageNumber int64

Page number of the document

PageWidth float64

Width of the page in points

Success bool

Success indicator

type ParsingGetResponseItemsPageFailedStructuredPage struct{…}

Error string

Error message describing the failure

PageNumber int64

Page number of the document

Success bool

Failure indicator

JobMetadata map[string, any]Optional

Job execution metadata (if requested)

Markdown ParsingGetResponseMarkdownOptional

Markdown result (if requested)

Pages []ParsingGetResponseMarkdownPageUnion

List of markdown pages or failed page entries

One of the following:

type ParsingGetResponseMarkdownPageMarkdownResultPage struct{…}

Markdown string

Markdown content of the page

PageNumber int64

Page number of the document

Success bool

Success indicator

Footer stringOptional

Footer of the page in markdown

Header stringOptional

Header of the page in markdown

type ParsingGetResponseMarkdownPageFailedMarkdownPage struct{…}

Error string

Error message describing the failure

PageNumber int64

Page number of the document

Success bool

Failure indicator

MarkdownFull stringOptional

Full raw markdown content (if requested)

Metadata ParsingGetResponseMetadataOptional

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

Pages []ParsingGetResponseMetadataPage

List of page metadata entries

PageNumber int64

Page number of the document

Confidence float64Optional

Confidence score for the page parsing (0-1)

CostOptimized boolOptional

Whether cost-optimized parsing was used for the page

OriginalOrientationAngle int64Optional

Original orientation angle of the page in degrees

PrintedPageNumber stringOptional

Printed page number as it appears in the document

SlideSectionName stringOptional

Section name from presentation slides

SpeakerNotes stringOptional

Speaker notes from presentation slides

TriggeredAutoMode boolOptional

Whether auto mode was triggered for the page

RawParameters map[string, any]Optional

ResultContentMetadata map[string, ParsingGetResponseResultContentMetadata]Optional

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

SizeBytes int64

Size of the result file in bytes

Exists boolOptional

Whether the result file exists in S3

PresignedURL stringOptional

Presigned URL to download the result file

Text ParsingGetResponseTextOptional

Plain text result (if requested)

Pages []ParsingGetResponseTextPage

List of text pages

PageNumber int64

Page number of the document

Text string

Plain text content of the page

TextFull stringOptional

Full raw text content (if requested)

Get Parse Job

Go

HTTP

TypeScript

Python

Go

Java

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloud.NewClient(
    option.WithAPIKey("My API Key"),
  )
  parsing, err := client.Parsing.Get(
    context.TODO(),
    "job_id",
    llamacloud.ParsingGetParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", parsing.Job)
}

200 example

{
  "job": {
    "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "status": "CANCELLED",
    "created_at": "2019-12-27T18:11:19.117Z",
    "error_message": "error_message",
    "name": "Q4 Financial Report",
    "tier": "fast",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "user_metadata": {
      "owner": "jerry",
      "team": "research"
    }
  },
  "forms": {
    "pages": [
      {
        "forms": [
          {
            "json": [
              {
                "field": "checkbox",
                "id": "id",
                "isEmpty": true,
                "label": "label",
                "type": "field",
                "value": "string",
                "valueItems": [
                  {
                    "items": [
                      {
                        "rows": [
                          [
                            "string"
                          ]
                        ],
                        "id": "id",
                        "columns": [
                          "string"
                        ],
                        "label": "label",
                        "type": "table"
                      }
                    ],
                    "id": "id",
                    "label": "label",
                    "type": "section"
                  }
                ]
              }
            ],
            "list": {
              "items": [
                {
                  "md": "md",
                  "value": "value",
                  "type": "text"
                }
              ],
              "md": "md",
              "ordered": true,
              "type": "list"
            }
          }
        ],
        "page_number": 0,
        "success": true
      }
    ]
  },
  "images_content_metadata": {
    "images": [
      {
        "filename": "filename",
        "index": 0,
        "bbox": {
          "h": 0,
          "w": 0,
          "x": 0,
          "y": 0
        },
        "category": "embedded",
        "content_type": "content_type",
        "presigned_url": "presigned_url",
        "size_bytes": 0
      }
    ],
    "total_count": 0
  },
  "items": {
    "pages": [
      {
        "items": [
          {
            "md": "md",
            "value": "value",
            "bbox": [
              {
                "h": 0,
                "w": 0,
                "x": 0,
                "y": 0,
                "confidence": 0,
                "end_index": 0,
                "label": "label",
                "r": 0,
                "start_index": 0
              }
            ],
            "language": "language",
            "type": "code"
          }
        ],
        "page_height": 0,
        "page_number": 0,
        "page_width": 0,
        "success": true
      }
    ]
  },
  "job_metadata": {
    "foo": "bar"
  },
  "markdown": {
    "pages": [
      {
        "markdown": "markdown",
        "page_number": 0,
        "success": true,
        "footer": "footer",
        "header": "header"
      }
    ]
  },
  "markdown_full": "markdown_full",
  "metadata": {
    "pages": [
      {
        "page_number": 0,
        "confidence": 0,
        "cost_optimized": true,
        "original_orientation_angle": 0,
        "printed_page_number": "printed_page_number",
        "slide_section_name": "slide_section_name",
        "speaker_notes": "speaker_notes",
        "triggered_auto_mode": true
      }
    ]
  },
  "raw_parameters": {
    "foo": "bar"
  },
  "result_content_metadata": {
    "foo": {
      "size_bytes": 0,
      "exists": true,
      "presigned_url": "presigned_url"
    }
  },
  "text": {
    "pages": [
      {
        "page_number": 0,
        "text": "text"
      }
    ]
  },
  "text_full": "text_full"
}

Returns Examples

200 example

{
  "job": {
    "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "status": "CANCELLED",
    "created_at": "2019-12-27T18:11:19.117Z",
    "error_message": "error_message",
    "name": "Q4 Financial Report",
    "tier": "fast",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "user_metadata": {
      "owner": "jerry",
      "team": "research"
    }
  },
  "forms": {
    "pages": [
      {
        "forms": [
          {
            "json": [
              {
                "field": "checkbox",
                "id": "id",
                "isEmpty": true,
                "label": "label",
                "type": "field",
                "value": "string",
                "valueItems": [
                  {
                    "items": [
                      {
                        "rows": [
                          [
                            "string"
                          ]
                        ],
                        "id": "id",
                        "columns": [
                          "string"
                        ],
                        "label": "label",
                        "type": "table"
                      }
                    ],
                    "id": "id",
                    "label": "label",
                    "type": "section"
                  }
                ]
              }
            ],
            "list": {
              "items": [
                {
                  "md": "md",
                  "value": "value",
                  "type": "text"
                }
              ],
              "md": "md",
              "ordered": true,
              "type": "list"
            }
          }
        ],
        "page_number": 0,
        "success": true
      }
    ]
  },
  "images_content_metadata": {
    "images": [
      {
        "filename": "filename",
        "index": 0,
        "bbox": {
          "h": 0,
          "w": 0,
          "x": 0,
          "y": 0
        },
        "category": "embedded",
        "content_type": "content_type",
        "presigned_url": "presigned_url",
        "size_bytes": 0
      }
    ],
    "total_count": 0
  },
  "items": {
    "pages": [
      {
        "items": [
          {
            "md": "md",
            "value": "value",
            "bbox": [
              {
                "h": 0,
                "w": 0,
                "x": 0,
                "y": 0,
                "confidence": 0,
                "end_index": 0,
                "label": "label",
                "r": 0,
                "start_index": 0
              }
            ],
            "language": "language",
            "type": "code"
          }
        ],
        "page_height": 0,
        "page_number": 0,
        "page_width": 0,
        "success": true
      }
    ]
  },
  "job_metadata": {
    "foo": "bar"
  },
  "markdown": {
    "pages": [
      {
        "markdown": "markdown",
        "page_number": 0,
        "success": true,
        "footer": "footer",
        "header": "header"
      }
    ]
  },
  "markdown_full": "markdown_full",
  "metadata": {
    "pages": [
      {
        "page_number": 0,
        "confidence": 0,
        "cost_optimized": true,
        "original_orientation_angle": 0,
        "printed_page_number": "printed_page_number",
        "slide_section_name": "slide_section_name",
        "speaker_notes": "speaker_notes",
        "triggered_auto_mode": true
      }
    ]
  },
  "raw_parameters": {
    "foo": "bar"
  },
  "result_content_metadata": {
    "foo": {
      "size_bytes": 0,
      "exists": true,
      "presigned_url": "presigned_url"
    }
  },
  "text": {
    "pages": [
      {
        "page_number": 0,
        "text": "text"
      }
    ]
  },
  "text_full": "text_full"
}