Open document

GET/v1/docs/{docId}/headv3.0.0-next.9

Open a document and return its head (versions, page count, security).

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.open

Parameters#

docIdpathstringrequired

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.

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.head({
  docId: "docId"
});

Responses#

200OK

application/jsonDocHead200Response

idstring

baseShastring

storageSizeBytesinteger

docVersioninteger

state"pending" | "ready" | "failed" | "deleting"

encryptionobject

state"unknown" | "none" | "encrypted" | "unsupported"

requiresPasswordboolean

permissionsobject

knownboolean

bitsinteger

allAllowedboolean

openedAs"none" | "user" | "owner"

securityHandlerRevisioninteger

canUpgradeToOwnerboolean

accessobject

requiredboolean

reasons("password" | "cdn" | "permissions-unknown")[]

endpointstringoptional

404Not found

application/jsonDocHead404Response

name"EngineError"

messagestring

detailsobjectoptional

defaultError

application/jsonEngineErrorPayload

name"EngineError"

messagestring

detailsobjectoptional