API reference

API reference · Account

Make a character's sheet

POST/api/studio/characters/{id}/sheetSigned in session

The same figure from the front, three quarters, the side and the back, each a still job on the named still model with the character's own pictures as its reference. The whole quote is held first, so a sheet is paid for whole or not started; each side's job draws its own hold from it and what no side drew is let go. Each still lands among the character's pictures when it is made, in the place of the side's earlier picture; the character's GET says how each side stands under sheet. A side a provider refuses is named in unmade and the others go on. Paid from a balance, never the free allowance (402). 409 side_making while a side named is being made, sheet_room when the sides would not fit among the character's eight pictures. A 404 with code storage_off while stored media is switched off (ANTIMATTER_STUDIO_STORAGE). The signed in account; same origin for a write.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe character's id, sch_ followed by hex.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
modelrequiredstringA still model GET /api/studio/models lists under `still` with `references`: one that keeps a face from a picture.
anglesarray of stringThe sides to make; all four when left out.

Example

{
  "model": "antimatter/auto",
  "angles": [
    "front"
  ]
}

Answer 200

The sides started, those that could not be, and the character.

Fields of the 200 answer
FieldTypeWhat it is
objectstringOne of "studio.character.sheet".
madearray of string
unmadearray of object
unmade[].anglestringOne of "front", "three_quarter", "profile", "back".
unmade[].typestring
unmade[].messagestring
characterobject
character.idrequiredstring
character.objectrequiredstringOne of "studio.character".
character.namerequiredstring
character.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.
character.pictures[].asset_idstring
character.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.
character.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.
character.sheet[].anglestringOne of "front", "three_quarter", "profile", "back".
character.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".
character.sheet[].pictureobject or null
character.sheet[].picture.asset_idstring
character.sheet[].picture.content_urlstring
character.sheet[].modelstringThe still model of the newest try.
character.sheet[].job_idstring or nullThe newest try's still job.
character.sheet[].errorstring or null
character.sheet[].updated_atinteger
character.created_atrequiredinteger
character.updated_atrequiredinteger

Errors

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

Antimatter