Run Scene Step
Run one step on the scene as an Operation (202 + Location).
generate_scene_sdd writes the Scene Design Document from brief;
generate_scene_peg builds the Player Experience Graph from the current
SDD (409 missing_sdd); generate_scene_blueprint turns the current PEG
into a blueprint (the swfbpx package) and a layout preview (409 missing_peg);
generate_scene_model cooks the current blueprint into the model (409
missing_blueprint). Rerunning a step versions its artifact. The AI
steps deduct credits once they complete; the procedural steps are free.
One step at a time per scene (409 step_in_progress). Prefer: wait=N
holds the response. Requires the write scope.
Authorization
apiKey First-party API key (sbk_live_…), presented as a Bearer token.
In: header
Path Parameters
uuidHeader Parameters
Optional. Repeating a request with the same key returns what it already created (200) instead of running it again.
RFC 7240. wait=N (N ≤ 60) holds the response until the operation is terminal or N seconds passed: 200 with the finished operation, or the same 202 as without it. respond-async (the default) returns the queued operation at once.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
One step to run against the scene. The value of step is the name of
the tool that runs it.
Response Body
application/json
application/json
application/problem+json
curl -X POST "https://example.com/v1/scenes/497f6eca-6276-4993-bfeb-53cbbbba6f08/steps" \ -H "Content-Type: application/json" \ -d '{ "step": "generate_scene_sdd" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "scene_step", "status": "queued", "target": { "type": "scene", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "input": {}, "progress": {}, "result": {}, "error": { "code": "string", "message": "string", "retryable": false }, "credits_charged": 0, "model": { "id": "string", "hosting": "scenebrew", "billing": "credits" }, "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4", "created_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "cancel_requested_at": "2019-08-24T14:15:22Z"}