API ReferenceTools

Get tool by slugv3.1

GET
/api/v3.1/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

x-api-key<token>

Project API key authentication

In: header

Path Parameters

tool_slugstringRequired

The unique slug identifier of the tool

Query Parameters

versionstring

Optional version of the tool to retrieve

toolkit_versionsnull | string | object

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://example.com/api/v3.1/tools/string?toolkit_versions=latest"
{  "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"    }  }}
Edit this page on GitHub