Annotations

Create Annotations in a Layer

This endpoint allows you to add one or more new annotations to a specific layer in the document.

The endpoint accepts two content types:

  • application/json - in this case, the request body is a JSON representation of one or more annotation; you can check the schema for more details.
  • multipart/form-data - with multipart request, annotation(s) can be uploaded along with a new attachment. Annotations are one part of the request, followed by attachments.

The annotation id is optional, and will be generated by Document Engine if not provided. The user_id is set as the creator of the annotation.

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

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/layers/{layerName}/annotations
  • 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

OR

Example request

{
  "annotations": [
    {
      "content": {
        "bbox": [
          255.10077620466092,
          656.7566095695641,
          145.91672653256705,
          18.390804597701162
        ],
        "action": {
          "relativePath": "/other_document.pdf"
        },
        "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
        "createdAt": "2019-09-16T15:05:03.712909Z",
        "updatedAt": "2019-09-16T15:05:03.712909Z",
        "customData": {
          "foo": "bar"
        },
        "rects": [
          [
            100,
            200,
            300,
            400
          ]
        ],
        "color": "#fcee7c",
        "note": "This is a note."
      }
    }
  ]
}

Response

Annotation(s) created

OR

Example response

{
  "details": "Operation was partially successful",
  "data": [
    {
      "content": {
        "bbox": [
          255.10077620466092,
          656.7566095695641,
          145.91672653256705,
          18.390804597701162
        ],
        "action": {
          "relativePath": "/other_document.pdf"
        },
        "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
        "createdAt": "2019-09-16T15:05:03.712909Z",
        "updatedAt": "2019-09-16T15:05:03.712909Z",
        "customData": {
          "foo": "bar"
        },
        "rects": [
          [
            100,
            200,
            300,
            400
          ]
        ],
        "color": "#fcee7c",
        "note": "This is a note."
      },
      "id": "01DNEDPQQ22W49KDXRFPG4EPEQ"
    }
  ],
  "failing_paths": [
    {
      "path": "$.annotations[0]",
      "error": "Page index out of bounds.",
      "details": "The page index of the given annotation was greater than the number of pages in the document."
    }
  ]
}

Changes

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