Create a chat widget
Creates a website chat widget with a new public key. Set the agent that answers, the exact website origins it may run on, its look and words (studio), voice and limits. Visitors see it once you publish.
Scopes: webchat:write
Authorizations
An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.
Headers
A unique key (a UUID works) for this request. Retrying with the same key returns the first answer instead of running twice.
255The API version to answer as, a date (YYYY-MM-DD). Leave it out for the current version (2026-11-07). An unknown version is refused with 400 unsupported_api_version.
2026-11-07 "2026-11-07"
Body
1 - 80The widget's look and words (the studio's document).
Response
Successful Response
The widget id.
Its name.
active or deleted.
The key in your site's snippet (public by design).
Websites allowed to load it.
The agent replies by itself.
Visitors can start a voice call.
Per-visitor and voice limits.
The saved studio's revision.
The saved studio differs from what visitors get.
Send as revision on an update.
The agent that answers.
The saved studio document (look and words).
What visitors get now; null until published.
Visitor sessions open now.
ISO 8601.
ISO 8601.