curl -X POST https://tools.runtools.ai/v1/tools/github/install \
-H "X-API-Key: $RUNTOOLS_API_KEY"
const installed = await rt.tools.install('github');
{
"data": {
"slug": "github",
"installed": true,
"credentialsRequired": true,
"credentialMode": "oauth",
"requiredCredentialFields": []
}
}
Tools
Install Tool
Install a Tool Hub tool into your organization
POST
/
v1
/
tools
/
{slug}
/
install
curl -X POST https://tools.runtools.ai/v1/tools/github/install \
-H "X-API-Key: $RUNTOOLS_API_KEY"
const installed = await rt.tools.install('github');
{
"data": {
"slug": "github",
"installed": true,
"credentialsRequired": true,
"credentialMode": "oauth",
"requiredCredentialFields": []
}
}
Tool install endpoints use:
https://tools.runtools.ai/v1
Path Parameters
string
required
Tool slug, such as
github, gmail, or slack.Response
string
Tool slug.
boolean
Whether the tool is installed.
boolean
Whether the tool requires OAuth, stored secrets, or explicit credentials.
string
oauth, secret, none, or a tool-specific mode.array
Required credential field names.
curl -X POST https://tools.runtools.ai/v1/tools/github/install \
-H "X-API-Key: $RUNTOOLS_API_KEY"
const installed = await rt.tools.install('github');
{
"data": {
"slug": "github",
"installed": true,
"credentialsRequired": true,
"credentialMode": "oauth",
"requiredCredentialFields": []
}
}
Credentials
OAuth-enabled tools resolve connected accounts automatically. Secret-backed tools can use stored credentials:await rt.tools.storeCredentials('my-tool', {
apiKey: process.env.MY_TOOL_API_KEY!,
});
const status = await rt.tools.credentials('my-tool');
await rt.tools.clearCredentials('my-tool');