videos

Call videos.generate_clip

'generate a clip for this scene', 'make this scene since we don't have real footage' — start a made clip for one storyboard scene when nothing real will do, and return its job handle. The clip is NOT ready when this answers; follow its job_id with jobs.read. A retry carrying the same idempotency_key returns the same clip, never a second one. This is PAID generation and needs the key holder to be a workspace admin: on a member's own key it starts in one call; on a key with no member behind it the first call describes the clip, charges nothing and returns a confirmation id, and the second, carrying that id back, is what starts it. Not for drawing the whole storyboard — that is videos.draw_storyboard.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with workspace_ambiguous and lists the choices — offer them, never pick one.

post/api/v1/tools/videos.generate_clip

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/videos.generate_clip
  • Auth: HTTP bearer

Headers

x-request-idstring

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Idempotency-Keystring

Your key for this write: send the same key when you retry and the first result comes back instead of a second action. Keys are honoured for at least 24 hours. 1–200 visible ASCII characters. Replaces the idempotency_key body field, which still works until 2026-12-31.

Request body

video_idstring uuid required

The video's id, as given in this conversation.

scene_idstring required

The scene's id, as given in the storyboard.

showsstring required

What the clip should show, in the scene's own words.

secondsinteger

How long the clip runs inside the scene.

confirmation_idstring uuid

Only when a first call answered confirmation_required: send that id back, unchanged, to run the recorded request. On your own member key the first call already runs, and there is no id.

idempotency_keystring

Deprecated on REST: send the Idempotency-Key header instead. Still accepted until 2026-12-31; if both are sent they must match.

workspacestring

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

OR

Changes

No recorded changes to this operation across all 7 revisions of this API.