Antimatter

PATCH/api/studio/characters/{id}Signed in session

A new name, a new list of pictures, or both. A picture left out of the list is deleted with its stored file. The signed in account; same origin for a write.

Parameters

Path and query parameters
Field	Type	What it is
id (path)required	string	The character's id, sch_ followed by hex.

Request body

application/json, required

Request body fields
Field	Type	What it is
name	string	At most 80 characters.
pictures	array of string

Example

{
  "name": "string",
  "pictures": [
    "string"
  ]
}

Answer 200

The character as it is now.

Fields of the 200 answer
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[].asset_id	string
pictures[].content_url	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[].angle	string	One of "front", "three_quarter", "profile", "back".
sheet[].status	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[].picture	object or null
sheet[].picture.asset_id	string
sheet[].picture.content_url	string
sheet[].model	string	The still model of the newest try.
sheet[].job_id	string or null	The newest try's still job.
sheet[].error	string or null
sheet[].updated_at	integer
created_atrequired	integer
updated_atrequired	integer

Errors

400OpenAI shaped error.
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.