API endpoints and fields

Look up the endpoints, request fields, and responses you need for your integration. If you are setting up your first request, start with API keys and requests or create your first PDF. You can also download the OpenAPI file to use with your own tools.

Endpoints

previewImageUrl

POST /v1/image-assets/preview

Preview a URL image

Read a public HTTP or HTTPS PNG, JPEG, or WebP through the checked asset transport. Credentials, private destinations, unsafe DNS answers, and redirects to them are refused. At most five redirects and 15 seconds total. The same upload decoder checks the 10 MiB, dimension, pixel, and memory limits. Returns verified bytes without storage or a render charge. Browser sessions require CSRF.

Authentication: bearer API key. See authentication.

Request body: application/json, {"type":"object","properties":{"url":{"type":"string","maxLength":4096}},"required":["url"],"additionalProperties":false}.

uploadImage

POST /v1/image-assets

Upload an image

Store one private, immutable PNG, JPEG, or WebP image. Send the raw bytes with the matching Content-Type. Maximum 10 MiB, 7680 by 4320 stored pixels, 32 million pixels, and 64 MiB decoded memory. Animated images are refused. Images and brand assets share an account limit of 100 files and 100 MiB. Use the returned reference in an HTML body img src, or in template data for an img src. Render creation checks ownership after template expansion and captures the exact bytes. References are not public URLs. PDF header and footer templates do not support image references. No render credit is charged for an upload.

Authentication: bearer API key. See authentication.

Request body: image/png, {"type":"string","format":"binary"}.

Request body: image/jpeg, {"type":"string","format":"binary"}.

Request body: image/webp, {"type":"string","format":"binary"}.

readImageContent

GET /v1/image-assets/{id}/content

Read an owned image

Return verified image or captured brand logo/font bytes to their owner. Missing and foreign assets return the same 404 error. The response uses private, no-store caching and nosniff.

Authentication: bearer API key. See authentication.

getOpenApiDocument

GET /v1/openapi.json

Get the OpenAPI document

Return this API contract as a JSON document.

Authentication: no API key required.

createPdf

POST /v1/pdf

Create a PDF

Render one PDF from raw HTML, an inline stateless template, or one owned saved-template version. An omitted saved version resolves to one exact immutable version before data validation, admission, idempotency, queueing, or billing. Template evaluation happens before storage and only evaluated HTML enters render input. Returns 200 for a terminal job or 202 while the accepted job remains queued or running. A terminal job can be succeeded, failed, or cancelled; check status before downloading. Send wait=false to skip the bounded wait. Every mode uses the same queue, renderer, retention, webhook, and fixed one-credit success price.

Authentication: bearer API key. See authentication.

Request body: application/json, PdfRequest.

listPdfHistory

GET /v1/pdf

List render history

List the authenticated account's render jobs, newest first. Failed or cancelled jobs removed through DELETE do not appear. Bounded by keyset: pass the previous page's next_cursor to continue, rather than an offset, so a page already read stays stable while new jobs are created.

Authentication: bearer API key. See authentication.

createImage

POST /v1/image

Create a static image

Render one PNG, JPEG, or WebP from raw HTML, an inline stateless template, or one owned saved-template version. Returns 200 for a terminal job or 202 while the accepted job remains queued or running. A terminal job can be succeeded, failed, or cancelled; check status before downloading. Send wait=false to skip the bounded wait. A successful render costs exactly one credit; a failed or cancelled render costs zero.

Authentication: bearer API key. See authentication.

Request body: application/json, ImageRequest.

listImageHistory

GET /v1/image

List image history

List the authenticated account's image jobs, newest first. Failed or cancelled jobs removed through DELETE do not appear. Bounded by keyset: pass the previous page's next_cursor to continue, rather than an offset, so a page already read stays stable while new jobs are created.

Authentication: bearer API key. See authentication.

getImage

GET /v1/image/{id}

Get a static image's status

Authentication: bearer API key. See authentication.

deleteImage

DELETE /v1/image/{id}

Delete an image file or an unsuccessful render

