API reference · API
A stored file's record
GET/v1/studio/assets/{id}API key
A 404 with code storage_off while stored media is switched off (ANTIMATTER_STUDIO_STORAGE). 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 stored file's id, sa_ followed by hex. |
Answer 200
The record.
| Field | Type | What it is |
|---|---|---|
| id | string | |
| object | string | One of "studio.asset". |
| kind | string | One of "picture", "audio", "clip". |
| source | string | One of "upload", "job". |
| status | string | One of "ready", "awaiting", "failed". |
| project_id | string or null | |
| job_id | string or null | |
| doc_asset_id | string or null | The editor Asset this file stands for. |
| name | string or null | |
| content_type | string or null | |
| bytes | integer | |
| sha256 | string or null | |
| error | string or null | |
| created_at | integer | |
| updated_at | integer |
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.