Skip to content
Developer Documentation
API Reference
Parsing

Get Parse Job

ParsingGetResponse Parsing.Get(ParsingGetParamsparameters, CancellationTokencancellationToken = default)
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
ParsingGetParams parameters
required string jobID
IReadOnlyList<string> expand

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.

string? imageFilenames

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

string? organizationID
string? projectID
ReturnsExpand Collapse
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.

required Job Job

Parse job status and metadata

required string ID

Unique parse job identifier

required string ProjectID

Project this job belongs to

required Status Status

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

One of the following:
"CANCELLED"Cancelled
"COMPLETED"Completed
"FAILED"Failed
"PENDING"Pending
"RUNNING"Running
DateTimeOffset? CreatedAt

Creation datetime

formatdate-time
string? ErrorMessage

Error details when status is FAILED

string? Name

Optional display name for this parse job

string? Tier

Parsing tier used for this job

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time
IReadOnlyDictionary<string, string>? UserMetadata

Key/value tags associated with this job.

Forms? Forms

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

required IReadOnlyList<Page> Pages

List of form pages or failed page entries

One of the following:
class FormsResultPage:

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

required IReadOnlyList<Form> Forms

Forms detected on the page

required IReadOnlyList<Json> Json

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

One of the following:
class FormField:

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

required Field Field

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

One of the following:
"checkbox"Checkbox
"multi_select"MultiSelect
"signature"Signature
"single_select"SingleSelect
"text"Text
string? ID

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

Boolean? IsEmpty

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

string? Label

Printed field caption, if any

Type Type

Form field node

Value? Value

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

One of the following:
string
Boolean
IReadOnlyList<ValueItem>? ValueItems

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

One of the following:
FormField
class FormSection:

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

string? ID

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

string? Label

Printed section heading, if any

Type Type

Form section node

class FormTable:

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

string? ID

Identifier printed on the form, if any

IReadOnlyList<string>? Columns

Printed column headers in order, if any

string? Label

Printed table caption, if any

Type Type

Form table node

class FormSection:

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

string? ID

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

string? Label

Printed section heading, if any

Type Type

Form section node

class FormTable:

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

string? ID

Identifier printed on the form, if any

IReadOnlyList<string>? Columns

Printed column headers in order, if any

string? Label

Printed table caption, if any

Type Type

Form table node

required FormListItem List

Flattened list representation of the same content

required IReadOnlyList<Item> Items

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

One of the following:
class FormListTextItem:

One line of a form’s list representation.

required string Md

Markdown representation of the line

required string Value

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

Type Type

Text line

FormListItem
required string Md

Markdown representation of this list

required Boolean Ordered

Whether the list is ordered

Type Type

List node

required Long PageNumber

Page number of the document

JsonElement Success trueconstant

Success indicator

class FailedFormsPage:

A page whose processing failed.

required string Error

Error message describing the failure

required Long PageNumber

Page number of the document

JsonElement Success falseconstant

Failure indicator

ImagesContentMetadata? ImagesContentMetadata

Metadata for all extracted images.

required IReadOnlyList<Image> Images

List of image metadata with presigned URLs

required string Filename

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

required Long Index

Index of the image in the extraction order

Bbox? Bbox

Bounding box for an image on its page.

required Long H

Height of the bounding box

required Long W

Width of the bounding box

required Long X

X coordinate of the bounding box

required Long Y

Y coordinate of the bounding box

Category? Category

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

One of the following:
"embedded"Embedded
"layout"Layout
"screenshot"Screenshot
string? ContentType

MIME type of the image

string? PresignedUrl

Presigned URL to download the image

DeprecatedLong? SizeBytes

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

required Long TotalCount

Total number of extracted images

Items? Items

Structured JSON result (if requested)

required IReadOnlyList<Page> Pages

List of structured pages or failed page entries

One of the following:
class StructuredResultPage:
required IReadOnlyList<Item> Items

List of structured items on the page

One of the following:
class CodeItem:
required string Md

Markdown representation preserving formatting

required string Value

Code content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

string? Language

Programming language identifier

Type Type

Code block item type

List of items within the footer

One of the following:
class CodeItem:
required string Md

Markdown representation preserving formatting

required string Value

Code content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

string? Language

Programming language identifier

Type Type

Code block item type

class HeadingItem:
required Long Level

Heading level (1-6)

required string Md

Markdown representation preserving formatting

required string Value

Heading text content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Heading item type

class ImageItem:
required string Caption

Image caption

required string Md

Markdown representation preserving formatting

required string Url

URL to the image

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Image item type

Markdown representation preserving formatting

required string Text

Display text of the link

URL of the link

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Link item type

class ListItem:
required IReadOnlyList<Item> Items

List of nested text or list items

One of the following:
class TextItem:
required string Md

Markdown representation preserving formatting

required string Value

Text content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Text item type

ListItem
required string Md

Markdown representation preserving formatting

required Boolean Ordered

Whether the list is ordered or unordered

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

List item type

class TableItem:
required string Csv

CSV representation of the table

required string Html

HTML representation of the table

required string Md

Markdown representation preserving formatting

required IReadOnlyList<IReadOnlyList<Row?>> Rows

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

One of the following:
string
Double
IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

IReadOnlyList<Long>? MergedFromPages

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

Long? MergedIntoPage

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

IReadOnlyList<ParseConcern>? ParseConcerns

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

required string Details

Human-readable details about the concern

required string Type

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

Type Type

Table item type

class TextItem:
required string Md

Markdown representation preserving formatting

required string Value

Text content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Text item type

Markdown representation preserving formatting

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Page footer container

