Flatten annotations

POST/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pageKey}/items/flattenv3.0.0-next.15

Flatten a chosen set of one page's annotations into its content — pages.flatten for a selection. Painted annotations are removed; ineligible ones report unchanged.

Authentication#

Any one of these credentials is accepted.

API token

The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.

Document token

Doc-scoped JWT, valid only on the /v1/docs/{docId} subtree it names, gated by the capability scopes it carries (each operation's x-required-capability).

Document capabilitydoc.pages.modifydoc.annotate.modify

Parameters#

docIdpathstringrequired

layerNamepathstringrequired

pageKeypathstringrequired

X-Document-Passwordheaderstring

Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

Idempotency-Keyheaderstring

Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.

Request body#

application/jsonDocAnnotationsFlattenRequestrequired

SDK examples#

The selected SDK is remembered across the API reference. Values are examples; replace them with identifiers and input from your application.

import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
  baseUrl: "https://yourhost.com/path/to/api",
  token: "<token>",
});

await client.doc.annotations.flatten({
  docId: "docId",
  layerName: "layerName",
  pageKey: "pageKey",
  body: {
    "key": "value"
  }
});

Responses#

200OK

application/jsonDocAnnotationsFlatten200Response

pagePageRef

kind"objectNumber"

objectNumberinteger

usage"display" | "print"

resultsobject[]

refAnnotationRef

kind =

kind"objectNumber"

pagePageRef

kind"objectNumber"

objectNumberinteger

status"applied" | "unchanged"

metaMutationMeta

affectedPagesPageRef[]

kind"objectNumber"

objectNumberinteger

cacheDeltaCacheDelta

opIdstring

undoableboolean

400Bad request

application/jsonDocAnnotationsFlatten400Response

404Not found

application/jsonDocAnnotationsFlatten404Response

defaultError

application/jsonEngineErrorPayload

name"EngineError"

messagestring

detailsobjectoptional