API reference · Account
Keep a character
POST/api/studio/charactersSigned in session
A name and one to eight stored pictures (uploads, or stills the studio made). A loose upload of the account's own becomes the character's; any other picture is kept again on the same bytes, so its take keeps its own file. A character's pictures are never swept with loose files or taken with a project. Another account's picture is a 404, one that is not a ready picture 400, past 50 characters 409 too_many_characters. A 404 with code storage_off while stored media is switched off (ANTIMATTER_STUDIO_STORAGE). The signed in account; same origin for a write.
Request body
application/json, required
| Field | Type | What it is |
|---|---|---|
| namerequired | string | At most 80 characters. |
| picturesrequired | array of string |
Example
{
"name": "string",
"pictures": [
"string"
]
}Answer 201
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
- 400OpenAI shaped error.
- 401OpenAI shaped error.
- 403OpenAI shaped error.
- 404OpenAI shaped error.
- 409OpenAI 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.