Tool Router

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

Changed on

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

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/tool_router/session/{session_id}/tools
  • Auth
    API key in header x-api-key

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

    • info

      api operation id getV3_1ToolRouterSessionBySessionIdTools removed and replaced with getToolRouterSessionBySessionIdTools

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /// to the response with the status