Documentation API Reference

Create a render POST Mint a signed URL-render link POST Fetch or render a signed image GET Get render status GET Wait for render completion GET Stream render status (SSE) GET Download render asset GET

List templates GET Get template layer schema GET

Create a render batch POST Get batch status GET

render.completed Webhook render.failed Webhook

WEBHOOKS

render.completed

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

Header Parameters

X-Render-Signature?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

Example Requests

POST/renderCompleted

Get batch status GET

Previous Page

render.failed Webhook

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

eventId*string

Idempotency key for the delivery

event*string

Value in

"render.completed"
"render.failed"

data*