Remove a successful job's file, or remove a failed or cancelled job from history. Repeated requests are safe. The job stays readable by ID, and billing, abuse limits, and idempotency keys stay unchanged. Queued and running jobs return 409.

Authentication: bearer API key. See authentication.

createTemplateBuild

POST /v1/template-builds

Start a template build

Start one durable Build a template conversation from words, supported HTML, one source image, or your own working template source. The fixed successful price is 50 credits. A build from source makes no model call and costs 0 credits. A failed build releases the full reservation.

Authentication: bearer API key. See authentication.

Request body: application/json, TemplateBuildCreate.

getTemplateBuild

GET /v1/template-builds/{build_id}

Get a template build

Authentication: bearer API key. See authentication.

listTemplateMessages

GET /v1/template-builds/{build_id}/messages

List template chat messages

Authentication: bearer API key. See authentication.

editTemplateBuild

POST /v1/template-builds/{build_id}/messages

Edit the working template

Run one later AI edit. A text or HTML edit costs 10 credits. A new source image costs 50 credits. A source message replaces the draft with your own working template, makes no model call, and costs 0 credits. A failed edit keeps the previous valid draft and releases the reservation.

Authentication: bearer API key. See authentication.

Request body: application/json, TemplateMessageCreate.

getTemplateBuildDraft

GET /v1/template-builds/{build_id}/draft

Get the working template

Read the current draft as editable source, sample data, schema, and output. The build has no draft until its first message succeeds.

Authentication: bearer API key. See authentication.

getTemplateMessageDraft

GET /v1/template-builds/{build_id}/messages/{message_id}/draft

Get a completed message draft

Read the retained final source, sample data, schema, and output from a succeeded message in an owned build. The response excludes the brand snapshot. Reading it changes no state and costs no credits. Pending, failed, and cancelled messages have no final draft.

Authentication: bearer API key. See authentication.

cancelTemplateMessage

DELETE /v1/template-builds/{build_id}/messages/{message_id}

Cancel a pending template message

Authentication: bearer API key. See authentication.

publishTemplateBuild

POST /v1/template-builds/{build_id}/publish

Publish the current working template

Explicitly publish the current valid draft as one normal immutable saved-template version. Repeating publication of the same draft returns the same version.

Authentication: bearer API key. See authentication.

createTemplate

POST /v1/templates

Create a saved template

Authentication: bearer API key. See authentication.

Request body: application/json, TemplateWriteRequest.

listTemplates

GET /v1/templates

List saved templates

List the account's active and archived templates newest first. Source and schema are omitted. Pass next_cursor to continue with a stable keyset page.

Authentication: bearer API key. See authentication.

previewTemplate

POST /v1/templates/preview

Preview template data as HTML

Expand source and a JSON data object through the bounded template engine. Optional schema validation uses the saved-template rules. This does not save a template, create a render, or spend credits. The response is untrusted customer HTML for an isolated preview. Browser sessions need the current CSRF token.

Authentication: bearer API key. See authentication.

Request body: application/json, TemplatePreviewRequest.

getTemplate

GET /v1/templates/{template_id}

Get a saved template

Authentication: bearer API key. See authentication.

renameTemplate

PATCH /v1/templates/{template_id}

Rename a saved template

Set or clear the name of one owned template. The name is trimmed and can have 1 to 120 characters. A null or blank name clears it.

Authentication: bearer API key. See authentication.

Request body: application/json, TemplateRename.

archiveTemplate

DELETE /v1/templates/{template_id}

Archive a saved template

Archive one owned template. The operation is idempotent. Archived templates and versions remain readable, but they cannot receive another version or create another render.

Authentication: bearer API key. See authentication.

createTemplateVersion

POST /v1/templates/{template_id}/versions

Create a template version

Edit a template by publishing one complete new immutable source and optional schema. Existing versions never change. Archived templates cannot receive another version.

Authentication: bearer API key. See authentication.

Request body: application/json, TemplateVersionWriteRequest.

listTemplateVersions

GET /v1/templates/{template_id}/versions

List template versions

List immutable versions newest first. Source and schema are omitted. Archived template versions remain readable.

