Get tool by slug

1 curl https://backend.composio.dev/api/v3/tools/tool_slug \ 2 -H "x-api-key: <apiKey>"

1 { 2 "slug": "github-actions", 3 "name": "GitHub Actions", 4 "description": "Automate GitHub workflows including CI/CD, issue management, and release processes", 5 "toolkit": { 6 "slug": "github", 7 "name": "GitHub", 8 "logo": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png" 9 }, 10 "input_parameters": { 11 "repo_name": { 12 "type": "string", 13 "description": "GitHub repository name in owner/repo format", 14 "required": true, 15 "example": "octocat/Hello-World" 16 }, 17 "workflow_id": { 18 "type": "string", 19 "description": "ID or filename of the workflow to trigger", 20 "required": true, 21 "example": "main.yml" 22 } 23 }, 24 "no_auth": false, 25 "available_versions": [ 26 "0_1", 27 "latest", 28 "latest:base" 29 ], 30 "version": "latest", 31 "output_parameters": { 32 "run_id": { 33 "type": "number", 34 "description": "ID of the workflow run that was triggered", 35 "example": 12345678 36 }, 37 "status": { 38 "type": "string", 39 "description": "Status of the workflow run", 40 "example": "completed", 41 "enum": [ 42 "queued", 43 "in_progress", 44 "completed", 45 "failed" 46 ] 47 } 48 }, 49 "scopes": [ 50 "https://www.googleapis.com/auth/gmail.modify" 51 ], 52 "tags": [ 53 "ci-cd", 54 "github", 55 "automation", 56 "devops" 57 ], 58 "deprecated": { 59 "displayName": "GitHub Actions", 60 "version": "0_1", 61 "available_versions": [ 62 "0_1", 63 "latest", 64 "latest:base" 65 ], 66 "is_deprecated": false, 67 "toolkit": { 68 "logo": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png" 69 } 70 } 71 }

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.

Path parameters

tool_slugstringRequired

The unique slug identifier of the tool

Response

Successfully retrieved tool details

slugstring

Unique identifier for the tool

namestring

Human-readable display name of the tool

descriptionstring

Detailed explanation of the tool's functionality and purpose

toolkitobject

input_parametersmap from strings to any

Schema definition of required input parameters for the tool

no_authboolean

Indicates if the tool can be used without authentication

available_versionslist of strings

List of all available versions for this tool

versionstring

Current version of the tool

output_parametersmap from strings to any

Schema definition of return values from the tool

scopeslist of strings

List of scopes associated with the tool

tagslist of strings

List of tags associated with the tool for categorization and filtering

deprecatedobject

Path parameters

Headers

Response

Errors