Sign in

v1

latestOpenAPI 3.1.02026-07-2665164286.3 KB
HyperFrames

Create HyperFrames Render

Renders a HyperFrames composition (an HTML+JS+assets project bundled as a .zip) into a video. Submit the project via url, asset_id (pre-uploaded via POST /v3/assets), or inline base64. Returns a render_id to poll via GET /v3/hyperframes/renders/{render_id}.

post/v3/hyperframes/renders

Headers

Idempotency-Keystring

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Request body

fpsinteger nullable

Output frames per second. Defaults to 30 if not provided.

quality'draft' | 'standard' | 'high'

Render quality preset; higher quality is slower.

format'mp4' | 'webm' | 'mov'

Output container/codec.

resolution'1080p' | '4k'

Output resolution tier.

Pricing diverges only at 4K (1.5x multiplier). The render-pipeline value set is intentionally narrow at launch; 720p and other tiers will follow once the producer/CLI surface catches up.

aspect_ratio'16:9' | '9:16' | '1:1'

Output aspect ratio.

Only the three ratios already supported end-to-end by the render pipeline are exposed today: 16:9 (landscape), 9:16 (portrait), 1:1 (square). auto and other social-media ratios (4:5, 5:4) are reserved for a follow-up PR that wires composition-dim inference at the controller boundary.

compositionstring nullable

Entry HTML file relative to the project root (e.g. compositions/intro.html). Defaults to index.html when omitted.

variablesobject nullable

Optional overrides for the composition's data-composition-variables. Use this to parameterise a single composition across multiple renders.

titlestring nullable

Free-text label for the render; echoed back in detail responses.

callback_idstring nullable

Opaque client tracking ID, echoed back in webhook payloads.

callback_urlstring nullable

Per-request HTTPS webhook URL the render fires when it terminates.

Response

Accepted — submission acknowledged; poll for completion.