Attachments

Get Attachment

Attachments are files that are attached to a document.

This endpoint provides a way to fetch an attachment's contents.

get/api/documents/{documentId}/attachments/{attachmentId}

Request

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

Path parameters

documentIdstring required

The document ID

attachmentIdstring required

The ID of the attachment

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.

Response

The attachment for the document

Changes

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