Authentication: bearer API key. See authentication.

getTemplateVersion

GET /v1/templates/{template_id}/versions/{version}

Get a template version

Authentication: bearer API key. See authentication.

createBrandKit

POST /v1/brand-kits

Create a brand kit

Create one mutable account-owned brand kit. Logos and fonts are uploaded through the kit's asset route after creation.

Authentication: bearer API key. See authentication.

Request body: application/json, BrandKitWrite.

listBrandKits

GET /v1/brand-kits

List brand kits

List the account's active and archived brand kits newest first. Asset metadata is omitted from the page; read one kit for its current assets.

Authentication: bearer API key. See authentication.

getBrandKit

GET /v1/brand-kits/{brand_kit_id}

Get a brand kit

Return one owned kit and its current logo and font metadata. Replaced assets remain private durable content but are omitted.

Authentication: bearer API key. See authentication.

updateBrandKit

PATCH /v1/brand-kits/{brand_kit_id}

Update a brand kit

Replace any supplied mutable brand values. Omitted fields stay unchanged; a null tone_guidance clears it. Archived kits cannot change.

Authentication: bearer API key. See authentication.

Request body: application/json, BrandKitPatch.

archiveBrandKit

DELETE /v1/brand-kits/{brand_kit_id}

Archive a brand kit

Archive one owned kit. The operation is idempotent. The kit and every current or replaced asset stay durable for already captured references.

Authentication: bearer API key. See authentication.

createBrandAsset

POST /v1/brand-kits/{brand_kit_id}/assets

Add a brand asset

Add one logo or WOFF2 font to an active owned kit. The declared Content-Type and the complete bytes must agree. No customer bytes or storage reference appears in the response.

Authentication: bearer API key. See authentication.

Request body: image/png, {"type":"string","format":"binary"}.

Request body: image/jpeg, {"type":"string","format":"binary"}.

Request body: image/webp, {"type":"string","format":"binary"}.

Request body: font/woff2, {"type":"string","format":"binary"}.

readBrandAsset

GET /v1/brand-kits/{brand_kit_id}/assets/{asset_id}

Read a brand asset

Read the validated logo or font bytes from an owned kit. Captured assets remain readable after replacement or archive. Responses are private and must not be cached.

Authentication: bearer API key. See authentication.

replaceBrandAsset

PUT /v1/brand-kits/{brand_kit_id}/assets/{asset_id}

Replace a brand asset

Create a new immutable asset of the same kind and make it current. The old asset and bytes stay unchanged for any template or queued operation that already captured its ID.

Authentication: bearer API key. See authentication.

Request body: image/png, {"type":"string","format":"binary"}.

Request body: image/jpeg, {"type":"string","format":"binary"}.

Request body: image/webp, {"type":"string","format":"binary"}.

Request body: font/woff2, {"type":"string","format":"binary"}.

getPdf

GET /v1/pdf/{id}

Get a PDF's status

Return one render job's current status, in the same representation POST /v1/pdf answers with. Mints a fresh signed download link on every call while the PDF is still available.

Authentication: bearer API key. See authentication.

deletePdf

DELETE /v1/pdf/{id}

Delete a PDF file or an unsuccessful render

Remove a successful job's PDF from storage, or remove a failed or cancelled job from history. The job stays readable by ID, and billing, abuse limits, and idempotency keys stay unchanged. The file is removed before its database marker; a file-removal failure returns 500 and leaves the record live for a safe retry. Repeated requests are safe. At or after the fixed retention cutoff, the removal reason remains expired.

Authentication: bearer API key. See authentication.

getDownload

GET /v1/downloads/{token}

Download a finished PDF or image

Return the finished PDF, PNG, JPEG, or WebP file a signed download link names. The link carries its own authority, so no other credential is read. The file is opened before 200 is returned: deletion that unlinks first gives 404, while a download that opens first finishes and every later download fails.

Authentication: no API key required.

createApiKey

POST /v1/keys

Create an API key

Create one API key for the authenticated account. The full secret is returned in this response and never again; only its verifier is kept.

Authentication: bearer API key. See authentication.

