Get Parse Run | extend

Retrieve the status and results of a parse run.

Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the Create Parse Run endpoint.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

The unique identifier for the parse run.

Example: "pr_xK9mLPqRtN3vS8wF5hB2cQ"

Headers

Query parameters

responseTypeenumOptional

Controls how the output is delivered. Defaults to inline.

json - Returns the output directly in the output field of the response body.
url - Returns a presigned URL in the outputUrl field to download the output as a JSON file. The URL expires after 15 minutes. Useful for large outputs.

Controls how the output is delivered. Defaults to `inline`. * `json` - Returns the output directly in the `output` field of the response body. * `url` - Returns a presigned URL in the `outputUrl` field to download the output as a JSON file. The URL expires after 15 minutes. Useful for large outputs.

Allowed values:

Response

Successfully retrieved parse run

objectenum

The type of object. Will always be "parse_run".

Allowed values:

idstring

A unique identifier for the parse run.

Example: "pr_xK9mLPqRtN3vS8wF5hB2cQ"

fileobject

The file that was parsed. This file can be used as a parameter for other Extend endpoints, such as POST /workflow_runs.

statusenum

The status of the parse run:

"PROCESSING" - The file is still being processed
"PROCESSED" - The file was successfully processed
"FAILED" - The processing failed (see failureReason for details)

The status of the parse run: * `"PROCESSING"` - The file is still being processed * `"PROCESSED"` - The file was successfully processed * `"FAILED"` - The processing failed (see `failureReason` for details)

Allowed values:

failureReasonstring or null

The reason for failure.

Availability: Present when status is "FAILED".

Possible values include:

UNABLE_TO_DOWNLOAD_FILE - The file could not be downloaded from the provided URL
FILE_TYPE_NOT_SUPPORTED - The file type is not supported for parsing
FILE_SIZE_TOO_LARGE - The file exceeds the maximum allowed size
CORRUPT_FILE - The file appears to be corrupted or malformed
OCR_ERROR - An error occurred during optical character recognition
PASSWORD_PROTECTED_FILE - The file is password protected and cannot be processed
FAILED_TO_CONVERT_TO_PDF - The file could not be converted to PDF for processing
FAILED_TO_CONVERT_TO_JPEG - The file could not be converted to JPEG for processing
FAILED_TO_GENERATE_TARGET_FORMAT - The output could not be generated in the requested format
CHUNKING_ERROR - An error occurred while chunking the document
INTERNAL_ERROR - An unexpected internal error occurred
INVALID_CONFIG_OPTIONS - The provided configuration options are invalid
OUT_OF_CREDITS - Insufficient credits to process the file

Note: Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

The reason for failure. **Availability:** Present when `status` is `"FAILED"`. Possible values include: * `UNABLE_TO_DOWNLOAD_FILE` - The file could not be downloaded from the provided URL * `FILE_TYPE_NOT_SUPPORTED` - The file type is not supported for parsing * `FILE_SIZE_TOO_LARGE` - The file exceeds the maximum allowed size * `CORRUPT_FILE` - The file appears to be corrupted or malformed * `OCR_ERROR` - An error occurred during optical character recognition * `PASSWORD_PROTECTED_FILE` - The file is password protected and cannot be processed * `FAILED_TO_CONVERT_TO_PDF` - The file could not be converted to PDF for processing * `FAILED_TO_CONVERT_TO_JPEG` - The file could not be converted to JPEG for processing * `FAILED_TO_GENERATE_TARGET_FORMAT` - The output could not be generated in the requested format * `CHUNKING_ERROR` - An error occurred while chunking the document * `INTERNAL_ERROR` - An unexpected internal error occurred * `INVALID_CONFIG_OPTIONS` - The provided configuration options are invalid * `OUT_OF_CREDITS` - Insufficient credits to process the file **Note:** Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

failureMessagestring or null

A human-readable description of the failure.

Availability: Present when status is "FAILED".

outputobject or null

The parse run output.

Availability: Present when status is "PROCESSED" and the request was made without the responseType=url query parameter. Contains the parsed chunks.

outputUrlstring or null

A presigned URL to download the parse run output as a JSON file. The object shape is the same as the output field. Expires after 15 minutes.

Availability: Present when status is "PROCESSED" and the request was made with responseType=url query parameter.

metricsobject or null

Metrics about the parsing process.

Availability: Present when status is "PROCESSED".

configobject

The configuration used for the parsing process, including any default values that were applied.

usageobject or null

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED", the run was created after October 7, 2025, and the customer is on the current billing system.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

The reason for failure.

Availability: Present when status is "FAILED".

Possible values include:

