API reference

The CueFrame REST API is the complete surface an agent drives to turn intent into video. Every endpoint here is generated from the OpenAPI spec, so the request and response shapes match the running server exactly.

Authenticate with a bearer token (Authorization: Bearer $CUEFRAME_KEY) against https://api.cueframe.ai. New to the API? Start with the Quickstart — intent to rendered video in five calls — then come back here for the full reference.

The surface, by area

• Media — ingest footage from a URL, generate it from a prompt, and read the faces and transcript CueFrame detects.
• Projects — the container every other resource belongs to.
• Compositions — author the edit as data: clips, reframe intents, captions, ordering. Validate before you spend on a render.
• Compose — let the Director draft an ensemble of candidates, score them with a judge, and save the winner.
• Renders — bake a composition to an MP4 in any aspect ratio.
• Components & Brand Kits — custom TSX graphics and render-time branding.
• Sessions & Webhooks — interactive compose sessions and event callbacks.

Pick an endpoint from the sidebar to see its parameters, request body, and response, with copy-paste examples for REST, the CLI, and MCP.