Get Edit Run | extend

import { ExtendClient } from "extend-ai";
async function main() {
    const client = new ExtendClient({
        token: "YOUR_TOKEN_HERE",
        extendApiVersion: "2026-02-09",
    });
    await client.editRuns.retrieve("edit_run_id_here", {});
}
main();

{
  "object": "edit_run",
  "id": "edr_xK9mLPqRtN3vS8wF5hB2cQ",
  "file": {
    "object": "file",
    "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
    "name": "Invoices.pdf",
    "type": "PDF",
    "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
    "metadata": {
      "pageCount": 30,
      "parentSplit": {
        "id": "string",
        "type": "Invoice",
        "identifier": "other_2_9",
        "startPage": 1,
        "endPage": 10
      }
    },
    "createdAt": "2024-03-21T16:45:00Z",
    "updatedAt": "2024-03-21T16:45:00Z"
  },
  "status": "PROCESSING",
  "failureReason": "FILE_TYPE_NOT_SUPPORTED",
  "failureMessage": "File type not supported. Edit runs currently require a PDF.",
  "config": {
    "schema": {
      "type": "object",
      "properties": {},
      "required": [
        "string"
      ],
      "additionalProperties": true,
      "dependentRequired": {},
      "if": {
        "properties": {},
        "required": [
          "string"
        ],
        "dependentRequired": {},
        "allOf": [
          null
        ],
        "oneOf": [
          null
        ],
        "anyOf": [
          null
        ]
      },
      "then": {
        "properties": {},
        "required": [
          "string"
        ],
        "dependentRequired": {},
        "allOf": [
          null
        ],
        "oneOf": [
          null
        ],
        "anyOf": [
          null
        ]
      },
      "else": {
        "properties": {},
        "required": [
          "string"
        ],
        "dependentRequired": {},
        "allOf": [
          null
        ],
        "oneOf": [
          null
        ],
        "anyOf": [
          null
        ]
      },
      "allOf": [
        {
          "properties": {},
          "required": [
            "string"
          ],
          "dependentRequired": {},
          "allOf": [
            null
          ],
          "oneOf": [
            null
          ],
          "anyOf": [
            null
          ]
        }
      ],
      "oneOf": [
        {
          "properties": {},
          "required": [
            "string"
          ],
          "dependentRequired": {},
          "allOf": [
            null
          ],
          "oneOf": [
            null
          ],
          "anyOf": [
            null
          ]
        }
      ],
      "anyOf": [
        {
          "properties": {},
          "required": [
            "string"
          ],
          "dependentRequired": {},
          "allOf": [
            null
          ],
          "oneOf": [
            null
          ],
          "anyOf": [
            null
          ]
        }
      ],
      "not": {
        "properties": {},
        "required": [
          "string"
        ],
        "dependentRequired": {},
        "allOf": [
          null
        ],
        "oneOf": [
          null
        ],
        "anyOf": [
          null
        ]
      }
    },
    "instructions": "string",
    "schemaGenerationInstructions": "string",
    "advancedOptions": {
      "tableParsingEnabled": true,
      "flattenPdf": true,
      "radioEnumsEnabled": true,
      "nativeFieldsOnly": true
    }
  },
  "output": {
    "editedFile": {
      "id": "file_Ab3cDE45Fg6hIj7KlM8nO",
      "presignedUrl": "https://extend-ai-files.s3.amazonaws.com/..."
    },
    "filledValues": {}
  },
  "metrics": {
    "processingTimeMs": 1234,
    "pageCount": 5,
    "fieldCount": 10,
    "fieldsDetectedCount": 8,
    "fieldsAnnotatedCount": 10,
    "fieldDetectionTimeMs": 500,
    "fieldAnnotationTimeMs": 200,
    "fieldFillingTimeMs": 300
  },
  "usage": {
    "credits": 10
  }
}

Retrieve the status and results of an edit run.

Use this endpoint to get results for an edit run that has already completed, or to check on the status of an edit run initiated via the Create Edit Run endpoint.

Retrieve the status and results of an edit run. Use this endpoint to get results for an edit run that has already completed, or to check on the status of an edit run initiated via the [Create Edit Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/edit/create-edit-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 edit run.

Example: "edr_xK9mLPqRtN3vS8wF5hB2cQ"

Headers

x-extend-api-version"2026-02-09"Optional

API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

API version to use for the request. If you're using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a `400 Bad Request` or be set to a previous legacy version. See [API Versioning](https://docs.extend.ai/2026-02-09/developers/api-versioning) for more details.

x-extend-workspace-idstringOptional

The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.

The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/developers/authentication) for details on API key scopes.

Response

Successfully retrieved edit run

objectenum

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

Allowed values:

idstring

A unique identifier for the edit run.

Example: "edr_xK9mLPqRtN3vS8wF5hB2cQ"

fileobject

The input file that was submitted for editing.

statusenum

The status of the edit run:

"PROCESSING" - The file is still being processed
"PROCESSED" - The file was successfully edited
"FAILED" - The editing 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 - Failed to load the requested file
FILE_TYPE_NOT_SUPPORTED - File type not supported. Edit runs currently require a PDF
FILE_SIZE_TOO_LARGE - The file exceeds the maximum allowed size
CORRUPT_FILE - The file appears to be corrupted and cannot be edited
FIELD_DETECTION_ERROR - An error occurred during field detection
PASSWORD_PROTECTED_FILE - The file is password protected and cannot be edited
FAILED_TO_CONVERT_TO_PDF - The file could not be converted to PDF for processing
INTERNAL_ERROR - An unexpected internal error occurred
INVALID_OPTIONS - The provided configuration options are invalid
EMPTY_SCHEMA - No schema was provided and no fields could be detected
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".

configobject

The configuration used for this edit run, including any default values that were applied.

outputobject or null

The output of the edit run.

Availability: Present when status is "PROCESSED".

metricsobject or null

Metrics about the editing process.

Availability: Present when status is "PROCESSED".

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