templates

Render a template to an MP4 with a share link

Bind the template's parameters and render the result under the org's system project, without touching any project of yours: one row per request, rendered through the render pipeline and reachable at shareUrl (302 to the MP4 while it is complete) and posterUrl. Media values are { mediaId } (must be complete), { url } (https, imported once per org) or { sample: true }; imports are awaited by the render. Priced as a render; an x402 caller's render expires with their workspace. Send an Idempotency-Key per row to make retries safe.

post/v1/templates/{id}/renders

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/templates/{id}/renders
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.cueframe.ai/api/auth/mcp/authorize, token URL https://api.cueframe.ai/api/auth/mcp/token, scopes: renders:write)
    • API key in header PAYMENT-SIGNATURE

Path parameters

idstring required

Request body

valuesobject required
mediaobject required
presetstring
brandKitIdstring
posterAtnumber

Seconds into the render for the poster still; default 1.

Response

The render, preparing.

idstring required
status'preparing' | 'rendering' | 'complete' | 'failed' | 'cancelled' | 'revoked' required
templateIdstring required
versioninteger required
presetstring
brandKitIdstring
shareUrlstring nullable required
posterUrlstring nullable required
renderIdstring nullable required
errorCodestring
errorMessagestring
expiresAtstring
createdAtstring required
updatedAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.