API reference · API
A project's progress
GET/v1/studio/projects/{id}/eventsAPI key
A JSON page after ?after= (limit up to 500), or with Accept: text/event-stream (or ?stream=true) Server-Sent Events, each with id: the event's id and event: its type, resumed after the larger of ?after and Last-Event-ID and closed after about 270 seconds; reconnect to resume. Types: plan.created, plan.completed, plan.cancelled, shot.started, shot.completed, shot.failed, shot.cancelled, asset.stored. An API key with the read scope. 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 project's id, stp_ followed by hex. |
| after (query) | string | |
| limit (query) | integer | |
| stream (query) | string |
Answer 200
The events.
| Field | Type | What it is |
|---|---|---|
| object | string | One of "list". |
| data | array of object | |
| data[] | string | One of "studio.event". |
| data[] | integer | The stream's event id; resume with Last-Event-ID. |
| data[] | string | One of "plan.created", "plan.completed", "plan.cancelled", "shot.started", "shot.completed", "shot.failed", "shot.cancelled", "asset.stored". |
| data[] | integer | |
| data[] | object | |
| has_more | boolean | |
| last_id | string 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.
Request headers it reads (1)
| Field | Type | What it is |
|---|---|---|
| Last-Event-ID | string |