List widgets
Every widget in a workspace, with its hostname and agent binding. Filter by agent to find what serves it.
state, the agent binding in spec, and (with includeInfo) the hostname and agent name in info.
Filtering
agentId narrows the list to widgets bound to one agent, in either the canonical agent_… form or the external_id:<value> form. labels and sortOrder behave as they do on every list endpoint, and limit sets a page size the SDK iterator pages past on its own.
includeInfo costs rate limit
info carries dnsLabel, host, the bound agent’s name, and createdBy. Populating it counts more against your rate limit, so ask for it when you display the list, not when you poll it.
Related
Create a widget
Get a widget
wgt_… id or external ID.List widget sessions
Archive a widget
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID.
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
Query Parameters
Maximum number of results to return.
Pagination cursor from previous response.
Filter to widgets bound to a specific agent. Accepts the canonical
agent_… form or the external_id:<value> form.
"agent_01HXKD2E5NQM3T9AYWCFMGWT9Y"
Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).
Sort order for results (asc or desc by creation time).
When true, the info field on each returned widget is populated.
Requests with this flag count more against your rate limit.