Document Render API: schemas
The request and response bodies of the operations in this API.
InlineHtmlRenderSourceDto
| Property | Type | Required | Description |
|---|
html | string | yes | Self-contained HTML document body fragment. |
kind | one of "INLINE_HTML" | yes | |
title | string | no | Optional title shown in the PDF metadata. |
| Property | Type | Required | Description |
|---|
kind | one of "PAGE" | yes | |
pageSlug | string | yes | KB page slug (within the space). |
spaceSlug | string | yes | KB space slug. |
version | number | no | Pin a specific version. Omit for the latest published. |
ProblemActionableBy
Who can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed.
Type: one of "user", "org-admin", "platform", "none"
ProblemDetailsDto
RFC 9457 problem document. The declared members are the reserved core; extension members are TOP-LEVEL and OPEN, owned by the refusing plane.
| Property | Type | Required | Description |
|---|
actionableBy | ProblemActionableBy | no | Who can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed. |
code | string | yes | SCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name. |
detail | string | no | Human-readable and specific to THIS occurrence. |
errors | array of ProblemFieldIssueDto | no | Field-level issues, when the refusal is about the request body. |
instance | string | no | URI reference identifying the occurrence — a request path, a run, a row. |
params | map of string or number or boolean | no | Safe i18n interpolation values for the message keyed by code — typed and allowlisted per code by its declaration. Never server-authored copy, never internal diagnostics. |
retry | ProblemRetry | no | What a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known. |
status | number | yes | The HTTP status code, repeated in the body so a logged document is self-contained. |
title | string | yes | Short, human-readable, and STABLE for a given type. Never per-occurrence — that is detail. |
traceId | string | no | W3C trace-context trace-id, present when the caller sent a traceparent. Omitted rather than invented when it did not. |
type | string | yes | Absolute URI identifying the refusal TYPE. Derived one-to-one from code, so a caller may branch on either and can never be told two different things. Never about:blank. |
ProblemFieldIssueDto
| Property | Type | Required | Description |
|---|
code | string | no | SCREAMING_SNAKE_CASE code of THIS issue, for a frontend i18n key. Present when the issue was minted by a declared problem. |
detail | string | yes | Prose for logs and developers. A frontend localises from code + params instead. |
params | map of string or number or boolean | no | Safe i18n interpolation values for this issue's code. |
pointer | string | yes | RFC 6901 JSON Pointer into the request body. Root is "/". |
ProblemRetry
What a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known.
Type: one of "transient", "after-change", "never"
RenderRecordResponseDto
| Property | Type | Required | Description |
|---|
byteSize | number or null | no | Byte size of the rendered output when READY. |
completedAt | string (date-time) or null | no | |
createdAt | string (date-time) | yes | |
downloadUrl | string or null | no | |
failureReason | string or null | no | |
format | one of "PDF", "DOCX" | yes | |
id | string | yes | |
status | one of "QUEUED", "RUNNING", "READY", "FAILED", "CANCELLED" | yes | |
RenderRecordResponseDtoDataEnvelope
RenderRequestDtoClass
| Property | Type | Required | Description |
|---|
designSystemBinding | object | no | Explicit owner-qualified DesignSystem RevisionTarget. Omit to render without a brand projection; no scope ladder or implicit default is consulted. |
format | one of "PDF", "DOCX" | yes | |
idempotencyKey | string | no | Caller-supplied idempotency key. Repeat POSTs with the same key return the existing record instead of re-rendering. |
source | PageRenderSourceDto or InlineHtmlRenderSourceDto | yes | |