API reference

Enqueues a render and returns immediately with status: queued (HTTP 202). Pass ?wait=60 (max 120) to block until a terminal status within the timeout.

Returns an HMAC-signed GET /api/v1/img/{template} URL for CMS / Open Graph <img> tags. The fetch itself needs no API key. Pass jobs (1–50) to mint many URLs in one call. Minting does not consume a credit; the first unique GET of each URL does. Repeats are cache hits.

Unauthenticated. sig is HMAC over the template id and query (except sig). Optional exp is a unix expiry. Other query keys map to layer text or variables. First unique payload renders and bills the template owner; later hits stream the stored file.

Poll status as a fallback. Prefer /wait or /events in production. Use exponential backoff (250ms → 2s cap).

Long-poll until the job is done or failed, or until timeout elapses (max 60s). Returns 202 with retryAfterMs if still in progress — open another wait request.

Server-Sent Events stream of event: status until the job is terminal. Best for browser clients with a session cookie.

Streams the binary asset (HTTP 200). Send a session cookie or API key, or a valid sig query from assetUrl (no key). Signed fetches are long-lived until the file is archived (410). The former path /api/v1/renders/{id}/image still works as an alias.

Queue up to 50 renders in one request.

Delivered by the worker when a job finishes successfully. When RENDER_WEBHOOK_SECRET is set, verify X-Render-Signature: sha256=<hex> against the raw JSON body.

Delivered when a job fails. Same signature rules as render.completed.

Returns a page of templates in the API key's workspace (default 50, max 100). If hasMore is true, request the next page with offset. Use names and descriptions to pick a template, then fetch its schema.

Returns named layers and overridable attribute schemas for a template. Use this to build valid layers payloads for render requests.