Import and Export

Apply an Instant JSON to Document

To import an Instant JSON file and apply it to an existing document, you can POST a multipart/form request including an instant.json file. This will modify the default layer of the document in place. In case of success, the endpoint will respond with an empty JSON object.

post/api/documents/{documentId}/apply_instant_json

Request

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

Path parameters

documentIdstring required

The document ID

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 Instant JSON has been applied successfully.

Changes

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