API ReferenceTool Router

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

Markdown
GET
/api/v3.1/tool_router/session/{session_id}/tools

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

Authorization

x-api-key<token>

Project API key authentication

In: header

Path Parameters

session_idstring

Tool router session ID

Format: toolRouterSessionId

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 Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://backend.composio.dev/api/v3.1/tool_router/session/string/tools"
{
  "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,
          "examples": [
            "octocat/Hello-World"
          ]
        },
        "workflow_id": {
          "type": "string",
          "description": "ID or filename of the workflow to trigger",
          "required": true,
          "examples": [
            "main.yml"
          ]
        }
      },
      "no_auth": false,
      "available_versions": [
        "20250905_00",
        "20250906_00"
      ],
      "version": "20250905_00",
      "output_parameters": {
        "run_id": {
          "type": "number",
          "description": "ID of the workflow run that was triggered",
          "examples": [
            12345678
          ]
        },
        "status": {
          "type": "string",
          "description": "Status of the workflow run",
          "enum": [
            "queued",
            "in_progress",
            "completed",
            "failed"
          ],
          "examples": [
            "completed"
          ]
        }
      },
      "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",
      "is_deprecated": false,
      "deprecated": {
        "displayName": "GitHub Actions",
        "version": "20250905_00",
        "available_versions": [
          "20250905_00",
          "20250906_00"
        ],
        "is_deprecated": false,
        "toolkit": {
          "logo": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png"
        }
      }
    }
  ],
  "next_cursor": "string",
  "total_pages": 0,
  "current_page": 0,
  "total_items": 0
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}