Edit Async

POST /edit_async

Try it

Edit Async

Python

import requests

url = "https://platform.reducto.ai/edit_async"

payload = {
    "document_url": "<string>",
    "edit_instructions": "<string>",
    "edit_options": { "color": "#FF0000" },
    "form_schema": [
        {
            "bbox": {
                "left": 123,
                "top": 123,
                "width": 123,
                "height": 123,
                "page": 123,
                "original_page": 123
            },
            "description": "<string>",
            "type": "text",
            "fill": True,
            "value": "<string>"
        }
    ],
    "priority": False,
    "webhook": {
        "mode": "disabled",
        "channels": []
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

200

{
  "job_id": "<string>"
}

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

Show child attributes

edit_options. color · string · default: #FF0000

The color to use for edits, in hex format.

edit_options. llm_provider_preference · enum<string> | null

The LLM provider to use for edit processing. If not specified, defaults to 'google'

Available options: openai, anthropic, google

form_schema · EditWidget · object[] | null

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

Show child attributes

form_schema. bbox · BoundingBox · object · required

Bounding box coordinates of the widget

Show child attributes

form_schema.bbox. left · number · required

form_schema.bbox. top · number · required

form_schema.bbox. width · number · required

form_schema.bbox. height · number · required

form_schema.bbox. page · integer · required

The page number of the bounding box (1-indexed).

form_schema.bbox. original_page · integer

The page number in the original document of the bounding box (1-indexed).

form_schema. description · string · required

Description of the widget extracted from the document

form_schema. type · enum<string> · required

Type of the form widget

Available options: text, checkbox, dropdown, barcode

form_schema. fill · boolean · default: true

If True (default), the system will attempt to fill this widget. If False, the widget will be created but intentionally left unfilled.

form_schema. value · string | null

If provided, this value will be used directly instead of attempting to intelligently determine the field value.

priority · boolean · default: false

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.

webhook · WebhookConfigNew · object

Show child attributes

webhook. mode · enum<string> · default: disabled

The mode to use for webhook delivery. Defaults to 'disabled'. We recommend using 'svix' for production environments.

Available options: disabled, svix, direct

webhook. url · string

The URL to send the webhook to (if using direct webhoook).

webhook. metadata · any

JSON metadata included in webhook request body

webhook. channels · string[]

A list of Svix channels the message will be delivered down, omit to send to all channels.

Response

200

application/json

Successful Response

job_id · string · required