Create a new widget
Creates a widget bound to an agent. The widget’s DNS label and hostname are generated by the server and returned in info. The hostname may take up to a minute to become reachable while the edge propagates.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID.
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
Body
Create widget request.
CreateResourceMetadata contains the user-provided fields for creating a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id, created_at) are excluded since they are set by the server.
WidgetSpec is the user-provided configuration for a widget.
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.