configure_share
Configure this share — its name and its appearance — fields you don't pass stay as they are (server-side partial merge).
- `label`: the name at the top of the chat page, and the browser tab's title. **Renaming a
share is this call**; you never need to create a replacement and delete the old one. That
would mint a new token, so the link already embedded in the client's site would stop working
— the visible name and the address are not the same thing.
- `theme_color`: the brand colour, `#RGB` or `#RRGGBB`. **This one colour is all you give** —
its foregrounds are derived on save.
- `highlight_color`: **only if the brand actually has a second colour.** Most don't; leave it
out and nothing changes anywhere. When set, it is used where something should be visible
without competing with the primary action: the second series in a chart, and citation
markers. Buttons, the current storyline step and user bubbles stay on `theme_color` — two
colours fighting over the same element is how a two-colour palette goes wrong. Foregrounds
are derived from it the same way.
Text/foreground colours are derived server-side to WCAG contrast and stored (a light brand
colour automatically gets dark text instead of white) — **do not compute a palette yourself
and do not try to set text colours**; they would be overridden.
- `logo_url`: absolute URL. The header scales by height, any aspect ratio fits; **the collapsed
launcher bubble is square**, so only near-square images (aspect 0.74–1.35) are used on the
bubble — a wide wordmark falls back to the platform icon there. Want your mark in both
places? Provide a square variant too.
- `input_mode`: `text` (text box, default) or `voice` (opens in push-to-talk). Requires the
platform's voice backend.
- `launcher`: hover tooltip text for the bubble. `theme`: `light` / `dark` / empty = follow the
visitor.
- `custom_css`: the escape hatch for strict brand guidelines — the injected stylesheet can
override our CSS variables (`--acc` / `--acc-fg` / `--acc-text-l` / `--acc-text-d` / `--bg` /
`--surface` / `--text` / `--border`); write light values under `:root{…}` and dark under
`html[data-theme="dark"]{…}`. **Prefer theme_color**: it carries a readability guarantee,
with custom_css the contrast is on you.
Get the token from `list_shares` first. Full examples in the Cookbook's configure-branding.Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | ||
| theme | No | ||
| token | Yes | ||
| launcher | No | ||
| logo_url | No | ||
| agent_name | Yes | ||
| custom_css | No | ||
| input_mode | No | ||
| theme_color | No | ||
| highlight_color | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |