API reference · API
One character
GET/v1/studio/characters/{id}API key
Its pictures that are still kept. An API key with the read scope, of a personal account: a team's key is refused (403 policy_violation, code team_key), as is an agent's. Rate limited per key at the key's own requests a minute, in a window of its own. A 404 while video and sound jobs are switched off.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The character's id, sch_ followed by hex. |
Answer 200
The character.
| Field | Type | What it is |
|---|---|---|
| idrequired | string | |
| objectrequired | string | One of "studio.character". |
| namerequired | string | |
| picturesrequired | array of object | The stored pictures in the order a shot sends them as references, the first the one a model that takes a single picture gets. |
| pictures[] | string | |
| pictures[] | string | The stored file door the asking door serves: /api/studio/assets/{id}/content for the session, /v1/studio/assets/{id}/content for a key. |
| sheet | array of object | The character's sheet: each side that holds or is making a picture, in the order front, three_quarter, profile, back. Absent while no side was ever asked for. |
| sheet[] | string | One of "front", "three_quarter", "profile", "back". |
| sheet[] | string | kept: the side holds `picture`, one of the character's pictures; making: a still is being made for it (`picture` is what it held before, if anything); failed: the newest try did not land, said in `error`. One of "kept", "making", "failed". |
| sheet[] | object or null | |
| sheet[] | string | |
| sheet[] | string | |
| sheet[] | string | The still model of the newest try. |
| sheet[] | string or null | The newest try's still job. |
| sheet[] | string or null | |
| sheet[] | integer | |
| created_atrequired | integer | |
| updated_atrequired | 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.