API reference

API reference · Account

The account's brand kit

GET/api/studio/brand-kitSigned in session

The kit kept on the account, or the house's start (saved false) when none was kept. The browser draws it on an export; nothing is drawn on the server.

Answer 200

The kit.

Fields of the 200 answer
FieldTypeWhat it is
objectstringOne of "studio.brand_kit".
kitobject
kit.namerequiredstringAt most 60 characters.
kit.coloursrequiredobject
kit.colours.textrequiredstring
kit.colours.accentrequiredstring
kit.colours.groundrequiredstring
kit.fontrequiredstringOne of "display", "body", "serif", "mono", "rounded".
kit.cornerrequiredstringOne of "top-start", "top-end", "bottom-start", "bottom-end".
kit.logoScalerequirednumberThe logo's width against the frame's shorter side. From 0.08 to 0.3.
kit.endCardrequiredobject
kit.endCard.onrequiredboolean
kit.endCard.wordsrequiredstringAt most 80 characters.
kit.endCard.secondsrequirednumberOne of 2, 3, 4, 5.
kit.onrequiredbooleanPut on every export unless switched off for one.
savedbooleanFalse: the house's start, nothing kept yet.
logostring or nullThe logo's address, versioned by its bytes.
updated_atinteger or null

Errors

  • 401OpenAI 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