Unarchive a widget
Bring an archived widget back to STATE_ACTIVE. Same hostname, fresh sessions.
STATE_ACTIVE and its hostname serves traffic again, on the same DNS label it always had.
Sessions do not come back
Revocation is terminal. Sessions revoked by the archive staySTATE_REVOKED after unarchive; embedded widgets need new sessions from your backend before visitors can chat again. If your backend mints a session on page load, this happens on its own with the next visit.
Related
Archive a widget
Create a widget session
Get a widget
info.host.List widget sessions
?state=STATE_REVOKED shows the casualties.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
Unarchive 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.