Skip to main content
POST
/
v1
/
installable-agents
/
{slug}
/
install
Install an installable agent into a sandbox+workspace
curl --request POST \
  --url https://api.runtools.ai/v1/installable-agents/{slug}/install \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sandboxId": "<string>",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ref": "<string>",
  "repoUrl": "<string>",
  "displayName": "<string>",
  "avatarSeed": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "installedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sandboxId": "<string>",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agentSlug": "<string>",
    "displayName": "<string>",
    "repoUrl": "<string>",
    "requestedRef": "<string>",
    "resolvedRef": "<string>",
    "installPath": "<string>",
    "statePath": "<string>",
    "commandName": "<string>",
    "status": "installing",
    "errorMessage": "<string>",
    "metadataJson": {},
    "installedAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "sandboxName": "<string>",
    "workspaceName": "<string>",
    "sandboxStatus": "<string>",
    "ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ownerDisplayName": "<string>",
    "ownerEmail": "<string>"
  }
}

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.

Authorizations

​
Authorization
string
header
required

WorkOS session token or RunTools API key (rt_live_* / rt_test_*). Used in Authorization: Bearer <token> header.

Path Parameters

​
slug
string
required

Body

application/json
​
sandboxId
string
required
​
workspaceId
string<uuid>
required
​
ref
string

Branch, tag, or commit. Defaults to catalog defaultRef.

​
repoUrl
string

Optional public GitHub repository URL override.

​
displayName
string
​
avatarSeed
string

Response

202 - application/json

Install accepted; track via GET /installs.

​
data
object