Layers

Download the Layer as a PDF

This operation downloads the latest version of the document with annotations as a PDF file.

post/api/documents/{documentId}/layers/{layerName}/pdf

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/layers/{layerName}/pdf
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

documentIdstring required

The document ID

layerNamestring required

The layer name

Headers

pspdfkit-pdf-passwordstring

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

type'pdf' | 'pdfa' required

The type of output file. Can be pdfa or pdf.

sourceboolean

If set to true, the originally uploaded version of the PDF file will be fetched. The remaining properties are mutually exclusive with this property.

flattenboolean

Determines whether a flattened version of the PDF file will be downloaded. If set to true, the resulting PDF file will have its annotations burned into the document and will have no annotations.

render_ap_streamsboolean

If set to true, the resulting PDF file will have its custom AP streams rendered into the document.

annotationsboolean

If set to true, annotations will be included in the downloaded file

commentsboolean

If set to true, comments will be included in the downloaded file.

conformance'pdfa-1a' | 'pdfa-1b' | 'pdfa-2a' | 'pdfa-2u' | 'pdfa-2b' | 'pdfa-3a' | 'pdfa-3u'

The level of conformance of the pdfa file. Defaults to pdfa-1b if the type is set to pdfa and conformance is not explicitly specified.

Example request

{
  "type": "pdfa",
  "conformance": "pdfa-1a"
}

Response

Document Engine responded with the PDF file

Changes

No recorded changes to this operation across all 1 revision of this API.