v56

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

List tools

Lists all tools in the tool set

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

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.

Query parameters

limitinteger

Maximum number of results to return

cursorstring

Pagination cursor from previous response

prefixstring

Filter expression (query param: prefix)

querystring

Free-form search query

namesstring[]

Filter by tool name (exact match). Multiple values are OR'd together.

statesstring[]

Filter by tool state. Multiple values are OR'd together.

requiresApprovalboolean

Filter by approval requirement. Omitted = no filter; true = only tools requiring approval; false = only tools not requiring approval.

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 set to true you may use more of your alloted API rate-limit

Response

OK

Example response

{
  "items": [
    {
      "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"
          }
        }
      }
    }
  ]
}