class HeaderItem:
required IReadOnlyList<Item> Items

List of items within the header

One of the following:
class CodeItem:
required string Md

Markdown representation preserving formatting

required string Value

Code content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

string? Language

Programming language identifier

Type Type

Code block item type

class HeadingItem:
required Long Level

Heading level (1-6)

required string Md

Markdown representation preserving formatting

required string Value

Heading text content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Heading item type

class ImageItem:
required string Caption

Image caption

required string Md

Markdown representation preserving formatting

required string Url

URL to the image

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Image item type

Markdown representation preserving formatting

required string Text

Display text of the link

URL of the link

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Link item type

class ListItem:
required IReadOnlyList<Item> Items

List of nested text or list items

One of the following:
class TextItem:
required string Md

Markdown representation preserving formatting

required string Value

Text content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Text item type

ListItem
required string Md

Markdown representation preserving formatting

required Boolean Ordered

Whether the list is ordered or unordered

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

List item type

class TableItem:
required string Csv

CSV representation of the table

required string Html

HTML representation of the table

required string Md

Markdown representation preserving formatting

required IReadOnlyList<IReadOnlyList<Row?>> Rows

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

One of the following:
string
Double
IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

IReadOnlyList<Long>? MergedFromPages

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

Long? MergedIntoPage

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

IReadOnlyList<ParseConcern>? ParseConcerns

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

required string Details

Human-readable details about the concern

required string Type

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

Type Type

Table item type

class TextItem:
required string Md

Markdown representation preserving formatting

required string Value

Text content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Text item type

required string Md

Markdown representation preserving formatting

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Page header container

class HeadingItem:
required Long Level

Heading level (1-6)

required string Md

Markdown representation preserving formatting

required string Value

Heading text content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Heading item type

class ImageItem:
required string Caption

Image caption

required string Md

Markdown representation preserving formatting

required string Url

URL to the image

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Image item type

Markdown representation preserving formatting

required string Text

Display text of the link

URL of the link

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Link item type

class ListItem:
required IReadOnlyList<Item> Items

List of nested text or list items

One of the following:
class TextItem:
required string Md

Markdown representation preserving formatting

required string Value

Text content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Text item type

ListItem
required string Md

Markdown representation preserving formatting

required Boolean Ordered

Whether the list is ordered or unordered

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

List item type

class TableItem:
required string Csv

CSV representation of the table

required string Html

HTML representation of the table

required string Md

Markdown representation preserving formatting

required IReadOnlyList<IReadOnlyList<Row?>> Rows

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

One of the following:
string
Double
IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

IReadOnlyList<Long>? MergedFromPages

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

Long? MergedIntoPage

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

IReadOnlyList<ParseConcern>? ParseConcerns

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

required string Details

Human-readable details about the concern

required string Type

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

Type Type

Table item type

class TextItem:
required string Md

Markdown representation preserving formatting

required string Value

Text content

IReadOnlyList<BBox>? Bbox

List of bounding boxes

required Double H

Height of the bounding box

required Double W

Width of the bounding box

required Double X

X coordinate of the bounding box

required Double Y

Y coordinate of the bounding box

Double? Confidence

Confidence score

Long? EndIndex

End index in the text

string? Label

Label for the bounding box

Double? R

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

Long? StartIndex

Start index in the text

Type Type

Text item type

required Double PageHeight

Height of the page in points

required Long PageNumber

Page number of the document

required Double PageWidth

Width of the page in points

JsonElement Success trueconstant

Success indicator

class FailedStructuredPage:
required string Error

Error message describing the failure

required Long PageNumber

Page number of the document

JsonElement Success falseconstant

Failure indicator

IReadOnlyDictionary<string, JsonElement>? JobMetadata

Job execution metadata (if requested)

Markdown? Markdown

Markdown result (if requested)

required IReadOnlyList<Page> Pages

List of markdown pages or failed page entries

One of the following:
class MarkdownResultPage:
required string Markdown

Markdown content of the page

required Long PageNumber

Page number of the document

JsonElement Success trueconstant

Success indicator

Footer of the page in markdown

string? Header

Header of the page in markdown

class FailedMarkdownPage:
required string Error

Error message describing the failure

required Long PageNumber

Page number of the document

JsonElement Success falseconstant

Failure indicator

string? MarkdownFull

Full raw markdown content (if requested)

Metadata? Metadata

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

required IReadOnlyList<Page> Pages

List of page metadata entries

required Long PageNumber

Page number of the document

Double? Confidence

Confidence score for the page parsing (0-1)

Boolean? CostOptimized

Whether cost-optimized parsing was used for the page

Long? OriginalOrientationAngle

Original orientation angle of the page in degrees

string? PrintedPageNumber

Printed page number as it appears in the document

string? SlideSectionName

Section name from presentation slides

string? SpeakerNotes

Speaker notes from presentation slides

Boolean? TriggeredAutoMode

Whether auto mode was triggered for the page

IReadOnlyDictionary<string, JsonElement>? RawParameters
IReadOnlyDictionary<string, ResultContentMetadataItem>? ResultContentMetadata

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

required Long SizeBytes

Size of the result file in bytes

Boolean Exists

Whether the result file exists in S3

string? PresignedUrl

Presigned URL to download the result file

Text? Text

Plain text result (if requested)

required IReadOnlyList<Page> Pages

List of text pages

required Long PageNumber

Page number of the document

required string Text

Plain text content of the page

string? TextFull

Full raw text content (if requested)

Get Parse Job

ParsingGetParams parameters = new() { JobID = "job_id" };

var parsing = await client.Parsing.Get(parameters);

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