Sign in

v56

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

Get a tool by ID

Retrieves a tool by ID from the workspace

get/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

toolSetIdstring required
Example:toolset_01HXKD2E5NQM3T9AYWCFNRMN74

Tool set ID. Accepts the canonical ts_… form or the external_id:<value> form.

idstring required
Example:tool_01HXKD2E5NQM3T9AYWCFWVYY9K

Tool ID. Accepts the canonical tool_… form or the external_id:<value> form.

Response

OK

state'STATE_UNSPECIFIED' | 'STATE_AVAILABLE' | 'STATE_OMITTED' | 'STATE_ARCHIVED' enum required

The current lifecycle state of the tool. Output only. Use the :omit and :restore actions to transition; tool set syncs may also update it.

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "info": {
    "toolSet": {
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
    },
    "createdBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}