Skip to main content
GET
Get tool by slug

Authorizations

x-api-key
string
header
default:your-project-api-key
required

Your Composio project API key. Create or copy it from the Composio dashboard.

Path Parameters

tool_slug
string
required

The unique slug identifier of the tool

Query Parameters

include_pricing
boolean
default:false

Whether to include published pricing within instant, when available. Defaults to false.

version
string

Optional version of the tool to retrieve. Takes precedence over toolkit_versions; when both are omitted the tool resolves to the latest published version ("latest").

toolkit_versions

Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit. Read only when version is omitted; when neither is supplied the tool resolves to the latest published version ("latest").

Response

Successfully retrieved tool details

slug
string
required

Unique identifier for the tool

Example:

"GITHUB_CREATE_A_WORKFLOW_DISPATCH_EVENT"

name
string
required

Human-readable display name of the tool

Example:

"GitHub Actions"

description
string
required

Detailed explanation of the tool's functionality and purpose

Example:

"Automate GitHub workflows including CI/CD, issue management, and release processes"

toolkit
object
required
input_parameters
object
required

Schema definition of required input parameters for the tool

Example:
no_auth
boolean
required

Indicates if the tool can be used without authentication

Example:

false

available_versions
string[]
required

List of all available versions for this tool

Example:
version
string
required

Current version of the tool

Example:

"20250905_00"

output_parameters
object
required

Schema definition of return values from the tool

Example:
scopes
string[]
required

List of scopes associated with the tool

Example:
scope_requirements
object | null
required

Structured scope requirements for the tool. Null means the tool is legacy and only exposes flat scopes.

Example:
tags
string[]
required

List of tags associated with the tool for categorization and filtering

Example:
is_deprecated
boolean
required

Indicates if this tool is deprecated and may be removed in the future

Example:

false

deprecated
object
required
instant
object

Present only when the tool supports an Instant account and its selected toolkit version is the latest. Missing for older toolkit versions or ineligible tools.

human_description
string

Human-friendly description of the tool, if available

Example:

"Create a new issue in a GitHub repository"