Sign in
Tools

Get tool by 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.

get/api/v3/tools/{tool_slug}

Path parameters

tool_slugstring required

The unique slug identifier of the tool

Query parameters

versionstring

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

string
OR
object

Object representation of parsed bracket notation

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 pinned version ("00000000_00").

Response

Successfully retrieved tool details

slugstring required

Unique identifier for the tool

namestring required

Human-readable display name of the tool

descriptionstring required

Detailed explanation of the tool's functionality and purpose

input_parametersobject required

Schema definition of required input parameters for the tool

no_authboolean required

Indicates if the tool can be used without authentication

available_versionsstring[] required

List of all available versions for this tool

versionstring required

Current version of the tool

output_parametersobject required

Schema definition of return values from the tool

scopesstring[] required

List of scopes associated with the tool

tagsstring[] required

List of tags associated with the tool for categorization and filtering

human_descriptionstring

Human-friendly description of the tool, if available

is_deprecatedboolean required

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

Example response

{
  "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

No recorded changes to this endpoint across all 10 revisions of this API.