Skip to main content
GET
Download extraction result

Overview

Large results may be returned as a URL instead of an inline response body. Use this endpoint to download the full completed result for a job when an extract or job response includes is_url: true.
Large-result links are intended for completed jobs. Poll GET /job/{jobId} first, then download the result URL if the job response says the result is URL-backed.

Typical Flow

Working With Large Documents

Plan long-running and large-output workflows.

Poll Job

Check async job status.

Authorizations

x-api-key
string
header
required

Path Parameters

jobId
string
required

Job identifier from the extraction response.

Response

Full extraction result (streamed JSON)

Full extraction result returned by the synchronous /extract endpoint. Inherits all core fields and adds deprecated backward-compatibility fields.

markdown
string

Primary markdown content extracted from the document. Always present in the new format.

extensions
object

Output from enabled extensions. Each key corresponds to an extension that was enabled in the request under extensions.*. Only keys for enabled extensions are present.

bounding_boxes
object

Positional bounding-box data for text, titles, headers, footers, images, and tables. Images carries chart/image visuals (with image_url when figure_processing.show_images is enabled), Tables the detected tables, and Text/Title/Footer the paragraph/title/footer regions. Additional keys (e.g. markdown_with_ids, defined_names) round-trip without being typed.

extraction_id
string<uuid>

Persisted extraction ID. Present when storage is enabled (default). Use this ID with /split and /schema endpoints.

extraction_url
string

URL to view the extraction on the Pulse platform. Present when storage is enabled.

page_count
integer

Number of pages processed.

Required range: x >= 1
plan_info
object

Billing tier and cumulative usage information. Includes total_credits_used (primary billing metric) and pages_used (legacy compatibility).

warnings
string[]

Non-fatal warnings generated during extraction. Includes deprecation notices when legacy input parameters are used, as well as processing warnings (e.g. word-level bounding box limitations).

credits_used
number<float> | null

Number of credits consumed by this request. Only present when the organization has the credit billing system enabled.

html
string
deprecated

Deprecated — Use extensions.altOutputs.html instead. HTML representation of the extracted content. Present when the legacy returnHtml input was used.

chunks
object
deprecated

Deprecated — Use extensions.chunking instead. Document content split into chunks. Present when the legacy chunking input was used.

structured_output
object
deprecated

Deprecated — Only present when the deprecated structuredOutput input parameter was used. Use the /schema endpoint after extraction instead.

input_schema
object
deprecated

Deprecated — Echo of the schema that was applied. Only present when the deprecated structuredOutput input parameter was used.

schema_error
string
deprecated

Deprecated — Error message if schema processing failed via the deprecated structuredOutput input parameter.

content
string
deprecated

Deprecated — Alias for markdown. Included for backward compatibility with older SDK versions. Prefer markdown.

job_id
string
deprecated

Deprecated — Identifier assigned to the extraction job. Retained for backward compatibility.

metadata
object
deprecated

Deprecated — Additional metadata supplied by the backend. Retained for backward compatibility.