Understanding Reducto’s Edit endpoint for document modification
Edit is used to modify documents by applying instructions to either fill forms (PDF) or insert/modify content (DOCX). The edit endpoint is currently in beta and available only to whitelisted organizations.
The edit endpoint supports two different document types with distinct capabilities:
The edit endpoint uses the EditConfig
class with the following parameters:
document_url
: The document to edit (public URL, presigned S3 URL, or reducto:// URL)edit_instructions
: Natural language instructions describing the desired editssnippets
: Array of reusable text snippets (DOCX only)edit_options
: Configuration options including highlight color and LLM provider preferencepriority
: Whether to use priority processing (default: true for sync, false for async)color
: Hex color code for highlighting edits (default: “#FF0000”)llm_provider_preference
: Choose between “openai” or “anthropic” (internal use)Common error scenarios:
The edit endpoint is currently in beta and restricted to specific organizations:
Contact support to request beta access for your organization.
Why is my PDF not being edited?
PDF editing only works with fillable forms. If your PDF doesn’t have form fields, the edit endpoint cannot modify it. Convert your PDF to include form fields or use a DOCX format instead.
Can I edit the same document multiple times?
Yes, but each edit operation creates a new document. You’ll need to use the output from one edit as input to the next edit operation.
How do I get access to the edit endpoint?
The edit endpoint is currently in beta. Contact Reducto support to request access for your organization.
What's the difference between sync and async editing?
Synchronous editing returns the result immediately but may timeout for large documents. Asynchronous editing returns a job ID immediately and processes the document in the background.
Understanding Reducto’s Edit endpoint for document modification
Edit is used to modify documents by applying instructions to either fill forms (PDF) or insert/modify content (DOCX). The edit endpoint is currently in beta and available only to whitelisted organizations.
The edit endpoint supports two different document types with distinct capabilities:
The edit endpoint uses the EditConfig
class with the following parameters:
document_url
: The document to edit (public URL, presigned S3 URL, or reducto:// URL)edit_instructions
: Natural language instructions describing the desired editssnippets
: Array of reusable text snippets (DOCX only)edit_options
: Configuration options including highlight color and LLM provider preferencepriority
: Whether to use priority processing (default: true for sync, false for async)color
: Hex color code for highlighting edits (default: “#FF0000”)llm_provider_preference
: Choose between “openai” or “anthropic” (internal use)Common error scenarios:
The edit endpoint is currently in beta and restricted to specific organizations:
Contact support to request beta access for your organization.
Why is my PDF not being edited?
PDF editing only works with fillable forms. If your PDF doesn’t have form fields, the edit endpoint cannot modify it. Convert your PDF to include form fields or use a DOCX format instead.
Can I edit the same document multiple times?
Yes, but each edit operation creates a new document. You’ll need to use the output from one edit as input to the next edit operation.
How do I get access to the edit endpoint?
The edit endpoint is currently in beta. Contact Reducto support to request access for your organization.
What's the difference between sync and async editing?
Synchronous editing returns the result immediately but may timeout for large documents. Asynchronous editing returns a job ID immediately and processes the document in the background.