Draws a new image for this B-roll in the video's style and attaches it,
like "Describe this scene" in the editor. Pass prompt to say what the
scene should show: it is saved as the B-roll's prompt. Without it the
image is drawn again from the stored prompt, or from the line of
script the B-roll covers.
This charges one AI image (GET /reference/credit-costs), so send an
Idempotency-Key when retrying. A refused or failed drawing leaves the
B-roll as it was.
Only videos whose imageStyle draws every scene can redraw one:
realistic or a fixed art style, without animateBRolls. On mixed,
stock_footage and animated videos a still would replace footage or
a clip, so they are refused with 409 warning-invalid-input, as is a
B-roll carrying a talking presenter.
The rendered video keeps the old image until it is rendered again.
Authorization
bearerAuth An API key created under Settings > API & Webhooks. Keys start with sf_live_.
In: header
Path Parameters
Header Parameters
Unique key per action (a UUID works well). Reusing it replays the first response instead of running the action again, so a retry after a timeout can never generate, render, publish or charge twice.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/videos/string/brolls/string/image" \ -H "Content-Type: application/json" \ -d '{ "prompt": "A kangaroo in an explorer hat pointing at a map of Australia, Sydney and Melbourne pinned in red" }'{ "data": { "id": "b1a2b3", "startMs": 0, "endMs": 4560, "text": "For decades, Sydney and Melbourne fought to become the capital of Australia.", "prompt": "A kangaroo in an explorer hat pointing at a map of Australia, Sydney and Melbourne pinned in red", "url": "https://cdn.shortfast.com/uploads/brolls/b1a2b3-2.jpeg", "type": "image" }}Get the theme config GET
The stored caption styling for this video. An empty object means the video has never been styled and renders with the editor defaults.
Regenerate a scene's still POST
Generates a new still for this scene and attaches it. Charges one image generation. Pass `prompt` to use a different description for this run; it is saved as the scene's `imagePrompt`. Without it the scene's stored `imagePrompt` is used, and a scene with neither is a `400`. The scene's rendered clip and the stitched video are cleared, since both are now stale. UGC videos (`subType: ugc`) reuse one character image across every scene, so a per-scene regeneration does not apply and is refused with `409` `warning-invalid-input`.