CueFrame
API reference

Open a live compose session

Boot a warm reactive render session for the project. Render frames on demand via the session's /render endpoint; closed automatically after idle TTL or explicitly via DELETE.

POST
/v1/projects/{id}/compose-session

Authorization

AuthorizationBearer <token>

API key auth. Prefix cf_live_ for production orgs, cf_test_ for sandbox.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/projects/string/compose-session"
{  "sessionId": "string"}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

Close a compose session DELETE

Required permission: projects:write

Preview one component as a still in a compose session POST

Render a SINGLE org-installed component as one still inside the client's warm session box and return a presigned PNG URL. The component's authored tsxSource is read server-side (org-scoped) from the `componentId`; the box materializes and renders it. On a compile failure the response is a 422 `component_does_not_compile` carrying the sanitized compiler message — the authoring agent reads it to self-fix. A 422 `component_source_unavailable` means no authored source exists for the componentId in this org. The CLIENT owns the session lifecycle (open/close); this op neither opens nor closes a box.