Poll compose-session readiness (is the warm box bound yet?)
Pure read: reports whether the session's warm render box has booted and bound its sandbox. `ready` flips to true once the sandbox is attached; until then render / verify / component-preview hard-fail 'no sandbox yet'. Poll this after openComposeSession before driving the box — boot is async, so expect a few not-ready polls on a cold box. Boots nothing.
API key auth. Prefix cf_live_ for production orgs, cf_test_ for sandbox.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/compose-session/string"{ "sessionId": "string", "ready": true, "sandboxId": "string", "status": "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 } }}Read the session's scratch composition GET
Pure read: returns the composition currently held in the session's SCRATCH (what the author LLM has been editing over this session), NOT the project's active composition. The Director ensemble reads this back per candidate and returns it as the authored composition — the winner is saved downstream, so a candidate never commits its scratch to active. 404 when the session is unknown/foreign or has never written a scratch.
Open a live compose session POST
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. Optionally seed the session scratch FROM a supplied composition (seedComposition) instead of the project's active — the body is optional (a bodyless open derives from active).