API reference

API reference · Account

Price a character's sheet

POST/api/studio/characters/{id}/sheet/quoteSigned in session

What each side could cost on the named still model at most, each a still job with the character's own pictures as its reference, the total, whether the balance covers it, and how much room the character keeps for the sides among its eight pictures. Nothing is held or made. 400 not_a_sheet_model for a model that takes no reference picture, 409 no_picture for a character with none kept. 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 price, nothing held.

Fields of the 200 answer
FieldTypeWhat it is
objectstringOne of "studio.character.sheet.quote".
modelstring
anglesarray of object
angles[].anglestringOne of "front", "three_quarter", "profile", "back".
angles[].microsinteger
total_microsinteger
fundedbooleanWhether the balance covers the whole sheet now.
depositedboolean
balance_microsinteger
roomintegerPictures the character has room for once these sides land; negative when they do not fit.

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.

Antimatter