Request body: application/json, NewApiKey.

listApiKeys

GET /v1/keys

List API keys

List one bounded page of the authenticated account's keys, most recently created first. A revoked key stays in this history; its secret never appears here.

Authentication: bearer API key. See authentication.

revokeApiKey

DELETE /v1/keys/{key_id}

Revoke an API key

Revoke one key of the authenticated account. Revoking a key that is already revoked returns the same answer again rather than an error, so a retried request is never rejected.

Authentication: bearer API key. See authentication.

updateApiKey

PATCH /v1/keys/{key_id}

Set or clear an API key's monthly overage cap

Change how many overage credits this key may take on per calendar month (UTC). A positive number sets the cap; an explicit null, or a body without the field, clears it. The cap bounds only overage: work the prepaid balance fully covers is never refused by it.

Authentication: bearer API key. See authentication.

Request body: application/json, ApiKeyUpdate.

createWebhook

POST /v1/webhooks

Register a webhook destination

Register one HTTPS destination for terminal render events. The URL must pass the same egress policy the platform applies to every outbound request — public HTTPS on port 443, no credentials, and a DNS answer set of public addresses only — and delivery rechecks all of it on every connection, so a name that later resolves privately is refused then too. The signing secret is returned in this response and never again. Every delivery carries a Thirds-Signature header of the form "t=<unix-seconds>,v1=<hex>": each v1 value is HMAC-SHA256 over the exact bytes "<t>.<body>" with one signing secret, so verify against the raw body before parsing it, and refuse a timestamp too far from your own clock to bound replays. During a rotation overlap the header carries two v1 values — the current secret's first, then the previous secret's — and a receiver accepts the delivery when any one value matches.

Authentication: bearer API key. See authentication.

Request body: application/json, NewWebhook.

listWebhooks

GET /v1/webhooks

List webhook destinations

List every webhook destination of the authenticated account, most recently created first. The signing secret never appears here.

Authentication: bearer API key. See authentication.

getWebhook

GET /v1/webhooks/{webhook_id}

Read a webhook destination

Read one destination of the authenticated account, without its signing secret.

Authentication: bearer API key. See authentication.

deleteWebhook

DELETE /v1/webhooks/{webhook_id}

Delete a webhook destination

Delete one destination of the authenticated account. Deliveries stop at once, and events not yet delivered to it are dropped.

Authentication: bearer API key. See authentication.

rotateWebhookSecret

POST /v1/webhooks/{webhook_id}/rotate

Rotate a webhook destination's signing secret

Mint a new signing secret for one destination. The new secret signs immediately and is returned in this response and never again. The previous secret keeps signing alongside it for 24 hours — every delivery in the overlap carries both signatures — so switch the receiver to the new secret inside that window. Rotating again during an overlap replaces the previous secret at once: only the last two secrets ever sign.

Authentication: bearer API key. See authentication.

disableWebhook

POST /v1/webhooks/{webhook_id}/disable

Disable a webhook destination

Stop deliveries to one destination without deleting it. Disabling a destination that is already disabled returns the same answer again rather than an error, so a retried request is never rejected.

Authentication: bearer API key. See authentication.

enableWebhook

POST /v1/webhooks/{webhook_id}/enable

Enable a webhook destination

Resume deliveries to one destination, whether the owner disabled it or repeated delivery failures did, and reset its consecutive failure count. Enabling a destination that is already enabled returns the same answer again rather than an error, so a retried request is never rejected.

Authentication: bearer API key. See authentication.

replayWebhook

POST /v1/webhooks/{webhook_id}/replay

Replay a webhook destination's failed events

Return every event of one destination that ran out of delivery attempts to the queue with a fresh attempt budget. An event gets eight attempts per creation or replay, spread over roughly one day of growing backoff; after that it is failed and waits here. A replayed delivery carries the same event id and the same body as before, with a current signature and timestamp, so a receiver that stores event ids deduplicates it like any other retry. Replaying a destination with no failed events answers a count of zero rather than an error, so a retried request is never rejected.

Authentication: bearer API key. See authentication.

Schemas

