Set TFU Live agent orb colour
Sets the colours of the TFU Live agent’s orb, the round image that stands for the agent in the dashboard: default (it follows the voice), curated (derived from the agent id), a preset pair, or two custom #rrggbb colours. It changes only how the agent looks. It needs no ifVersion, makes no new revision or change history entry, and works while the agent is live. It returns the choice as GET /api/tfu-live-agents/{id} shows it in orb. Anything but one of the four shapes is refused with 422.
Required scope: agents:write.
Required API key scope: agents:write.
Authorizations
Path Parameters
Query Parameters
Body
Exactly one orb shape. Any other key, a missing or extra preset or colors, an unknown preset, or anything but two #rrggbb colours is refused.
- Option 1
- Option 2
- Option 3
- Option 4
The colours of the agent’s orb, exactly one of four shapes. default: it follows the voice, purple and pink for a female voice, blue and cyan for a male one, indigo and mint for a voice that is neither; curated: colours derived from the agent id, the same on every screen; preset: one of 17 pairs from published palettes, each the palette’s first real colour as the main colour and the next colour that differs from it as the glow; custom: two colours of your own, the orb’s own colour then its glow. Cosmetic: it changes nothing the agent says or does.
