Sign in

v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
WidgetService
Widgets

List widgets

Lists all widgets in a workspace

get/v1/workspaces/{workspaceId}/widgets

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

Query parameters

limitinteger

Maximum number of results to return.

cursorstring

Pagination cursor from previous response.

agentIdstring
Example:agent_01HXKD2E5NQM3T9AYWCFMGWT9Y

Filter to widgets bound to a specific agent. Accepts the canonical agent_… form or the external_id:<value> form.

labelsstring

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).

sortOrderstring

Sort order for results (asc or desc by creation time).

includeInfoboolean

When true, the info field on each returned widget is populated. Requests with this flag count more against your rate limit.

Response

OK

Example response

{
  "items": [
    {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      },
      "spec": {
        "agentId": "agent_01HXKD2E5NQM3T9AYWCFMGWT9Y",
        "variationId": "agentvar_01HXKD2E5NQM3T9AYWCF32BSPP"
      },
      "info": {
        "dnsLabel": "k7m2xq9fp4wn",
        "host": "k7m2xq9fp4wn.widgets.cadenya.com",
        "createdBy": {
          "metadata": {
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
          }
        }
      }
    }
  ]
}