Each table lists the fields for one request or response. Follow a linked type name to see its fields. The JSON rules below each table cover nested values and other limits. Response headers and shared errors are also in the OpenAPI file.

UploadedImage

Schema rules: {"type":"object","additionalProperties":false}.

FieldDetail

One request field that failed, its fixed safe reason, and an optional bounded source location. Details never carry template source, customer values, rendered output, or raw evaluator prose.

Schema rules: {"type":"object","additionalProperties":false}.

BrandKitId

Schema rules: {"type":"string","pattern":"^kit_[0-9a-f]{32}$"}.

BrandAssetId

Schema rules: {"type":"string","pattern":"^asset_[0-9a-f]{32}$"}.

BrandKitWrite

Schema rules: {"type":"object","additionalProperties":false}.

BrandKitPatch

Schema rules: {"type":"object","minProperties":1,"additionalProperties":false}.

BrandKitSummary

Schema rules: {"type":"object","additionalProperties":false}.

BrandAsset

Schema rules: {"type":"object","additionalProperties":false}.

BrandKitDetail

Schema rules: {"type":"object","additionalProperties":false}.

BrandKitPage

Schema rules: {"type":"object","additionalProperties":false}.

TemplateBuildId

Schema rules: {"type":"string","pattern":"^build_[0-9a-f]{32}$"}.

TemplateMessageId

Schema rules: {"type":"string","pattern":"^msg_[0-9a-f]{32}$"}.

TemplateBuildInput

Schema rules: {"oneOf":[{"type":"object","properties":{"type":{"const":"prompt"},"prompt":{"type":"string","minLength":1,"maxLength":65536}},"required":["type","prompt"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"html"},"html":{"type":"string","minLength":1,"maxLength":65536}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"image"},"base64":{"type":"string","minLength":1,"maxLength":13981016,"contentEncoding":"base64"}},"required":["type","base64"],"additionalProperties":false},{"type":"object","description":"Your own working template, sent as data. It must pass the saved-template checks. It becomes the draft without a model call and costs 0 credits.","properties":{"type":{"const":"source"},"source":{"type":"string","minLength":1,"maxLength":1048576},"sample_data":{"type":"object"},"schema":{"oneOf":[{"type":"object"},{"type":"boolean"}]}},"required":["type","source"],"additionalProperties":false}]}.

TemplateOutputIntent

Schema rules: {"oneOf":[{"type":"object","description":"Let the model choose PDF or image from the message. An image result from a source image uses the source dimensions.","properties":{"type":{"const":"auto"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"pdf"}},"required":["type"],"additionalProperties":false},{"type":"object","description":"Request an image. Set both width and height to override the source dimensions. Without a source image, omitted dimensions use 1200 by 628.","properties":{"type":{"const":"image"},"format":{"type":"string","enum":["png","jpeg","webp"],"default":"png"},"width":{"type":"integer","minimum":320,"maximum":7680},"height":{"type":"integer","minimum":200,"maximum":4320}},"required":["type"],"additionalProperties":false}]}.

TemplateOutput

Schema rules: {"oneOf":[{"type":"object","properties":{"type":{"const":"pdf"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"image"},"format":{"type":"string","enum":["png","jpeg","webp"]},"width":{"type":"integer","minimum":320,"maximum":7680},"height":{"type":"integer","minimum":200,"maximum":4320}},"required":["type","format","width","height"],"additionalProperties":false}]}.

TemplateBuildCreate

Schema rules: {"type":"object","if":{"required":["input_mode"]},"then":{"properties":{"input":{"properties":{"type":{"const":"source"}}}}},"additionalProperties":false}.

TemplateMessageCreate

Schema rules: {"type":"object","additionalProperties":false}.

TemplateMessage

Schema rules: {"type":"object","additionalProperties":false}.

TemplateBuild

Schema rules: {"type":"object","additionalProperties":false}.

TemplateBuildDraft

Schema rules: {"type":"object","additionalProperties":false}.

TemplatePublication

Schema rules: {"type":"object","additionalProperties":false}.

TemplateId

Schema rules: {"type":"string","pattern":"^tpl_[0-9a-f]{32}$"}.

