Tool Router

List tools with schemas for a tool router session (v3.1)

Returns tools available in a tool router session with complete schemas. Results are paginated; use next_cursor to fetch the next page. Tools are returned in alphabetical order.

get/api/v3.1/tool_router/session/{session_id}/tools

Path parameters

session_idstring toolRouterSessionId required

Tool router session ID

Query parameters

limitinteger

Number of items per page, max allowed is 500

cursorstring

Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.

Response

Successfully retrieved paginated tools with their complete schemas.

next_cursorstring nullable

total_pagesnumber required

current_pagenumber required

total_itemsnumber required

Example response

{
  "items": [
    {
      "slug": "GITHUB_CREATE_A_WORKFLOW_DISPATCH_EVENT",
      "name": "GitHub Actions",
      "description": "Automate GitHub workflows including CI/CD, issue management, and release processes",
      "toolkit": {
        "slug": "github",
        "name": "GitHub",
        "logo": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png"
      },
      "input_parameters": {
        "repo_name": {
          "type": "string",
          "description": "GitHub repository name in owner/repo format",
          "required": true,
          "example": "octocat/Hello-World"
        },
        "workflow_id": {
          "type": "string",
          "description": "ID or filename of the workflow to trigger",
          "required": true,
          "example": "main.yml"
        }
      },
      "available_versions": [
        "20250905_00",
        "20250906_00"
      ],
      "version": "20250905_00",
      "output_parameters": {
        "run_id": {
          "type": "number",
          "description": "ID of the workflow run that was triggered",
          "example": 12345678
        },
        "status": {
          "type": "string",
          "description": "Status of the workflow run",
          "example": "completed",
          "enum": [
            "queued",
            "in_progress",
            "completed",
            "failed"
          ]
        }
      },
      "scopes": [
        "https://www.googleapis.com/auth/gmail.modify"
      ],
      "scope_requirements": {
        "all_of": [
          "read:user",
          {
            "any_of": [
              "repo",
              "public_repo"
            ]
          }
        ]
      },
      "tags": [
        "ci-cd",
        "github",
        "automation",
        "devops"
      ],
      "human_description": "Create a new issue in a GitHub repository",
      "deprecated": {
        "displayName": "GitHub Actions",
        "version": "20250905_00",
        "available_versions": [
          "20250905_00",
          "20250906_00"
        ],
        "toolkit": {
          "logo": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png"
        }
      }
    }
  ]
}

Changes

Changed in 5 of the 61 revisions of this API.318

Jul 22, 2026c039e97e7f143See the full diff
- ○
  added the optional property items/items/scope_requirements/all_of/items/anyOf[subschema #2]/any_of/items/anyOf[subschema #2]/source to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/scope_requirements/all_of/items/anyOf[subschema #2]/source to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/scope_requirements/source to the response with the 200 status
  response-optional-property-added
Jul 16, 2026b61c29327d7412See the full diff
- ▲
  the items/items/scope_requirements/all_of/items/anyOf[subschema #2]/any_of/items/ response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ○
  added the optional property items/items/scope_requirements/all_of/items/anyOf[subschema #2]/when to the response with the 200 status
  response-optional-property-added
- ○
  added subschema #1 subschema #2 to the items/items/scope_requirements/all_of/items/anyOf[subschema #2]/any_of/items/ response property anyOf list for the response status 200
  response-property-any-of-added
Jun 17, 2026589a7d115a5e2See the full diff
- ○
  the endpoint scheme security CookieAuth was removed from the API
  api-security-removed
- ○
  the endpoint scheme security UserApiKeyAuth was removed from the API
  api-security-removed
May 5, 20265a3709be76a7210See the full diff
- ▲
  removed the request body
  request-body-removed
- ▲
  the path request parameter session_id became required
  request-parameter-became-required
- ○
  added the new optional query request parameter cursor
  new-optional-request-parameter
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  removed the non-success response with the status 413
  response-non-success-status-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
- ○
  removed the non-success response with the status 502
  response-non-success-status-removed
- ○
  added the optional property next_cursor to the response with the 200 status
  response-optional-property-added
- ○
  added the required property current_page to the response with the 200 status
  response-required-property-added
- ○
  added the required property total_items to the response with the 200 status
  response-required-property-added
- ○
  added the required property total_pages to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 5, 202652c71f747c651See the full diff
- ○
  endpoint added
  endpoint-added

Full history