Skip to main content
POST
/
v1
/
tools
/
{slug}
/
install
curl -X POST https://tools.runtools.ai/v1/tools/github/install \
  -H "X-API-Key: $RUNTOOLS_API_KEY"

{
  "data": {
    "slug": "github",
    "installed": true,
    "credentialsRequired": true,
    "credentialMode": "oauth",
    "requiredCredentialFields": []
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.runtools.ai/llms.txt

Use this file to discover all available pages before exploring further.

Tool install endpoints use: 
https://tools.runtools.ai/v1

​
Path Parameters

​
slug
string
required
Tool slug, such as github, gmail, or slack.

​
Response

​
slug
string
Tool slug.
​
installed
boolean
Whether the tool is installed.
​
credentialsRequired
boolean
Whether the tool requires OAuth, stored secrets, or explicit credentials.
​
credentialMode
string
oauth, secret, none, or a tool-specific mode.
​
requiredCredentialFields
array
Required credential field names.
curl -X POST https://tools.runtools.ai/v1/tools/github/install \
  -H "X-API-Key: $RUNTOOLS_API_KEY"

{
  "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');