v56

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

WidgetService

Widgets

Get a widget by ID

Retrieves a widget by ID

get/v1/workspaces/{workspaceId}/widgets/{id}

Path parameters

workspaceIdstring required

Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

idstring required

Widget ID. Accepts the canonical wgt_… form or the external_id:<value> form.

Response

state'STATE_UNSPECIFIED' | 'STATE_ACTIVE' | 'STATE_ARCHIVED' enum required

The current lifecycle state of the widget. Output only. Widgets are created STATE_ACTIVE; use the :archive and :unarchive actions to transition between states.

Example response

{
  "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"
      }
    }
  }
}