UNABLE_TO_DOWNLOAD_FILE - The file could not be downloaded from the provided URL
FILE_TYPE_NOT_SUPPORTED - The file type is not supported for parsing
FILE_SIZE_TOO_LARGE - The file exceeds the maximum allowed size
CORRUPT_FILE - The file appears to be corrupted or malformed
OCR_ERROR - An error occurred during optical character recognition
PASSWORD_PROTECTED_FILE - The file is password protected and cannot be processed
FAILED_TO_CONVERT_TO_PDF - The file could not be converted to PDF for processing
FAILED_TO_CONVERT_TO_JPEG - The file could not be converted to JPEG for processing
FAILED_TO_GENERATE_TARGET_FORMAT - The output could not be generated in the requested format
CHUNKING_ERROR - An error occurred while chunking the document
INTERNAL_ERROR - An unexpected internal error occurred
INVALID_CONFIG_OPTIONS - The provided configuration options are invalid
OUT_OF_CREDITS - Insufficient credits to process the file

Note: Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

1	import { ExtendClient } from "extend-ai";
2
3	async function main() {
4	const client = new ExtendClient({
5	token: "YOUR_TOKEN_HERE",
6	extendApiVersion: "2026-02-09",
7	});
8	await client.parseRuns.retrieve("parse_run_id_here", {});
9	}
10	main();

1	{
2	"object": "parse_run",
3	"id": "pr_xK9mLPqRtN3vS8wF5hB2cQ",
4	"file": {
5	"object": "file",
6	"id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
7	"name": "Invoices.pdf",
8	"type": "PDF",
9	"parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
10	"metadata": {
11	"pageCount": 30,
12	"parentSplit": {
13	"id": "string",
14	"type": "Invoice",
15	"identifier": "other_2_9",
16	"startPage": 1,
17	"endPage": 10
18	}
19	},
20	"createdAt": "2024-03-21T16:45:00Z",
21	"updatedAt": "2024-03-21T16:45:00Z"
22	},
23	"status": "PROCESSING",
24	"failureReason": "FILE_TYPE_NOT_SUPPORTED",
25	"failureMessage": "File type not supported for parsing.",
26	"output": {
27	"chunks": [
28	{
29	"object": "chunk",
30	"type": "page",
31	"content": "This is the content of the chunk.",
32	"metadata": {
33	"pageRange": {
34	"start": 1,
35	"end": 1
36	}
37	},
38	"blocks": [
39	{
40	"object": "block",
41	"id": "string",
42	"type": "text",
43	"content": "string",
44	"details": {},
45	"metadata": {
46	"page": {
47	"number": 1,
48	"width": 1.1,
49	"height": 1.1
50	},
51	"textDirection": "ltr"
52	},
53	"polygon": [
54	{
55	"x": 10,
56	"y": 20
57	}
58	],
59	"boundingBox": {
60	"left": 10,
61	"top": 10,
62	"right": 20,
63	"bottom": 20
64	},
65	"parentBlockId": "string",
66	"children": [
67	null
68	]
69	}
70	]
71	}
72	],
73	"ocr": {
74	"words": [
75	{
76	"content": "string",
77	"boundingBox": {
78	"left": 10,
79	"top": 10,
80	"right": 20,
81	"bottom": 20
82	},
83	"confidence": 1.1,
84	"pageNumber": 1.1
85	}
86	]
87	}
88	},
89	"outputUrl": "https://...",
90	"metrics": {
91	"processingTimeMs": 1234,
92	"pageCount": 5
93	},
94	"config": {
95	"target": "markdown",
96	"chunkingStrategy": {
97	"type": "page",
98	"options": {
99	"minCharacters": 500,
100	"maxCharacters": 10000
101	}
102	},
103	"engine": "parse_performance",
104	"engineVersion": "latest",
105	"blockOptions": {
106	"figures": {
107	"enabled": true,
108	"figureImageClippingEnabled": true,
109	"advancedChartExtractionEnabled": false
110	},
111	"tables": {
112	"targetFormat": "html",
113	"tableHeaderContinuationEnabled": false,
114	"cellBlocksEnabled": false,
115	"agentic": {
116	"enabled": false,
117	"customInstructions": "string"
118	},
119	"enabled": true
120	},
121	"text": {
122	"signatureDetectionEnabled": false,
123	"agentic": {
124	"enabled": false,
125	"customInstructions": "string"
126	}
127	},
128	"keyValue": {
129	"blankFieldFormattingEnabled": false
130	},
131	"barcodes": {
132	"imageClippingEnabled": false,
133	"readingEnabled": false
134	}
135	},
136	"advancedOptions": {
137	"pageRotationEnabled": true,
138	"pageRanges": [
139	{
140	"start": 1,
141	"end": 10
142	},
143	{
144	"start": 20,
145	"end": 30
146	}
147	],
148	"excelParsingMode": "basic",
149	"excelSkipHiddenContent": false,
150	"excelUseRawCellValues": false,
151	"excelSkipCalculation": true,
152	"verticalGroupingThreshold": 1,
153	"returnOcr": {
154	"words": false
155	},
156	"alwaysConvertToPdf": false,
157	"enrichmentFormat": "xml",
158	"imageConversionQuality": "medium"
159	}
160	},
161	"usage": {
162	"credits": 10
163	}
164	}