Skip to main content
POST
manage brand kit

Authorizations

Authorization
string
header
required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key
string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id
string

The workspace this one call acts in, when it is not the key's own.

Body

application/json
add_context
string

A block of written direction to add: voice, rules, what the brand does and does not do. Blocks the user wrote are theirs; add one rather than rewriting.

Maximum string length: 8000
remove_context
string

The id of a context block to remove, as the kit reads it back.

Maximum string length: 80
colors
object[]

The whole palette, replacing what is there.

Maximum array length: 24
fonts
object[]

The whole type list, replacing what is there.

Maximum array length: 12
pin
object

Pin one thing to the kit. A caption template or skill already pinned has its note refreshed instead of a second pin.

update_pin
object

Change what a pin says without pinning it again.

unpin
string

The id of a pin to remove, as the kit reads it back.

Maximum string length: 80
add_items
(string | object)[]

Library files the brand is made of, 50 a call. A bare ref links as a reference; naming a role or a name on a ref already linked corrects it in place.

Maximum array length: 50

An item ref, item id, or the job id that made it.

remove_items
string[]

Linked items that are no longer the identity.

Maximum array length: 50

An item ref, item id, or the job id that made it.

update_context
object

Rewrite one context block, by the id the kit reads back. For a block you added; a user's block is theirs to change.

kit
string

Which kit, by name or id, when the workspace holds more than one. Left out, the workspace's active kit.

Maximum string length: 80
create_kit
string

Make a new kit by this name and work in it for the rest of the call. The free plan holds one kit; the answer says so when there is no room.

Maximum string length: 80
rename_kit
string

A new name for the kit this call is on.

Maximum string length: 80
activate_kit
boolean

Make the kit this call is on the workspace's active one, the one read when no kit is named.

delete_kit
string

The word "delete", to delete the kit this call is on with its colors, fonts, context, pins and links. There is no way back and the answer says what went; the files stay in the library. Only when the user asked for it.

Allowed value: "delete"
words
object

Names this workspace spells its own way, corrected in transcripts after they come back. One word, a name or a piece of jargon, with the spellings it was heard as. Shared by every kit. A one-letter word, or a heard_as under three letters, is refused.

context
string

Optional: one sentence shown to the user beside this action.

Maximum string length: 600

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

ok
any
required
data
object
required
meta
object
required
media
object[]