API reference

API reference · API

The account's characters

GET/v1/studio/charactersAPI key

Newest first, 50 at most. A 404 with code storage_off while stored media is switched off (ANTIMATTER_STUDIO_STORAGE). 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.

Answer 200

The characters.

Fields of the 200 answer
FieldTypeWhat it is
objectstring
dataarray of object
data[].idrequiredstring
data[].objectrequiredstringOne of "studio.character".
data[].namerequiredstring
data[].picturesrequiredarray of objectThe stored pictures in the order a shot sends them as references, the first the one a model that takes a single picture gets.
data[].pictures[].asset_idstring
data[].pictures[].content_urlstringThe stored file door the asking door serves: /api/studio/assets/{id}/content for the session, /v1/studio/assets/{id}/content for a key.
data[].sheetarray of objectThe 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.
data[].sheet[].anglestringOne of "front", "three_quarter", "profile", "back".
data[].sheet[].statusstringkept: 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".
data[].sheet[].pictureobject or null
data[].sheet[].picture.asset_idstring
data[].sheet[].picture.content_urlstring
data[].sheet[].modelstringThe still model of the newest try.
data[].sheet[].job_idstring or nullThe newest try's still job.
data[].sheet[].errorstring or null
data[].sheet[].updated_atinteger
data[].created_atrequiredinteger
data[].updated_atrequiredinteger

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.

Antimatter