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](/developers/api-reference/edit-endpoints/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"Optional

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.
fileobjectRequired
A file object containing either a URL or a fileId.
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:
failureReasonstring or null
The reason for failure if status is "FAILED".

Errors