Get a widget
One widget, by wgt_… id or external_id form, with the authoritative hostname in info.host.
id accepts the canonical wgt_… form or external_id:<value> if you set one at creation.
Read the hostname from info.host
info.dnsLabel is the single label; info.host is the full hostname browsers talk to. host is authoritative: read it, ship it to your frontend, and never assemble it from the label and a domain you hard-code. The domain is Cadenya’s to change.
info also carries the bound agent as a bare reference (info.agent) and the profile that created the widget (info.createdBy).
Related
Update a widget
List widget sessions
?widgetId= for this widget’s sessions.Delete a widget
Use your own IDs
external_id: form this endpoint accepts.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID.
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
Widget ID. Accepts the canonical wgt_… form or the external_id:<value> form.
Response
OK
Widget is an embeddable chat surface bound to a single agent. Each widget owns a globally unique, immutable DNS label under the widgets domain (e.g. "k7m2xq9fp4wn.widgets.cadenya.com"): one widget = one hostname = one origin allowlist = one agent binding. Browsers talk to the widget host with session bearer tokens minted server-side via WidgetSessionService.
Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
WidgetSpec is the user-provided configuration for a widget.
The current lifecycle state of the widget. Output only. Widgets are created STATE_ACTIVE; use the :archive and :unarchive actions to transition between states.
STATE_UNSPECIFIED, STATE_ACTIVE, STATE_ARCHIVED WidgetInfo provides read-only server-derived data about a widget.