Edit the Document and Persist the Result
⚠️ This endpoint is deprecated. Please use /api/documents/{documentId}/apply_instructions instead.
This endpoint allows you to edit the document, performing transformations like rotating, adding or deleting pages, and store the resulting PDF file at the document's base layer.
Editing the document affects the responses returned by other endpoints. For example, removing a page also deletes all the annotations on that page. Similarly, other functionality, like searching in a document will return different results.
If you need to preserve the original document, PDF file, and related data, we recommend leveraging Instant Layers and always using named layers.
Note that in order to use this endpoint you need to have a document editing feature enabled in your license.
Request
- Base URL: http://localhost:5000
- URL: http://localhost:5000/api/documents/{documentId}/apply_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
The changes have been persisted on Document Engine.
Example response
{
"data": {
"passwordProtected": true,
"sourcePdfSha256": "1defd934dbbf77587eb9b7f45d162d2a3aea16c840a9e7cfa190fb2ea1f40a76",
"title": "Nutrient Document Engine API Specification",
"byteSize": 192000,
"createdAt": "2019-09-16T15:05:03.712909Z"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.