TemplateName

The customer's own name for a template. It is trimmed and can have 1 to 120 characters. Null or blank means no name.

Schema rules: {"type":["string","null"],"maxLength":120}.

TemplateWriteRequest

Schema rules: {"type":"object","additionalProperties":false}.

TemplateVersionWriteRequest

Schema rules: {"type":"object","additionalProperties":false}.

TemplatePreviewRequest

Schema rules: {"type":"object","additionalProperties":false}.

TemplatePreview

Schema rules: {"type":"object","additionalProperties":false}.

TemplateRename

Schema rules: {"type":"object","additionalProperties":false}.

TemplateSummary

Schema rules: {"type":"object","additionalProperties":false}.

TemplateDetail

Schema rules: {"type":"object","additionalProperties":false}.

TemplatePage

Schema rules: {"type":"object","additionalProperties":false}.

TemplateVersionSummary

Schema rules: {"type":"object","additionalProperties":false}.

TemplateVersionDetail

Schema rules: {"type":"object","additionalProperties":false}.

TemplateVersionPage

Schema rules: {"type":"object","additionalProperties":false}.

RetryInfo

How long the caller must wait before it retries.

Schema rules: {"type":"object","additionalProperties":false}.

ImageRequestCommon

Schema rules: {"type":"object"}.

RawImageRequest

Schema rules: {"allOf":[{"$ref":"#/components/schemas/ImageRequestCommon"},{"type":"object","properties":{"html":{"type":"string","minLength":1,"maxLength":5242880}},"required":["html"]}],"unevaluatedProperties":false}.

StatelessTemplateImageRequest

Schema rules: {"allOf":[{"$ref":"#/components/schemas/ImageRequestCommon"},{"type":"object","properties":{"html":{"type":"string","minLength":1,"maxLength":1048576},"data":{"type":"object"}},"required":["html","data"]}],"unevaluatedProperties":false}.

SavedTemplateImageRequest

Schema rules: {"allOf":[{"$ref":"#/components/schemas/ImageRequestCommon"},{"type":"object","properties":{"template_id":{"$ref":"#/components/schemas/TemplateId"},"version":{"type":"integer","minimum":1},"data":{"type":"object"}},"required":["template_id","data"]}],"unevaluatedProperties":false}.

ImageRequest

Schema rules: {"oneOf":[{"$ref":"#/components/schemas/RawImageRequest"},{"$ref":"#/components/schemas/StatelessTemplateImageRequest"},{"$ref":"#/components/schemas/SavedTemplateImageRequest"}]}.

ImageJob

Schema rules: {"type":"object","additionalProperties":false}.

PdfRequestCommon

Render options shared by raw HTML, stateless-template, and saved-template requests. Every field is optional; an absent field takes the renderer's own default.

Schema rules: {"type":"object"}.

RawPdfRequest

A raw HTML render. The HTML enters the existing render workflow unchanged.

Schema rules: {"allOf":[{"$ref":"#/components/schemas/PdfRequestCommon"},{"type":"object","properties":{"html":{"type":"string","minLength":1,"maxLength":5242880,"description":"The raw HTML document to render. Up to 5,242,880 bytes."}},"required":["html"]}],"unevaluatedProperties":false}.

StatelessTemplatePdfRequest

A bounded stateless template evaluation followed by the existing PDF render workflow. The request saves no reusable template. Data must be exactly one JSON object. Only evaluated HTML and the effective render options enter short-lived render input storage.

Schema rules: {"allOf":[{"$ref":"#/components/schemas/PdfRequestCommon"},{"type":"object","properties":{"html":{"type":"string","minLength":1,"maxLength":1048576,"description":"The inline Jinja-style template source. The evaluator accepts at most 1,048,576 bytes."},"data":{"type":"object","description":"The JSON-compatible data object available to the template. Arrays, scalars, and null are not accepted as the top-level value. Its canonical recursively key-sorted JSON representation may contain at most 1,048,576 bytes; JSON Schema cannot express that serialized-byte bound."}},"required":["html","data"]}],"unevaluatedProperties":false}.

