API reference

API reference · Account

Keep a logo

PUT/api/studio/brand-kit/logoSigned in session

A PNG, JPEG or WebP picture as the body, its type the Content-Type, at most 262144 bytes, checked by its first bytes. SVG is refused.

Request body

image/png, required

The document names no fields for this body.

Answer 200

The kit with its logo.

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

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