Skip to main content
POST
Call jobs.read

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

Body

application/json
job_id
string
required

The job_id a long-running call answered (for example videos.generate_clip).

Minimum string length: 1
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
job_id
string
required
status
enum<string>
required

queued — accepted, not started; running — under way; succeeded — done, read result; failed — it stopped, see error_code.

Available options:
queued,
running,
succeeded,
failed
created_at
string
required

When the job was asked for (ISO 8601).

started_at
string | null
required

When it started running, or null before it has.

completed_at
string | null
required

When it finished, or null while it has not.

result
object | null
required

Once succeeded: what to read next — the clip made, or the video the run wrote. Null until then.

error_code
string | null
required

Once failed: a stable code for why. Null otherwise.

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.