Process Documents And Persist the Result

This endpoint allows to use Build instructions to process a document.

The current document can be referred to by using #self anchor.

{
  "document": { "id": "#self" }
}

The result of the processing will replace the document's base layer after successful completion.

post/api/documents/{documentId}/apply_instructions

Request

Base URL: http://localhost:5000
URL: http://localhost:5000/api/documents/{documentId}/apply_instructions
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.

Request body

Example request

{
  "parts": [
    {
      "file": "pdf-file-from-multipart"
    }
  ],
  "actions": [
    {
      "file": {
        "url": "https://remote-file-storage/input-file"
      }
    }
  ],
  "output": {
    "metadata": {
      "title": "Nutrient Document Engine API Specification",
      "author": "Document Author"
    },
    "labels": [
      {
        "label": "Page I-III"
      }
    ]
  }
}

Response

The document properties

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.