Edit File (Async)
Edit File (Async)
Edit File (Async)
Edit and manipulate PDF documents by detecting and filling form fields.
The Edit Runs endpoint allows you to convert and edit documents and get an edit run ID that can be used to check status and retrieve results with the Get Edit Run endpoint.
For more details, see the Edit File guide. See Async Processing for a full guide on polling helpers and webhooks.
The SDK provides a createAndPoll / create_and_poll method that handles polling automatically, returning when the run reaches a terminal state (PROCESSED or FAILED):
Bearer authentication of the form Bearer <token>, where token is your auth token.
The type of object. Will always be "edit_run".
A unique identifier for the edit run.
Example: "edr_xK9mLPqRtN3vS8wF5hB2cQ"
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)The reason for failure.
Availability: Present when status is "FAILED".
Possible values include:
UNABLE_TO_DOWNLOAD_FILE - Failed to load the requested fileFILE_TYPE_NOT_SUPPORTED - File type not supported. Edit runs currently require a PDFFILE_SIZE_TOO_LARGE - The file exceeds the maximum allowed sizeCORRUPT_FILE - The file appears to be corrupted and cannot be editedFIELD_DETECTION_ERROR - An error occurred during field detectionPASSWORD_PROTECTED_FILE - The file is password protected and cannot be editedFAILED_TO_CONVERT_TO_PDF - The file could not be converted to PDF for processingINTERNAL_ERROR - An unexpected internal error occurredINVALID_OPTIONS - The provided configuration options are invalidEMPTY_SCHEMA - No schema was provided and no fields could be detectedOUT_OF_CREDITS - Insufficient credits to process the fileNote: Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.
A human-readable description of the failure.
Availability: Present when status is "FAILED".
The output of the edit run.
Availability: Present when status is "PROCESSED".
Metrics about the editing process.
Availability: Present when status is "PROCESSED".
Usage credits consumed by this edit run.
Availability: Present when status is "PROCESSED", the run was created after October 7, 2025, and the customer is on the current billing system.
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.