Edit the Document and Download it
⚠️ This endpoint is deprecated. Please use /api/build instead.
This endpoint allows you to edit the document, performing transformations like rotating, adding or deleting pages. After these operations are applied, the Document Engine will return the result as a PDF file.
Note that in order to use this endpoint you need to have a document editing feature enabled in your license.
Operations with external files
In order to use importDocument, applyInstantJson, or applyXfdf operations, you need to use multipart/form-data content type.
Request
- Base URL: http://localhost:5000
- URL: http://localhost:5000/api/documents/{documentId}/pdf_with_operations
- Auth: one of:
- API key in header Authorization
- HTTP bearer
Path parameters
The document ID
Headers
The PDF document password.
The value can be either a plain-text password or a base64 encoded password in a form base64:<encoded-password>. Use the Base64 encoding if your password contains characters that are not allowed in HTTP header or would be otherwise mangled (e.g. trailing or leading spaces)
If the document is password protected, any operations performed on it require supplying a password.
Request body
Example request
{
"operations": [
{
"backgroundColor": "#000000",
"pageWidth": 595,
"pageHeight": 842,
"insets": [
10,
10,
10,
10
]
}
]
}Response
Document Engine responded with the PDF file
Changes
No recorded changes to this operation across all 1 revision of this API.