Archive a widget
Take a widget offline without losing its hostname. Sessions are revoked; the label waits for unarchive.
STATE_ARCHIVED: the hostname stops serving at the edge, existing sessions are revoked, and no new sessions can be minted. Unlike delete, the DNS label stays reserved for this widget.
What archive touches
Related
Unarchive a widget
Delete a widget
Create a widget session
List widgets
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.
Body
Archive widget request.
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.