Skip to navigation
Edit Endpoints

Edit File Async

Edit and manipulate PDF documents asynchronously by filling forms, adding/modifying text fields, and applying structured changes.

The Edit Async endpoint allows you to convert and edit documents asynchronously and get an edit run ID that can be used to check status and retrieve results with the Get Edit Run endpoint.

This is useful for:

  • Large files that may take longer to process
  • Avoiding timeout issues with synchronous editing
  • Processing multiple files in parallel

Authentication

AuthorizationBearer

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

Headers

x-extend-api-version"2025-04-21"OptionalDefaults to 2025-04-21

API version to use for the request. If you 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.

Request

This endpoint expects an object.
fileobjectOptional

A file object containing either a URL or a fileId. Mutually exclusive with templateId — exactly one of file or templateId must be provided.

templateIdstringOptional

The ID of a saved edit template to run against. Mutually exclusive with file — exactly one of file or templateId must be provided.

The template’s saved file is used as the input, and its saved config (schema, instructions, engine version, and advanced options) is used to fill in any values not set on this request’s config. Values set on the request’s config always take precedence over the template’s.

Example: "edt_xK9mLPqRtN3vS8wF5hB2cQ"

configobjectOptional

Configuration for the edit operation. Field values should be specified using extend_edit:value on each field in the schema.

Response

Successfully initiated edit run
objectenum

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

Allowed values:
idstring

A unique identifier for the edit run. Will always start with "edit_run_"

Example: "edit_run_xK9mLPqRtN3vS8wF5hB2cQ"

statusenum
The status of the edit run.
Allowed values:
failureReasonstringOptional
The reason for failure if status is "FAILED".

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error