Response Format

An edit run returns an edit_run object. While the run is processing, output is null; once status is "PROCESSED", output carries the completed PDF and the values that were written into it. This page explains every field in the response.

Response structure

A completed edit run looks like this. The result lives in output: the finished document in editedFile and the values that were written in filledValues.

1 {
2   "object": "edit_run",
3   "id": "edr_xK9mLPqRtN3vS8wF5hB2cQ",
4   "file": {
5     "object": "file",
6     "id": "file_Zk9mNP12Qw4yTv8BdR3H",
7     "name": "f1040.pdf"
8   },
9   "status": "PROCESSED",
10   "failureReason": null,
11   "failureMessage": null,
12   "config": { "instructions": "Fill the taxpayer's name and filing status." },
13   "output": {
14     "editedFile": {
15       "id": "file_Ab3cDE45Fg6hIj7KlM8nO",
16       "presignedUrl": "https://extend-files.s3.amazonaws.com/..."
17     },
18     "filledValues": {
19       "first_name": "Jordan",
20       "last_name": "Avery",
21       "filing_status_single": true
22     }
23   },
24   "metrics": { "processingTimeMs": 1234, "pageCount": 2, "fieldCount": 3 },
25   "usage": { "credits": 1 }
26 }

Top-level fields

Field	Type	Description
`object`	string	Always `"edit_run"`.
`id`	string	Unique identifier for the run (e.g. `edr_...`). Use it to fetch results later.
`file`	object	The input file submitted for editing (`id`, `name`).
`status`	string	`PROCESSING`, `PROCESSED`, or `FAILED`.
`config`	object	The full configuration used, including defaults that were applied.
`output`	object \| null	The completed PDF and filled values. Present when `status` is `PROCESSED`.
`metrics`	object \| null	Processing time, page count, and field-level counts. Present when `status` is `PROCESSED`.
`usage`	object	Credits consumed (`usage.credits`).
`failureReason` / `failureMessage`	string \| null	Machine-readable code and human-readable message. Present when `status` is `FAILED`. See Error Handling.

The edited file

output.editedFile is the completed PDF.

Field	Type	Description
`output.editedFile.id`	string	The Extend file `id` of the edited document. Reusable as input to other endpoints.
`output.editedFile.presignedUrl`	string	A download URL for the completed PDF.

presignedUrl expires 15 minutes after the response is returned. Download or store the file promptly.

Python

TypeScript

Java

Go

1 edited = result.output.edited_file
2 print("File id:", edited.id)
3 print("Download:", edited.presigned_url)  # expires after 15 minutes

Filled values

output.filledValues is the set of values written into the form, keyed by the property names from your schema (or the field names Extend detected when you pass instructions). It is omitted when no values were filled.

1 {
2   "output": {
3     "filledValues": {
4       "first_name": "Jordan",
5       "last_name": "Avery",
6       "filing_status_single": true
7     }
8   }
9 }

Metrics

When status is PROCESSED, metrics reports timing and field-level counts for the run.

Field	Type	Description
`processingTimeMs`	number	Total processing time, in milliseconds.
`pageCount`	integer	Number of pages in the document.
`fieldCount`	integer	Total number of fields in the schema.
`fieldsDetectedCount`	integer	Number of fields that were automatically detected.
`fieldsAnnotatedCount`	integer	Number of fields that were annotated with bounding boxes.
`fieldDetectionTimeMs`	number	Time taken to detect fields, in milliseconds.
`fieldAnnotationTimeMs`	number	Time taken to annotate field positions, in milliseconds.
`fieldFillingTimeMs`	number	Time taken to fill the fields, in milliseconds.

Status values

Status	Description
`PROCESSING`	The file is still being edited.
`PROCESSED`	The edit completed successfully; `output` is populated.
`FAILED`	The edit failed; see `failureReason` and `failureMessage`. See Error Handling.