Edit Async

POST /edit_async

Edit Async

Python

import requests

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

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

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

print(response.text)

200

{
  "job_id": "<string>"
}

Authorizations

Authorization · string · header · required

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

Headers

user-id · string | null

Body

application/json

document_url · string UploadResponse · object · 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

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

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

Response

200

application/json

Successful Response

job_id · string · required