Skip to main content
POST
Call videos.generate_clip

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

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.

Maximum string length: 128
Idempotency-Key
string

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.

Maximum string length: 200

Body

application/json
video_id
string<uuid>
required

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

scene_id
string
required

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

Minimum string length: 1
shows
string
required

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

Required string length: 1 - 600
seconds
integer
default:5

How long the clip runs inside the scene.

Required range: 1 <= x <= 15
confirmation_id
string<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_key
string

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

Required string length: 1 - 200
workspace
string

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.

Minimum string length: 1

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.

The tool ran and answered.

ok
boolean
required
state
enum<string>
required

started — the clip is being made; job_id is its handle and it is not ready yet; confirmation_required — a key with no member behind it asked first: nothing ran and nothing was charged.

Available options:
confirmation_required,
started
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.

video_id
string
scene_id
string
seconds
integer
marker
string
open_at
string
job_id
string

The job's handle. Read its status with jobs.read (REST: POST /api/v1/tools/jobs.read) until it says succeeded or failed.

confirmation_id
string<uuid>

Present only while confirmation is required.

expires_in_seconds
integer

How long that confirmation stays usable.

request_summary
string

Present only while confirmation is required — what will run, in one sentence, for a person to approve.