API reference · API
The account's Nova Studio projects
GET/v1/studio/projectsAPI key
Newest first, without their documents. doc_id finds the one kept for an editor document. 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 |
|---|---|---|
| limit (query) | integer | |
| after (query) | string | The last_id of the previous page. |
| doc_id (query) | string |
Answer 200
The projects.
| Field | Type | What it is |
|---|---|---|
| object | string | One of "list". |
| data | array of object | |
| data[] | string | |
| data[] | string | One of "studio.project". |
| data[] | string | The document's own id (Project.id), unique per owner. |
| data[] | string | |
| data[] | string | One of "16:9", "9:16", "1:1". |
| data[] | integer | Moves on by one with every write; a write names the version it read. |
| data[] | integer | |
| data[] | integer or null | |
| data[] | integer | |
| data[] | integer | |
| 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.