Get Agent Widget
Widget
The website widget
The embeddable chat and voice widget on an agent.
Get Agent Widget
Every agent has exactly one widget, prepared for you on first read — so this never 404s and there
is nothing to create. There is nothing to delete either: you configure the one it has.
The public key is what your website embeds, and it is shown once, when the key is
rotated — never on a read.
Singular, with no id in the path. This used to be a list at
/widgets plus a read at
/widgets/{widget_id}. Since an agent only ever has one, the id was a value you had to fetch
before you could use any of the other routes, and could only ever be that one value. It is
still on the body — useful in logs, and for telling one rotation from another.public_key_prefix is the
safe-to-log half, for identifying which key a page is currently using.
allowed_origins is the security boundary: the widget only runs on the sites you list.Authorizations
Your API key as a Bearer token, e.g. Authorization: Bearer vk_….
Path Parameters
The agent's id, as GET /v1/agents returns it.