Overview
The PDF Editor endpoint allows you to modify PDF documents by replacing text and images at specific coordinates. The endpoint supports both text and image replacements, and automatically re-parses the edited document to provide updated analysis results.Try it
Advanced Usage with Image Uploads
When working with image replacements, you can upload image files directly:Python
Checking Parse Task Status
After editing and re-parsing a PDF, you can monitor the parsing progress using the task status endpoint.Endpoint
How to Check Status
Python
JavaScript
cURL
Task Status Values
- Pending: Task is queued and waiting to be processed
- Processing: Task is currently being parsed
- Succeeded: Parsing completed successfully, results are available
- Failed: Parsing failed, check error message in response
Authorizations
Body
multipart/form-data
Response
PDF edited successfully
Whether the PDF edit operation was successful
Status message about the edit operation
URL of the edited PDF file (if upload_to_storage is true)
Size of the original PDF file in bytes
Size of the edited PDF file in bytes
Number of edit items that were processed
Whether the edited PDF was submitted for re-parsing
New job ID for monitoring the re-parsing progress (if job_id was provided)
