Skip to main content
POST
Edit

Authorizations

Authorization
string
header
required

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

Body

application/json
document_url
required

The URL of the document to be processed. You can provide one of the following:

  1. A publicly available URL
  2. A presigned S3 URL
  3. A reducto:// prefixed URL obtained from the /upload endpoint after directly uploading a document
edit_instructions
string
required

The instructions for the edit.

edit_options
EditOptions · object
form_schema
EditWidget · object[] | null

Form schema for PDF forms. List of widgets with their types, descriptions, and bounding boxes. Only works for PDFs.

priority
boolean
default:true

If True, attempts to process the job with priority if the user has priority processing budget available; by default, sync jobs are prioritized above async jobs.

Response

Successful Response

document_url
string
required

Presigned URL to download the edited document.

response_type
string
default:edit
Allowed value: "edit"
form_schema
EditWidget · object[] | null

Form schema for PDF forms. List of widgets with their types, descriptions, and bounding boxes.

usage
ParseUsage · object | null

Usage information for the edit operation, including number of pages and credits charged.