RENDERS

Get render status

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

get/api/v1/renders/{id}

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

Authorization

AuthorizationBearer <token>

API key as Authorization: Bearer <key>

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/renders/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "queued",  "format": "png",  "attempts": 0,  "priority": 0,  "error": "string",  "webhookDeliveredAt": "2019-08-24T14:15:22Z",  "webhookLastError": "string",  "assetUrl": "string",  "retryAfterMs": 0}

Fetch or render a signed image GET

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.

Wait for render completion GET

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.