API referenceScenes
Set a scene's background and/or canvas
background: {type:"solid", color} | {media_url, fit: cover|contain, is_video?} | {type:"stage"} (drop it; the theme stage shows).
canvas: "WxH" — this scene's own frame. Written into the scene and recompiled; pass expected_version (composition_version) for a compare-and-set. Free.
Authorization
bearerAuth AuthorizationBearer <token>
Typecut API key. Generate one in app.typecut.ai → Settings → API keys. Send as Authorization: Bearer tc_live_….
In: header
Path Parameters
sceneId*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/scenes/497f6eca-6276-4993-bfeb-53cbbbba6f08/frame" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"scene_id": "string",
"background": "string",
"canvas": {
"width": 0,
"height": 0
},
"composition_version": 0
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}