> ## Documentation Index > Fetch the complete documentation index at: https://docs.runpulse.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Parse Result > Get a completed parse's Markdown, elements and requested outputs, with the pages and credits it used. Anyone in your organization can read it. If your organization's retention deletes a result the first time it's read, save the response, because a later read returns `410`. ## OpenAPI ````yaml /api-reference/v2/openapi.yml get /parse/{parse_id}/result openapi: 3.1.0 info: title: Pulse API description: >- Agentic document infrastructure for the enterprise. The Pulse API turns complex documents into AI-ready data, such as Markdown, structured JSON and bounding boxes. version: '2' servers: - url: https://api.runpulse.com description: Default Pulse API base URL security: [] tags: - name: Parse description: Parse a document's text, tables and figures. - name: Batch parse description: Parse many documents with one config. - name: Extract description: Extract structured data from a parsed document. - name: Split description: Find each topic's pages in a parsed document. - name: Tables description: Merge a parsed document's tables across pages. - name: Charts description: Read the charts in a parsed document. - name: Classify description: Sort a document into the categories you define. - name: Pipeline description: Run a parse and its follow-on steps as one job. - name: Usage description: Check the pages and credits your organization has used. - name: Webhook description: Get notified when your organization's jobs change status. - name: Organization settings description: Read and change your organization's name, address and default API version. paths: /parse/{parse_id}/result: get: tags: - Parse summary: Get Parse Result description: >- Get a completed parse's Markdown, elements and requested outputs, with the pages and credits it used. Anyone in your organization can read it. If your organization's retention deletes a result the first time it's read, save the response, because a later read returns `410`. operationId: getParseResult parameters: - name: parse_id in: path required: true schema: type: string description: The `parse_id` that `POST /parse` returned. title: Parse Id description: The `parse_id` that `POST /parse` returned. - name: Pulse-Version in: header required: false schema: type: string default: '2' title: Pulse-Version examples: default: value: '2' responses: '200': description: The parse's result. content: application/json: schema: $ref: '#/components/schemas/ParseResult' '400': description: >- [`REQUEST_INVALID`](https://docs.runpulse.com/errors/request-invalid): a query parameter this route doesn't take. The parse failed, and this is its error ([`REQUEST_INVALID`](https://docs.runpulse.com/errors/request-invalid), [`PAGE_RANGE_INVALID`](https://docs.runpulse.com/errors/page-range-invalid), [`FILE_URL_INVALID`](https://docs.runpulse.com/errors/file-url-invalid)). `Pulse-Version` names a version this API doesn't serve ([`UNSUPPORTED_VERSION`](https://docs.runpulse.com/errors/unsupported-version)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - REQUEST_INVALID - PAGE_RANGE_INVALID - FILE_URL_INVALID - UNSUPPORTED_VERSION '401': description: >- [`CREDENTIALS_INVALID`](https://docs.runpulse.com/errors/credentials-invalid): the API key is missing or not valid. [`API_KEY_INACTIVE`](https://docs.runpulse.com/errors/api-key-inactive): the API key is inactive; create a new one. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - CREDENTIALS_INVALID - API_KEY_INACTIVE '402': description: >- The parse failed, and this is its error ([`TRIAL_EXPIRED`](https://docs.runpulse.com/errors/trial-expired), [`CREDIT_LIMIT_EXCEEDED`](https://docs.runpulse.com/errors/credit-limit-exceeded), [`PAYMENT_REQUIRED`](https://docs.runpulse.com/errors/payment-required), [`PLAN_LIMIT_REACHED`](https://docs.runpulse.com/errors/plan-limit-reached), [`PLAN_UPGRADE_REQUIRED`](https://docs.runpulse.com/errors/plan-upgrade-required), [`PAYMENT_FAILED`](https://docs.runpulse.com/errors/payment-failed), [`PAYMENT_AUTHENTICATION_REQUIRED`](https://docs.runpulse.com/errors/payment-authentication-required), [`SUBSCRIPTION_CANCELED`](https://docs.runpulse.com/errors/subscription-canceled), [`SUBSCRIPTION_PAST_DUE`](https://docs.runpulse.com/errors/subscription-past-due)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - TRIAL_EXPIRED - CREDIT_LIMIT_EXCEEDED - PAYMENT_REQUIRED - PLAN_LIMIT_REACHED - PLAN_UPGRADE_REQUIRED - PAYMENT_FAILED - PAYMENT_AUTHENTICATION_REQUIRED - SUBSCRIPTION_CANCELED - SUBSCRIPTION_PAST_DUE '403': description: >- [`ACCOUNT_SUSPENDED`](https://docs.runpulse.com/errors/account-suspended): your account is suspended. The parse failed, and this is its error ([`PERMISSION_DENIED`](https://docs.runpulse.com/errors/permission-denied)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - ACCOUNT_SUSPENDED - PERMISSION_DENIED '404': description: >- [`RESOURCE_NOT_FOUND`](https://docs.runpulse.com/errors/resource-not-found): your organization has no parse with this id. The parse failed, and this is its error ([`RESOURCE_NOT_FOUND`](https://docs.runpulse.com/errors/resource-not-found)). No endpoint answers this path ([`ROUTE_NOT_FOUND`](https://docs.runpulse.com/errors/route-not-found)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - RESOURCE_NOT_FOUND - ROUTE_NOT_FOUND '409': description: >- [`JOB_NOT_FINISHED`](https://docs.runpulse.com/errors/job-not-finished): the parse is still `queued` or `processing`; poll `GET /parse/{parse_id}` until it is `completed`. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - JOB_NOT_FINISHED '410': description: >- [`RESULT_EXPIRED`](https://docs.runpulse.com/errors/result-expired): the result expired under your retention. [`JOB_CANCELED`](https://docs.runpulse.com/errors/job-canceled): the job was canceled. [`RESULT_ALREADY_FETCHED`](https://docs.runpulse.com/errors/result-already-fetched): your organization's retention deletes a result on its first read, and this one was read. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - RESULT_EXPIRED - JOB_CANCELED - RESULT_ALREADY_FETCHED '413': description: >- The parse failed, and this is its error ([`FIELD_TOO_LARGE`](https://docs.runpulse.com/errors/field-too-large), [`FILE_TOO_LARGE`](https://docs.runpulse.com/errors/file-too-large)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - FIELD_TOO_LARGE - FILE_TOO_LARGE '415': description: >- The parse failed, and this is its error ([`FILE_TYPE_UNSUPPORTED`](https://docs.runpulse.com/errors/file-type-unsupported)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - FILE_TYPE_UNSUPPORTED '422': description: >- The parse failed, and this is its error ([`FILE_CORRUPT`](https://docs.runpulse.com/errors/file-corrupt), [`DOCUMENT_UNPROCESSABLE`](https://docs.runpulse.com/errors/document-unprocessable), [`FILE_EMPTY`](https://docs.runpulse.com/errors/file-empty), [`FILE_DOWNLOAD_FAILED`](https://docs.runpulse.com/errors/file-download-failed), [`FILE_UNSAFE`](https://docs.runpulse.com/errors/file-unsafe)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - FILE_CORRUPT - DOCUMENT_UNPROCESSABLE - FILE_EMPTY - FILE_DOWNLOAD_FAILED - FILE_UNSAFE '500': description: >- [`SERVER_ERROR`](https://docs.runpulse.com/errors/server-error): an unexpected error. [`JOB_UNREADABLE`](https://docs.runpulse.com/errors/job-unreadable): Pulse can't read this job right now; don't retry, contact support. The parse failed, and this is its error ([`PROCESSING_FAILED`](https://docs.runpulse.com/errors/processing-failed), [`SERVER_ERROR`](https://docs.runpulse.com/errors/server-error)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - SERVER_ERROR - JOB_UNREADABLE - PROCESSING_FAILED '503': description: >- [`SERVICE_UNAVAILABLE`](https://docs.runpulse.com/errors/service-unavailable): the parse or its result couldn't be read; retry. A parse that failed with [`SERVICE_UNAVAILABLE`](https://docs.runpulse.com/errors/service-unavailable) answers it on every read: run it again. The parse failed, and this is its error ([`SERVICE_UNAVAILABLE`](https://docs.runpulse.com/errors/service-unavailable)). On a self-hosted install that hasn't been activated yet, [`LICENSE_NOT_ACTIVATED`](https://docs.runpulse.com/errors/license-not-activated). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string Retry-After: description: Seconds to wait before retrying. schema: type: string x-pulse-errors: - SERVICE_UNAVAILABLE - LICENSE_NOT_ACTIVATED '504': description: >- The parse failed, and this is its error ([`FILE_DOWNLOAD_TIMEOUT`](https://docs.runpulse.com/errors/file-download-timeout)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - FILE_DOWNLOAD_TIMEOUT security: - ApiKey: [] components: schemas: ParseResult: properties: markdown: type: string title: Markdown description: >- The document's content as Markdown, in reading order, with tables as HTML. elements: items: oneOf: - $ref: '#/components/schemas/BaseElement' - $ref: '#/components/schemas/TableElement' - $ref: '#/components/schemas/FigureElement' discriminator: propertyName: category mapping: Caption: '#/components/schemas/BaseElement' Figure: '#/components/schemas/FigureElement' Footnote: '#/components/schemas/BaseElement' Formula: '#/components/schemas/BaseElement' List-item: '#/components/schemas/BaseElement' Page-footer: '#/components/schemas/BaseElement' Page-header: '#/components/schemas/BaseElement' Page-number: '#/components/schemas/BaseElement' Section-header: '#/components/schemas/BaseElement' Table: '#/components/schemas/TableElement' Text: '#/components/schemas/BaseElement' Title: '#/components/schemas/BaseElement' Word: '#/components/schemas/BaseElement' type: array title: Elements description: >- The document's text, tables and figures in reading order, each with its page and its position on that page. parse_id: type: string title: Parse Id description: The parse's id, `parse-`. platform_url: type: string title: Platform Url description: >- A link to the parse on your Pulse dashboard. Absent when the result isn't saved. failed_pages: items: type: integer type: array title: Failed Pages description: >- The pages that couldn't be parsed, each marked in `markdown` with an HTML comment. When every page was parsed, a long document's result lists `[]`; any other leaves it out. pages_succeeded: type: integer minimum: 0 title: Pages Succeeded description: 'On a long document: how many of its pages were parsed (and billed).' pages_failed: type: integer minimum: 0 title: Pages Failed description: >- On a long document: how many of its pages couldn't be parsed, the length of `failed_pages`; 0 when every page was. extensions: $ref: '#/components/schemas/ResultExtensions' description: The extra outputs `config.extensions` asked for. usage: $ref: '#/components/schemas/Usage' description: The pages and credits this request used. warnings: items: $ref: '#/components/schemas/Warning' type: array title: Warnings description: Issues that may affect this result. Absent when there are none. expires_at: type: string title: Expires At description: >- When the result will be deleted. Absent when the result is kept with no expiry. history: $ref: '#/components/schemas/ResultHistory' additionalProperties: false type: object required: - markdown - elements - parse_id - usage - history title: ParseResult description: A completed parse's result. Problem: additionalProperties: false description: >- Why the request or the job failed. Branch on `code`; quote `request_id` to support. properties: type: description: 'This code''s page: what it means and what to do.' title: Type type: string title: description: A short summary of the code, the same for every occurrence. title: Title type: string status: description: The HTTP status the code answers with. title: Status type: integer detail: description: What happened this time. title: Detail type: string instance: description: 'This occurrence: the request''s URN, `urn:pulse:request:`.' title: Instance type: string code: description: The stable error code, e.g. `REQUEST_INVALID`. Branch on it. title: Code type: string request_id: description: >- The request that failed, as `X-Request-Id` named it; for a failed job, the request that created it. Quote it to support. title: Request Id type: string retryable: description: Whether the same request may succeed if sent again. title: Retryable type: boolean retry_after: description: Seconds to wait before retrying, as `Retry-After` says. title: Retry After type: integer errors: description: Each refused part of the request. items: $ref: '#/components/schemas/FieldIssue' title: Errors type: array resource: description: 'What wasn''t found: `job`, `batch`, `webhook`, `config`, …' title: Resource type: string reason: description: The cause within the code. title: Reason type: string parse_id: description: The parse the request recorded. title: Parse Id type: string extract_id: description: The extraction it recorded. title: Extract Id type: string split_id: description: The split it recorded. title: Split Id type: string classify_id: description: The classification it recorded. title: Classify Id type: string tables_id: description: The tables job it recorded. title: Tables Id type: string charts_id: description: The charts job it recorded. title: Charts Id type: string pipeline_id: description: The pipeline it recorded. title: Pipeline Id type: string batch_id: description: The batch it recorded. title: Batch Id type: string filename: description: The file refused. title: Filename type: string declared_type: description: The type its name declared. title: Declared Type type: string detected: description: The type its contents are. title: Detected type: string supported_types: description: The types accepted. items: type: string title: Supported Types type: array supported: description: The values accepted. items: type: string title: Supported type: array max_size_mb: anyOf: - type: integer - type: number description: The largest size accepted. title: Max Size Mb file_size_mb: anyOf: - type: integer - type: number description: The file's size. title: File Size Mb plan_name: description: Your organization's plan. title: Plan Name type: string pages_used: anyOf: - type: integer - type: number description: Pages used this period. title: Pages Used page_allowance: anyOf: - type: integer - type: number description: Pages the plan allows. title: Page Allowance upgrade_url: description: Where to change your plan. title: Upgrade Url type: string action_required: description: What to do to continue. title: Action Required type: string billing_info: additionalProperties: $ref: '#/components/schemas/JsonValue' description: Your organization's billing state, as the gate read it. title: Billing Info type: object required: - type - title - status - code - retryable title: Problem type: object BaseElement: properties: id: type: string title: Id description: >- The element's id, in the form `{category}-{n}`, such as `Text-12`. `n` counts from 0 in reading order, and words are numbered separately. A cell's id adds its row and column, such as `Table-3-r0c2`. category: type: string enum: - Word - Title - Section-header - Text - List-item - Caption - Footnote - Formula - Page-header - Page-footer - Page-number title: Category description: >- What the element is, such as `Title`, `Text` or `Page-footer`. `Word` elements appear only in `extensions.word_level_bounding_boxes`. confidence: anyOf: - type: number - type: 'null' title: Confidence description: >- How confident Pulse is in the element, from 0 to 1. It's `null` when there is no score, as on spreadsheets and figure captions. content: type: string title: Content description: The element's text. For a table, it's the table as HTML. selected: type: boolean const: true title: Selected description: >- `true` on a ticked checkbox or radio button. Present only with `enhancements.detect: ["selections"]`. page: type: integer title: Page description: >- The element's page, counted from 1 within the selected pages. With `page_range` `5-7`, the document's page 5 is page 1. bbox: anyOf: - prefixItems: - type: number - type: number - type: number - type: number - type: number - type: number - type: number - type: number type: array maxItems: 8 minItems: 8 - type: 'null' title: Bbox description: >- The element's four corners, `[x1, y1, ..., x4, y4]`, clockwise from top-left, as fractions of the page's width and height. It's `null` for spreadsheet elements and some picture captions. sheet: type: string title: Sheet description: >- The element's sheet in a spreadsheet. A workbook's sheets are its pages. range: type: string title: Range description: >- The spreadsheet cells the element covers, such as `B2:D2`. Absent for a chart or picture not anchored to cells. additionalProperties: false type: object required: - id - category - confidence - content - page - bbox title: BaseElement description: >- A piece of the document's text, such as a title, a paragraph or a list item. TableElement: properties: id: type: string title: Id description: >- The element's id, in the form `{category}-{n}`, such as `Text-12`. `n` counts from 0 in reading order, and words are numbered separately. A cell's id adds its row and column, such as `Table-3-r0c2`. category: type: string const: Table title: Category description: Identifies a table. confidence: anyOf: - type: number - type: 'null' title: Confidence description: >- How confident Pulse is in the element, from 0 to 1. It's `null` when there is no score, as on spreadsheets and figure captions. content: type: string title: Content description: The element's text. For a table, it's the table as HTML. selected: type: boolean const: true title: Selected description: >- `true` on a ticked checkbox or radio button. Present only with `enhancements.detect: ["selections"]`. page: type: integer title: Page description: >- The element's page, counted from 1 within the selected pages. With `page_range` `5-7`, the document's page 5 is page 1. bbox: anyOf: - prefixItems: - type: number - type: number - type: number - type: number - type: number - type: number - type: number - type: number type: array maxItems: 8 minItems: 8 - type: 'null' title: Bbox description: >- The element's four corners, `[x1, y1, ..., x4, y4]`, clockwise from top-left, as fractions of the page's width and height. It's `null` for spreadsheet elements and some picture captions. sheet: type: string title: Sheet description: >- The element's sheet in a spreadsheet. A workbook's sheets are its pages. range: type: string title: Range description: >- The spreadsheet cells the element covers, such as `B2:D2`. Absent for a chart or picture not anchored to cells. dimensions: $ref: '#/components/schemas/TableDimensions' description: How many rows and columns the table has. cells: items: $ref: '#/components/schemas/CellElement' type: array title: Cells description: The table's cells, row by row. additionalProperties: false type: object required: - id - category - confidence - content - page - bbox - dimensions - cells title: TableElement description: A table, with each of its cells. FigureElement: properties: id: type: string title: Id description: >- The element's id, in the form `{category}-{n}`, such as `Text-12`. `n` counts from 0 in reading order, and words are numbered separately. A cell's id adds its row and column, such as `Table-3-r0c2`. category: type: string const: Figure title: Category description: Identifies a figure. confidence: anyOf: - type: number - type: 'null' title: Confidence description: >- How confident Pulse is in the element, from 0 to 1. It's `null` when there is no score, as on spreadsheets and figure captions. selected: type: boolean const: true title: Selected description: >- `true` on a ticked checkbox or radio button. Present only with `enhancements.detect: ["selections"]`. page: type: integer title: Page description: >- The element's page, counted from 1 within the selected pages. With `page_range` `5-7`, the document's page 5 is page 1. bbox: anyOf: - prefixItems: - type: number - type: number - type: number - type: number - type: number - type: number - type: number - type: number type: array maxItems: 8 minItems: 8 - type: 'null' title: Bbox description: >- The element's four corners, `[x1, y1, ..., x4, y4]`, clockwise from top-left, as fractions of the page's width and height. It's `null` for spreadsheet elements and some picture captions. sheet: type: string title: Sheet description: >- The element's sheet in a spreadsheet. A workbook's sheets are its pages. range: type: string title: Range description: >- The spreadsheet cells the element covers, such as `B2:D2`. Absent for a chart or picture not anchored to cells. figure_base64: type: string title: Figure Base64 description: >- The figure's image, base64-encoded. Present only with `enhancements.figures.include`. description: type: string title: Description description: >- A description of the figure, written by a model. Present only with `enhancements.figures.describe`. additionalProperties: false type: object required: - id - category - confidence - page - bbox title: FigureElement description: >- A figure: a chart, diagram, photo or other picture. Its caption is a `Caption` element. ResultExtensions: properties: additional_formats: $ref: '#/components/schemas/FormatOutputs' description: The formats you asked for in `additional_formats`. footnotes: items: $ref: '#/components/schemas/Footnote' type: array title: Footnotes description: >- The document's footnotes, when you set `footnotes`. Empty when the document has none. document_metadata: $ref: '#/components/schemas/DocumentMetadata' description: The file's own metadata, when you set `document_metadata`. word_level_bounding_boxes: items: oneOf: - $ref: '#/components/schemas/BaseElement' - $ref: '#/components/schemas/TableElement' - $ref: '#/components/schemas/FigureElement' discriminator: propertyName: category mapping: Caption: '#/components/schemas/BaseElement' Figure: '#/components/schemas/FigureElement' Footnote: '#/components/schemas/BaseElement' Formula: '#/components/schemas/BaseElement' List-item: '#/components/schemas/BaseElement' Page-footer: '#/components/schemas/BaseElement' Page-header: '#/components/schemas/BaseElement' Page-number: '#/components/schemas/BaseElement' Section-header: '#/components/schemas/BaseElement' Table: '#/components/schemas/TableElement' Text: '#/components/schemas/BaseElement' Title: '#/components/schemas/BaseElement' Word: '#/components/schemas/BaseElement' type: array title: Word Level Bounding Boxes description: >- Every word with its outline, as `Word` elements in page order, when you set `word_level_bounding_boxes`. chunking: $ref: '#/components/schemas/ChunkOutputs' additionalProperties: false type: object title: ResultExtensions description: >- The extra outputs you asked for in `config.extensions`. Only those are present. Usage: properties: request: $ref: '#/components/schemas/UsageRequest' org: $ref: '#/components/schemas/OrganizationUsage' description: >- Your organization's usage, including this request. Absent when it couldn't be read. additionalProperties: false type: object required: - request title: Usage description: Pages and credits used, by this request and by your organization. Warning: properties: code: type: string title: Code description: A stable code naming the warning. Match on this, not `message`. message: type: string title: Message description: A human-readable explanation. Its wording may change. additionalProperties: false type: object required: - code - message title: Warning description: Something that didn't stop the job but may affect its result. ResultHistory: properties: file_name: type: string title: File Name description: The original document's name. previous_step: type: string title: Previous Step description: >- The id of the result this one was built from, a `parse_id` or a `split_id`. Absent on `/parse` results. additionalProperties: false type: object required: - file_name title: ResultHistory description: Where this result came from. FieldIssue: additionalProperties: false description: One refused part of the request. properties: field: description: >- The part as sent: a body field's path (`config.enhancements.detect[1]`), or `query.` / `header.`. title: Field type: string pointer: description: >- A body field as a JSON Pointer (RFC 6901), e.g. `#/config/enhancements/detect/1`. Absent for a query parameter or header. title: Pointer type: string issue: description: What is wrong with it. title: Issue type: string required: - field - issue title: FieldIssue type: object JsonValue: {} TableDimensions: properties: rows: type: integer title: Rows description: How many rows the table has. columns: type: integer title: Columns description: How many columns the table has. additionalProperties: false type: object required: - rows - columns title: TableDimensions description: A table's size. CellElement: properties: id: type: string title: Id description: >- The element's id, in the form `{category}-{n}`, such as `Text-12`. `n` counts from 0 in reading order, and words are numbered separately. A cell's id adds its row and column, such as `Table-3-r0c2`. category: type: string const: Cell title: Category description: Identifies a table cell. confidence: anyOf: - type: number - type: 'null' title: Confidence description: >- How confident Pulse is in the element, from 0 to 1. It's `null` when there is no score, as on spreadsheets and figure captions. content: type: string title: Content description: The element's text. For a table, it's the table as HTML. selected: type: boolean const: true title: Selected description: >- `true` on a ticked checkbox or radio button. Present only with `enhancements.detect: ["selections"]`. page: type: integer title: Page description: >- The element's page, counted from 1 within the selected pages. With `page_range` `5-7`, the document's page 5 is page 1. bbox: anyOf: - prefixItems: - type: number - type: number - type: number - type: number - type: number - type: number - type: number - type: number type: array maxItems: 8 minItems: 8 - type: 'null' title: Bbox description: >- The element's four corners, `[x1, y1, ..., x4, y4]`, clockwise from top-left, as fractions of the page's width and height. It's `null` for spreadsheet elements and some picture captions. sheet: type: string title: Sheet description: >- The element's sheet in a spreadsheet. A workbook's sheets are its pages. range: type: string title: Range description: >- The spreadsheet cells the element covers, such as `B2:D2`. Absent for a chart or picture not anchored to cells. row: type: integer title: Row description: >- The cell's row in the table, counted from 0. Hidden rows and columns that weren't read aren't counted. column: type: integer title: Column description: The cell's column in the table, counted from 0. row_span: type: integer title: Row Span description: How many rows the cell spans. Absent when it spans one row. column_span: type: integer title: Column Span description: How many columns the cell spans. Absent when it spans one column. header: type: boolean const: true title: Header description: '`true` for a header cell.' raw_value: anyOf: - type: string - type: boolean - type: integer - type: number - type: 'null' title: Raw Value description: >- The cell's underlying value, such as `1201.67` where `content` shows `$1,202`. A date or time is ISO 8601 text, and an empty cell's value is `null`. Present only with `enhancements.spreadsheet.raw_values`. formula: type: string pattern: ^= title: Formula description: The cell's formula, such as `=SUM(B4:D4)`, for spreadsheets only. comment: type: string title: Comment description: The cell's note, for spreadsheets only. style: $ref: '#/components/schemas/CellStyle' description: >- The cell's formatting. Present only with `enhancements.spreadsheet.cell_formatting`. additionalProperties: false type: object required: - id - category - confidence - content - page - bbox - row - column title: CellElement description: A cell of a table. FormatOutputs: properties: html: type: string title: Html description: The Markdown as HTML. xml: type: string title: Xml description: The elements as an XML document, grouped by page. tagged_md: type: string title: Tagged Md description: >- The Markdown with each element's `id` written in as a `data-element-id` attribute. additionalProperties: false type: object title: FormatOutputs description: >- The document in the other formats you asked for. Only those formats are present. Footnote: properties: symbol: type: string title: Symbol description: The footnote's mark, such as `1` or `*`. text: type: string title: Text description: The footnote's text. footnote_element_id: type: string title: Footnote Element Id description: The id of the element holding the footnote. reference_element_ids: anyOf: - items: type: string type: array - type: 'null' title: Reference Element Ids description: >- The ids of the elements whose text cites the footnote, in reading order. additionalProperties: false type: object required: - symbol - text - footnote_element_id - reference_element_ids title: Footnote description: A footnote, and the elements that cite it. DocumentMetadata: properties: file: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: File description: >- The file's `name`, `extension`, `media_type`, `size_bytes` and `sha256`. properties: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Properties description: >- The document's properties, such as `title`, `authors` or `created_at`. `authors` and `keywords` are lists. structure: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Structure description: >- The document's counts and layout, such as `page_count`, `page_sizes` or `sheet_names`, depending on the file format. custom: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Custom description: The document's custom properties, as it stores them. format_specific: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Format Specific description: >- Metadata only the file's format has, such as a PDF's `form_fields`, an image's `exif`, or a spreadsheet's `sheets` and `defined_names`. additionalProperties: false type: object required: - file - properties - structure - custom - format_specific title: DocumentMetadata description: The metadata the file itself carries, read from the file as you sent it. ChunkOutputs: properties: semantic: items: $ref: '#/components/schemas/Chunk' type: array title: Semantic additionalProperties: false type: object title: ChunkOutputs description: >- Each requested strategy's chunks. A strategy that found no text or failed returns `[]`, with a `CHUNKS_SKIPPED` warning. UsageRequest: properties: pages_processed: type: integer title: Pages Processed description: Pages this request processed. credits_used: type: number title: Credits Used description: Credits this request used. additionalProperties: false type: object required: - pages_processed - credits_used title: UsageRequest description: What this request used. OrganizationUsage: properties: pages_processed: type: integer title: Pages Processed description: >- Pages processed, including this request's. A document's pages count once, when it is parsed: a step that reads a parse adds none. credits_used: type: number title: Credits Used description: Credits used, including this request's. credit_allowance: type: number title: Credit Allowance description: >- The credits your plan includes per billing period, or in total if it has no billing period. Absent on pay-as-you-go plans. additionalProperties: false type: object required: - pages_processed - credits_used title: OrganizationUsage description: >- Your organization's usage in its current billing period, including this request. If your plan has no billing period, it covers all time. CellStyle: properties: font: $ref: '#/components/schemas/CellFont' description: The cell's font. fill: anyOf: - type: string pattern: ^#[0-9a-fA-F]{6}$ - type: string pattern: ^theme:\d+$ title: Fill description: >- The cell's background color, as `#rrggbb`, or as `theme:` for the workbook's theme color `n`. border: $ref: '#/components/schemas/CellBorder' description: The cell's borders. alignment: $ref: '#/components/schemas/CellAlignment' description: The cell's alignment. additionalProperties: false type: object title: CellStyle description: >- A cell's formatting, as the workbook stores it. A part the workbook doesn't set is absent. Chunk: properties: id: type: string title: Id content: type: string title: Content pages: items: type: integer type: array title: Pages additionalProperties: false type: object required: - id - content - pages title: Chunk description: >- A slice of the Markdown, with page breaks and figure images removed. Its `id` is its strategy and its place in reading order, such as `semantic-0`. `pages` lists the pages it covers. CellFont: properties: bold: type: boolean const: true title: Bold description: '`true` when the text is bold.' italic: type: boolean const: true title: Italic description: '`true` when the text is italic.' underline: type: string enum: - single - double - single_accounting - double_accounting title: Underline description: How the text is underlined. size: type: number title: Size description: The font size, in points. name: type: string title: Name description: The font's name, such as `Calibri`. color: anyOf: - type: string pattern: ^#[0-9a-fA-F]{6}$ - type: string pattern: ^theme:\d+$ title: Color description: >- The text color, as `#rrggbb`, or as `theme:` for the workbook's theme color `n`. additionalProperties: false type: object title: CellFont description: A cell's font. CellBorder: properties: top: type: string enum: - thin - medium - thick - double - hair - dotted - dashed - dash_dot - dash_dot_dot - medium_dashed - medium_dash_dot - medium_dash_dot_dot - slant_dash_dot title: Top description: The top border's style. bottom: type: string enum: - thin - medium - thick - double - hair - dotted - dashed - dash_dot - dash_dot_dot - medium_dashed - medium_dash_dot - medium_dash_dot_dot - slant_dash_dot title: Bottom description: The bottom border's style. left: type: string enum: - thin - medium - thick - double - hair - dotted - dashed - dash_dot - dash_dot_dot - medium_dashed - medium_dash_dot - medium_dash_dot_dot - slant_dash_dot title: Left description: The left border's style. right: type: string enum: - thin - medium - thick - double - hair - dotted - dashed - dash_dot - dash_dot_dot - medium_dashed - medium_dash_dot - medium_dash_dot_dot - slant_dash_dot title: Right description: The right border's style. additionalProperties: false type: object title: CellBorder description: A cell's borders, by side. A side with no border is absent. CellAlignment: properties: horizontal: type: string enum: - left - center - right - fill - justify - center_across - distributed title: Horizontal description: >- The horizontal alignment. `center_across` centers the text across the empty cells to its right. Absent for Excel's default alignment, General. vertical: type: string enum: - top - center - bottom - justify - distributed title: Vertical description: The vertical alignment. wrap_text: type: boolean const: true title: Wrap Text description: '`true` when the text wraps within the cell.' additionalProperties: false type: object title: CellAlignment description: How a cell's content is aligned. securitySchemes: ApiKey: type: apiKey in: header name: x-api-key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.