API ReferenceTools

Get tool by slug

Markdown
GET
/api/v3/tools/{tool_slug}

Retrieve detailed information about a specific tool using its slug identifier. This endpoint returns full metadata about a tool including input/output parameters, versions, and toolkit information.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

Path Parameters

tool_slug*string

The unique slug identifier of the tool

Query Parameters

version?string

Optional version of the tool to retrieve

toolkit_versions?null|string|

Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://backend.composio.dev/api/v3/tools/string?toolkit_versions=latest"
{
  "slug": "github-actions",
  "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"
  ],
  "tags": [
    "ci-cd",
    "github",
    "automation",
    "devops"
  ],
  "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"
    }
  }
}
{
  "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"
    ]
  }
}