Reference

Deployment

client.deployment.license_status() -> CloudPDF::Types::DeploymentLicenseStatusResponse

🔌 Usage

client.deployment.license_status

⚙️ Parameters

request_options: CloudPDF::Deployment::RequestOptions

Doc

client.doc.head(doc_id:) -> CloudPDF::Types::DocHead200Response

🔌 Usage

client.doc.head(doc_id: "docId")

⚙️ Parameters

doc_id: String

document_password: String — 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.

request_options: CloudPDF::Doc::RequestOptions

client.doc.download(doc_id:, layer_name:) -> String

🔌 Usage

client.doc.download(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

request_options: CloudPDF::Doc::RequestOptions

client.doc.manifest(doc_id:, layer_name:) -> CloudPDF::Types::DocManifest200Response

🔌 Usage

client.doc.manifest(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

request_options: CloudPDF::Doc::RequestOptions

client.doc.render(doc_id:, layer_name:, pon:) -> String

📝 Description

Render parameters (viewport, format) pass as flat dotted query keys, e.g. ?viewport.kind=width&viewport.width=800; the full grammar is documented with the viewer.

🔌 Usage

client.doc.render(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

request_options: CloudPDF::Doc::RequestOptions

client.doc.text(doc_id:, layer_name:, pon:) -> CloudPDF::Types::DocText200Response

🔌 Usage

client.doc.text(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

request_options: CloudPDF::Doc::RequestOptions

client.shares.exchange(request) -> CloudPDF::Types::SharesExchange200Response

📝 Description

Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, revoked, and disabled tokens are indistinguishable (404). Passphrase-protected grants return 422 SharePasswordRequired until password is supplied. Mounted only when the deployment can sign (HS256 mode).

🔌 Usage

client.shares.exchange(share_token: "shareToken")

⚙️ Parameters

share_token: String

password: String

request_options: CloudPDF::Shares::RequestOptions

client.shares.list(tenant_id:) -> CloudPDF::Types::SharesList200Response

🔌 Usage

client.shares.list(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

limit: Integer

cursor: String

doc_id: String

request_options: CloudPDF::Shares::RequestOptions

client.shares.create(tenant_id:, request) -> CloudPDF::Types::SharesCreate200Response

📝 Description

The returned share id IS the public share token. Mounted only when the deployment can sign (HS256 mode) — exchange mints session JWTs, so grants exist only where minting does.

🔌 Usage

client.shares.create(
  tenant_id: "tenantId",
  doc_id: "docId",
  scope: ["scope"]
)

⚙️ Parameters

tenant_id: String

doc_id: String

layer_name: String

scope: Internal::Types::Array[String]

origins: Internal::Types::Array[String]

password: String

session_ttl_seconds: Integer

expires_at: Integer

request_options: CloudPDF::Shares::RequestOptions

client.shares.get(tenant_id:, share_id:) -> CloudPDF::Types::SharesGet200Response

🔌 Usage

client.shares.get(
  tenant_id: "tenantId",
  share_id: "shareId"
)

⚙️ Parameters

tenant_id: String

share_id: String

request_options: CloudPDF::Shares::RequestOptions

client.shares.delete(tenant_id:, share_id:) ->

🔌 Usage

client.shares.delete(
  tenant_id: "tenantId",
  share_id: "shareId"
)

⚙️ Parameters

tenant_id: String

share_id: String

request_options: CloudPDF::Shares::RequestOptions

client.shares.update(tenant_id:, share_id:, request) -> CloudPDF::Types::SharesUpdate200Response

🔌 Usage

client.shares.update(
  tenant_id: "tenantId",
  share_id: "shareId"
)

⚙️ Parameters

tenant_id: String

share_id: String

scope: Internal::Types::Array[String]

origins: Internal::Types::Array[String]

password: String

session_ttl_seconds: Integer

disabled: Internal::Types::Boolean

expires_at: Integer

request_options: CloudPDF::Shares::RequestOptions

Tenants

client.tenants.list() -> CloudPDF::Types::TenantsList200Response

🔌 Usage

client.tenants.list

⚙️ Parameters

limit: Integer

cursor: String

request_options: CloudPDF::Tenants::RequestOptions

client.tenants.create(request) -> CloudPDF::Types::TenantsCreate200Response

🔌 Usage

client.tenants.create(id: "id")

⚙️ Parameters

id: String

name: String

request_options: CloudPDF::Tenants::RequestOptions

client.tenants.get(tenant_id:) -> CloudPDF::Types::TenantsGet200Response

🔌 Usage

client.tenants.get(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

request_options: CloudPDF::Tenants::RequestOptions

client.tenants.delete(tenant_id:) ->

📝 Description

Destroys the tenant and everything in its namespace — documents, layers, stored bytes, audit history. Irreversible.

🔌 Usage

client.tenants.delete(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

request_options: CloudPDF::Tenants::RequestOptions

client.tenants.resume(tenant_id:) ->

🔌 Usage

client.tenants.resume(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

request_options: CloudPDF::Tenants::RequestOptions

client.tenants.suspend(tenant_id:, request) ->

📝 Description

Instantly reversible with resume. The API token is exempt, so a suspended tenant can still be inspected, exported, resumed, or deleted.

🔌 Usage

client.tenants.suspend(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

reason: String

request_options: CloudPDF::Tenants::RequestOptions

client.tenants.usage(tenant_id:) -> CloudPDF::Types::TenantsUsage200Response

📝 Description

Facts only — no limits or billing state. Views count share exchanges plus authorized /v1/access grants, deduplicated across the two.

🔌 Usage

client.tenants.usage(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

period: String

request_options: CloudPDF::Tenants::RequestOptions

Documents

client.documents.list(tenant_id:) -> CloudPDF::Types::DocumentsList200Response

🔌 Usage

client.documents.list(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

limit: Integer

cursor: String

state: CloudPDF::Documents::Types::ListDocumentsRequestState

request_options: CloudPDF::Documents::RequestOptions

client.documents.get(tenant_id:, id:) -> CloudPDF::Types::DocumentsGet200Response

🔌 Usage

client.documents.get(
  tenant_id: "tenantId",
  id: "id"
)

⚙️ Parameters

tenant_id: String

id: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.delete(tenant_id:, id:) ->

🔌 Usage

client.documents.delete(
  tenant_id: "tenantId",
  id: "id"
)

⚙️ Parameters

tenant_id: String

id: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.commit(tenant_id:, id:, request) -> CloudPDF::Types::DocumentsCommit200Response

🔌 Usage

client.documents.commit(
  tenant_id: "tenantId",
  id: "id",
  sha256: "sha256"
)

⚙️ Parameters

tenant_id: String

id: String

sha256: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.download(tenant_id:, id:) -> String

🔌 Usage

client.documents.download(
  tenant_id: "tenantId",
  id: "id"
)

⚙️ Parameters

tenant_id: String

id: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.thumbnail(tenant_id:, id:) -> String

🔌 Usage

client.documents.thumbnail(
  tenant_id: "tenantId",
  id: "id"
)

⚙️ Parameters

tenant_id: String

id: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.upload_proxy(tenant_id:, id:, request) -> CloudPDF::Types::DocumentsUploadProxy200Response

📝 Description

This bounded origin-mediated fallback must only be used after documents.init returns upload.kind=proxy. Auto mode prefers a presigned object-store PUT whenever available.

🔌 Usage

File.open("document.pdf", "rb") do |file|
  client.documents.upload_proxy(
    tenant_id: "tenantId",
    id: "id",
    file: file
  )
end

⚙️ Parameters

tenant_id: String

id: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.import_from(tenant_id:, request) -> CloudPDF::Types::DocumentsImportFrom200Response

📝 Description

Default mode is synchronous and bounded: the response returns only after the transfer verified and committed (or failed). mode=async (connection sources only) answers 202 immediately and an in-process worker performs the transfer with leased, fenced retries; poll the document until ready/failed. The deployment import policy gates scheme, network range, and size; sources must declare a length. CloudPDF copies and owns the bytes — the source is never referenced in place. A 502 marks a retryable upstream failure: retry with the same idempotencyKey to resume the same document. URL sources are capabilities and never echoed back. Connection sources name operator-registered storage (bucket/prefix scope, allowed credential classes, and tenant bindings are deployment configuration); revision is provider-interpreted (S3 VersionId, GCS generation, Azure version id).

🔌 Usage

client.documents.import_from(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

source: CloudPDF::Documents::Types::DocumentsImportFromRequestSource — Where CloudPDF pulls the bytes from. The two shapes differ in WHO supplies the authority to read, not in which storage vendor holds the file.

expected: CloudPDF::Documents::Types::DocumentsImportFromRequestExpected — Integrity pins, enforced when present. When absent, the server-observed values become authoritative.

metadata: Internal::Types::Hash[String, Object]

idempotency_key: String — Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.

dedup_mode: CloudPDF::Documents::Types::DocumentsImportFromRequestDedupMode — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.

doc_id: String

mode: CloudPDF::Documents::Types::DocumentsImportFromRequestMode — sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.

request_options: CloudPDF::Documents::RequestOptions

client.documents.init(tenant_id:, request) -> CloudPDF::Types::DocumentsInit200Response

🔌 Usage

client.documents.init(
  tenant_id: "tenantId",
  content_length: 1.1,
  content_sha256: "contentSha256"
)

⚙️ Parameters

tenant_id: String

content_length: Integer

content_sha256: String

metadata: Internal::Types::Hash[String, Object]

idempotency_key: String

dedup_mode: CloudPDF::Documents::Types::DocumentsInitRequestDedupMode — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.

doc_id: String

upload_ttl_sec: Integer

upload_preference: CloudPDF::Documents::Types::DocumentsInitRequestUploadPreference

request_options: CloudPDF::Documents::RequestOptions

Tokens

client.tokens.issue(tenant_id:, request) -> CloudPDF::Types::TokensIssue200Response

📝 Description

kind "tenant" requires the API token — authority mints only downward. Mounted only when the deployment can sign (HS256 mode); asymmetric deployments mint with their own private key.

🔌 Usage

client.tokens.issue(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

request: CloudPDF::Types::TokensIssueRequest

request_options: CloudPDF::Tokens::RequestOptions

client.tokens.revoke(tenant_id:, jti:, request) ->

📝 Description

Mounted only when the deployment enables token revocation.

🔌 Usage

client.tokens.revoke(
  tenant_id: "tenantId",
  jti: "jti"
)

⚙️ Parameters

tenant_id: String

jti: String

reason: String

expires_at_seconds: Integer

request_options: CloudPDF::Tokens::RequestOptions

Doc Annotations

client.doc.annotations.list(doc_id:, layer_name:, pon:) -> CloudPDF::Types::DocAnnotationsList200Response

🔌 Usage

client.doc.annotations.list(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

request_options: CloudPDF::Doc::Annotations::RequestOptions

client.doc.annotations.create(doc_id:, layer_name:, pon:, request) -> CloudPDF::Types::DocAnnotationsCreate200Response

📝 Description

Doc JWTs may instead carry collab scopes (annotations:create:self, …) that refine per-annotation authorship rules; the API token is exempt from both.

🔌 Usage

client.doc.annotations.create(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1,
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Annotations::RequestOptions

client.doc.annotations.delete(doc_id:, layer_name:, pon:, annot_key:) -> CloudPDF::Types::DocAnnotationsDelete200Response

🔌 Usage

client.doc.annotations.delete(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1,
  annot_key: "annotKey"
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

annot_key: String

request_options: CloudPDF::Doc::Annotations::RequestOptions

client.doc.annotations.update(doc_id:, layer_name:, pon:, annot_key:, request) -> CloudPDF::Types::DocAnnotationsUpdate200Response

🔌 Usage

client.doc.annotations.update(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1,
  annot_key: "annotKey",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

annot_key: String

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Annotations::RequestOptions

Doc Forms

client.doc.forms.get(doc_id:, layer_name:) -> CloudPDF::Types::DocFormsGet200Response

🔌 Usage

client.doc.forms.get(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

request_options: CloudPDF::Doc::Forms::RequestOptions

client.doc.forms.export_data(doc_id:, layer_name:) -> String

🔌 Usage

client.doc.forms.export_data(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

format: CloudPDF::Doc::Forms::Types::ExportDataFormsRequestFormat

request_options: CloudPDF::Doc::Forms::RequestOptions

client.doc.forms.import_data(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsImportData200Response

🔌 Usage

client.doc.forms.import_data(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Forms::RequestOptions

client.doc.forms.reset(doc_id:, layer_name:, field_key:) -> CloudPDF::Types::DocFormsReset200Response

🔌 Usage

client.doc.forms.reset(
  doc_id: "docId",
  layer_name: "layerName",
  field_key: "fieldKey"
)

⚙️ Parameters

doc_id: String

layer_name: String

field_key: String

request_options: CloudPDF::Doc::Forms::RequestOptions

client.doc.forms.set_value(doc_id:, layer_name:, field_key:, request) -> CloudPDF::Types::DocFormsSetValue200Response

🔌 Usage

client.doc.forms.set_value(
  doc_id: "docId",
  layer_name: "layerName",
  field_key: "fieldKey",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

field_key: String

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Forms::RequestOptions

Doc Metadata

client.doc.metadata.get(doc_id:, layer_name:) -> CloudPDF::Types::DocMetadataGet200Response

🔌 Usage

client.doc.metadata.get(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

request_options: CloudPDF::Doc::Metadata::RequestOptions

Doc Pages

client.doc.pages.delete(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesDelete200Response

🔌 Usage

client.doc.pages.delete(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Pages::RequestOptions

client.doc.pages.extract(doc_id:, layer_name:, request) -> String

📝 Description

A read, not a mutation: the source document is untouched and no event is published. Body is {"pageObjectNumbers": number[]}; the response body is the new PDF.

🔌 Usage

client.doc.pages.extract(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    string: {
      key: "value"
    }
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Pages::RequestOptions

client.doc.pages.flatten(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesFlatten200Response

🔌 Usage

client.doc.pages.flatten(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Pages::RequestOptions

client.doc.pages.insert(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesInsert200Response

📝 Description

Multipart mutation envelope: a body field holding {"destIndex"?: number} (omitted → append) plus a resource:source file part carrying the standalone PDF whose pages are copied in. The inserted copies get fresh page object numbers, returned in insertion order.

🔌 Usage

client.doc.pages.insert(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

request_options: CloudPDF::Doc::Pages::RequestOptions

client.doc.pages.insert_blank(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesInsertBlank200Response

📝 Description

Body is {"size": {"width", "height"}, "count"?, "destIndex"?} — size in PDF points, count in [1, 100], destIndex omitted → append.

🔌 Usage

client.doc.pages.insert_blank(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Pages::RequestOptions

client.doc.pages.move(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesMove200Response

🔌 Usage

client.doc.pages.move(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Pages::RequestOptions

client.doc.pages.rotate(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRotate200Response

🔌 Usage

client.doc.pages.rotate(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Pages::RequestOptions

Doc Redactions

client.doc.redactions.apply(doc_id:, layer_name:, request) -> CloudPDF::Types::DocRedactionsApply200Response

🔌 Usage

client.doc.redactions.apply(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

request: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Redactions::RequestOptions

Uh oh!

FilesExpand file tree

reference.md

Latest commit

History

reference.md

File metadata and controls

Reference

Deployment

🔌 Usage

⚙️ Parameters

Doc

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

Shares

📝 Description

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

Tenants

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Documents

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

🔌 Usage

⚙️ Parameters

Tokens

📝 Description

🔌 Usage