Antimatter

PUT/api/studio/brand-kitSigned in session

Replaces the kit whole. Free. Same origin only.

Request body

application/json, required

Request body fields
Field	Type	What it is
namerequired	string	At most 60 characters.
coloursrequired	object
colours.textrequired	string
colours.accentrequired	string
colours.groundrequired	string
fontrequired	string	One of "display", "body", "serif", "mono", "rounded".
cornerrequired	string	One of "top-start", "top-end", "bottom-start", "bottom-end".
logoScalerequired	number	The logo's width against the frame's shorter side. From 0.08 to 0.3.
endCardrequired	object
endCard.onrequired	boolean
endCard.wordsrequired	string	At most 80 characters.
endCard.secondsrequired	number	One of 2, 3, 4, 5.
onrequired	boolean	Put on every export unless switched off for one.

Example

{
  "name": "string",
  "colours": {
    "text": "string",
    "accent": "string",
    "ground": "string"
  },
  "font": "display",
  "corner": "top-start",
  "logoScale": 0.08,
  "endCard": {
    "on": false,
    "words": "string",
    "seconds": 2
  },
  "on": false
}

Answer 200

The kit as kept.

Fields of the 200 answer
Field	Type	What it is
object	string	One of "studio.brand_kit".
kit	object
kit.namerequired	string	At most 60 characters.
kit.coloursrequired	object
kit.colours.textrequired	string
kit.colours.accentrequired	string
kit.colours.groundrequired	string
kit.fontrequired	string	One of "display", "body", "serif", "mono", "rounded".
kit.cornerrequired	string	One of "top-start", "top-end", "bottom-start", "bottom-end".
kit.logoScalerequired	number	The logo's width against the frame's shorter side. From 0.08 to 0.3.
kit.endCardrequired	object
kit.endCard.onrequired	boolean
kit.endCard.wordsrequired	string	At most 80 characters.
kit.endCard.secondsrequired	number	One of 2, 3, 4, 5.
kit.onrequired	boolean	Put on every export unless switched off for one.
saved	boolean	False: the house's start, nothing kept yet.
logo	string or null	The logo's address, versioned by its bytes.
updated_at	integer or null

Errors

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