API reference · API
Stop a render plan
POST/v1/studio/plans/{id}/cancelAPI key
Waiting shots are dropped; running ones are cancelled at their provider and cost nothing when never made, or are billed as made. With {shots: [shot ids]} only those shots stop, their share of the plan's hold given back, and the plan runs on. A 404 while video and sound jobs are switched off. An API key with the chat scope (a write or a spend). Rate limited per key at the key's own requests a minute, in a window of its own. An agent's key is refused (403 policy_violation). Every /v1/studio door is a 404 while video and sound jobs are switched off.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The plan's id, spl_ followed by hex. |
Request body
application/json, required
| Field | Type | What it is |
|---|---|---|
| shots | array of string |
Example
{
"shots": [
"string"
]
}Answer 200
The plan, cancelled.
| Field | Type | What it is |
|---|---|---|
| id | string | |
| object | string | One of "studio.plan". |
| project_id | string | |
| status | string | One of "running", "completed", "cancelled". |
| quote_micros | integer | The total the balance was checked against. |
| micros | integer | Settled shots' charges plus running shots' holds. |
| counts | object | |
| shots | array of object | |
| shots[] | string | |
| shots[] | string | One of "studio.shot". |
| shots[] | integer | |
| shots[] | string or null | |
| shots[] | string | |
| shots[] | string | One of "waiting", "starting", "running", "completed", "failed", "cancelled". |
| shots[] | integer | The quote while it waits, the job's hold while it runs, the charge once done. |
| shots[] | string or null | |
| shots[] | object or null | The shot's job, as /api/studio/jobs answers it. |
| shots[] | object or null | |
| shots[] | string | |
| shots[] | string | |
| shots[] | integer | |
| shots[] | integer or null | |
| shots[] | integer or null | |
| created_at | integer | |
| finished_at | integer or null |
Errors
- 401OpenAI shaped error.
- 403OpenAI shaped error.
- 404OpenAI shaped error.
- 429OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.