SavedTemplatePdfRequest

Render one exact owned saved-template version. Omit version to resolve the latest version once before validation and admission. Data must be exactly one JSON object.

Schema rules: {"allOf":[{"$ref":"#/components/schemas/PdfRequestCommon"},{"type":"object","properties":{"template_id":{"$ref":"#/components/schemas/TemplateId"},"version":{"type":"integer","minimum":1,"description":"An exact immutable version. Omit to select latest once."},"data":{"type":"object","description":"The JSON-compatible data object validated against the selected version's optional schema before evaluation or admission."}},"required":["template_id","data"]}],"unevaluatedProperties":false}.

PdfRequest

Exactly one supported PDF input mode: raw HTML, an inline stateless template, or one saved-template version. Image request shapes are not part of this endpoint.

Schema rules: {"oneOf":[{"$ref":"#/components/schemas/RawPdfRequest"},{"$ref":"#/components/schemas/StatelessTemplatePdfRequest"},{"$ref":"#/components/schemas/SavedTemplatePdfRequest"}]}.

PdfJob

The state of one render job. This is the same shape whether the job just finished (200) or is still in progress (202).

Schema rules: {"type":"object","additionalProperties":false}.

PdfHistoryItem

One job in a bounded account history — the subset of PdfJob a history page lists. Never carries a download link, since a history page can name many jobs at once.

Schema rules: {"type":"object","additionalProperties":false}.

PdfHistoryPage

One bounded page of an account's render history, newest first.

Schema rules: {"type":"object","additionalProperties":false}.

ImageHistoryItem

One job in a bounded account history — the subset of ImageJob a history page lists. Never carries a download link, since a history page can name many jobs at once.

Schema rules: {"type":"object","additionalProperties":false}.

ImageHistoryPage

One bounded page of an account's image history, newest first.

Schema rules: {"type":"object","additionalProperties":false}.

NewApiKey

What a new key is named.

Schema rules: {"type":"object","additionalProperties":false}.

ApiKey

One key, without its secret.

Schema rules: {"type":"object","additionalProperties":false}.

ApiKeyUpdate

What an update may change about a key.

Schema rules: {"type":"object","additionalProperties":false}.

ApiKeyWithSecret

One key exactly as creation answers it. This is the only shape that ever carries the secret.

Schema rules: {"type":"object","additionalProperties":false}.

ApiKeyList

One bounded page of the account's key history.

Schema rules: {"type":"object","additionalProperties":false}.

NewWebhook

What creating a webhook destination needs.

Schema rules: {"type":"object","additionalProperties":false}.

WebhookFields

Schema rules: {"type":"object"}.

Webhook

One webhook destination, without its signing secret.

Schema rules: {"allOf":[{"$ref":"#/components/schemas/WebhookFields"}],"unevaluatedProperties":false}.

WebhookWithSecret

One webhook destination exactly as creation and rotation answer it. This is the only shape that ever carries the signing secret.

Schema rules: {"allOf":[{"$ref":"#/components/schemas/WebhookFields"},{"type":"object","properties":{"secret":{"type":"string","pattern":"^thirds_whsec_[0-9a-f]{64}$","description":"The full signing secret: \"thirds_whsec_\" followed by 64 lowercase hexadecimal characters. It is shown here once and never again; store it and verify every delivery's Thirds-Signature header with it."}},"required":["secret"]}],"unevaluatedProperties":false}.

WebhookList

Every webhook destination the account holds. The cap is ten, so the list is never paged.

Schema rules: {"type":"object","additionalProperties":false}.

WebhookReplay

What one replay request did.

Schema rules: {"type":"object","additionalProperties":false}.

ErrorEnvelope

The one error shape every backend response uses.

Schema rules: {"type":"object","additionalProperties":false}.

Headers and security

XRequestId

{
  "description": "The UUID that identifies this request and matches error.request_id on an error response.",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}

bearerAuth

{
  "type": "http",
  "scheme": "bearer",
  "description": "An API key's secret, sent as \"Authorization: Bearer thirds_sk_v1_...\"."
}