Renders a Page in a Layer
Returns an image with the rendered page from a document. Requires exactly one of width and height query parameters to set the required dimensions of the rendered image.
Annotation AP streams are not rendered by default, use render_ap_streams query parameter to enable AP streams rendering.
Rendered image format depends on the value of the Accept header. Supported content types are image/png (default) and image/webp.
Request
- Base URL: http://localhost:5000
- URL: http://localhost:5000/api/documents/{documentId}/layers/{layerName}/pages/{pageIndex}/image
- Auth: one of:
- API key in header Authorization
- HTTP bearer
Path parameters
The document ID
The layer name
The index of the page in the document
Query parameters
The width of the page to render.
The height of the page to render.
Whether to render annotation AP streams.
A list of OCG Layer IDs
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.
Response
Document Engine returned the rendering of the specified page in the document.
Changes
No recorded changes to this operation across all 1 revision of this API.