agent-swarm.devagent-swarm.dev

Runtime pools

Runtime pools API endpoints

PUT/api/agents/{id}/runtime-pool

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:3013/api/agents/string/runtime-pool" \  -H "Content-Type: application/json" \  -d '{    "poolId": "string"  }'
{
  "agent": {
    "id": "string",
    "name": "string",
    "isLead": false,
    "status": "idle",
    "runtimePoolId": "string",
    "runtimeProvisionAttempts": 0,
    "runtimeProvisionRetryAt": "string",
    "description": "string",
    "role": "string",
    "capabilities": [],
    "claudeMd": "string",
    "soulMd": "string",
    "identityMd": "string",
    "setupScript": "string",
    "toolsMd": "string",
    "heartbeatMd": "string",
    "maxTasks": 1,
    "emptyPollCount": 0,
    "lastActivityAt": "2019-08-24T14:15:22Z",
    "provider": "claude",
    "harnessProvider": "claude",
    "credentialMissing": [
      "string"
    ],
    "credStatus": {
      "ready": true,
      "missing": [],
      "satisfiedBy": "env",
      "hint": null,
      "liveTest": null,
      "latestModel": null,
      "reportedAt": 0,
      "reportKind": "boot",
      "bedrock": null,
      "acp": null
    },
    "avatar": {
      "type": "lucide",
      "icon": "string",
      "color": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "lastUpdatedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET/api/controllers/connect

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/controllers/connect"
Empty
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET/api/runtime-controllers

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/runtime-controllers"
{
  "controllers": [
    {
      "name": "string",
      "kind": "static",
      "placement": "builtin",
      "config": {},
      "id": "string",
      "secretConfigKeys": [
        "string"
      ],
      "secretConfigError": true,
      "status": "online",
      "lastSeenAt": "string",
      "lastError": "string",
      "lastErrorAt": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST/api/runtime-controllers

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/runtime-controllers" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "kind": "static"  }'
{
  "controller": {
    "name": "string",
    "kind": "static",
    "placement": "builtin",
    "config": {},
    "id": "string",
    "secretConfigKeys": [
      "string"
    ],
    "secretConfigError": true,
    "status": "online",
    "lastSeenAt": "string",
    "lastError": "string",
    "lastErrorAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
DELETE/api/runtime-controllers/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:3013/api/runtime-controllers/string"
{
  "deleted": true
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET/api/runtime-controllers/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/runtime-controllers/string"
{
  "controller": {
    "name": "string",
    "kind": "static",
    "placement": "builtin",
    "config": {},
    "id": "string",
    "secretConfigKeys": [
      "string"
    ],
    "secretConfigError": true,
    "status": "online",
    "lastSeenAt": "string",
    "lastError": "string",
    "lastErrorAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PATCH/api/runtime-controllers/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:3013/api/runtime-controllers/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "controller": {
    "name": "string",
    "kind": "static",
    "placement": "builtin",
    "config": {},
    "id": "string",
    "secretConfigKeys": [
      "string"
    ],
    "secretConfigError": true,
    "status": "online",
    "lastSeenAt": "string",
    "lastError": "string",
    "lastErrorAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST/api/runtime-controllers/{id}/token

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/runtime-controllers/string/token"
{
  "tokenId": "string",
  "plaintext": "string",
  "expiresAt": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET/api/runtime-pools

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/runtime-pools"
{
  "pools": [
    {
      "name": "string",
      "kind": "static",
      "placements": [
        "string"
      ],
      "image": "string",
      "lifecycle": "idle",
      "idleMinutes": null,
      "slotsPerRuntime": 1,
      "maxRuntimes": null,
      "minRuntimes": 0,
      "delivery": "poll",
      "env": {},
      "resources": null,
      "ttlSec": null,
      "enabled": true,
      "id": "string",
      "resolvedImage": "string",
      "consecutiveFailures": 0,
      "circuitOpenUntil": "string",
      "lastError": "string",
      "lastErrorAt": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST/api/runtime-pools

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/runtime-pools" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "kind": "static",    "placements": [      "string"    ]  }'
{
  "pool": {
    "name": "string",
    "kind": "static",
    "placements": [
      "string"
    ],
    "image": "string",
    "lifecycle": "idle",
    "idleMinutes": null,
    "slotsPerRuntime": 1,
    "maxRuntimes": null,
    "minRuntimes": 0,
    "delivery": "poll",
    "env": {},
    "resources": null,
    "ttlSec": null,
    "enabled": true,
    "id": "string",
    "resolvedImage": "string",
    "consecutiveFailures": 0,
    "circuitOpenUntil": "string",
    "lastError": "string",
    "lastErrorAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  },
  "warning": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
DELETE/api/runtime-pools/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Query Parameters

force?string
Value in"true" | "false"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:3013/api/runtime-pools/string"
{
  "deleted": true
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET/api/runtime-pools/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/runtime-pools/string"
{
  "pool": {
    "name": "string",
    "kind": "static",
    "placements": [
      "string"
    ],
    "image": "string",
    "lifecycle": "idle",
    "idleMinutes": null,
    "slotsPerRuntime": 1,
    "maxRuntimes": null,
    "minRuntimes": 0,
    "delivery": "poll",
    "env": {},
    "resources": null,
    "ttlSec": null,
    "enabled": true,
    "id": "string",
    "resolvedImage": "string",
    "consecutiveFailures": 0,
    "circuitOpenUntil": "string",
    "lastError": "string",
    "lastErrorAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PATCH/api/runtime-pools/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:3013/api/runtime-pools/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "pool": {
    "name": "string",
    "kind": "static",
    "placements": [
      "string"
    ],
    "image": "string",
    "lifecycle": "idle",
    "idleMinutes": null,
    "slotsPerRuntime": 1,
    "maxRuntimes": null,
    "minRuntimes": 0,
    "delivery": "poll",
    "env": {},
    "resources": null,
    "ttlSec": null,
    "enabled": true,
    "id": "string",
    "resolvedImage": "string",
    "consecutiveFailures": 0,
    "circuitOpenUntil": "string",
    "lastError": "string",
    "lastErrorAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST/api/runtime-pools/{id}/agents

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/runtime-pools/string/agents" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "agent": {
    "id": "string",
    "name": "string",
    "isLead": false,
    "status": "idle",
    "runtimePoolId": "string",
    "runtimeProvisionAttempts": 0,
    "runtimeProvisionRetryAt": "string",
    "description": "string",
    "role": "string",
    "capabilities": [],
    "claudeMd": "string",
    "soulMd": "string",
    "identityMd": "string",
    "setupScript": "string",
    "toolsMd": "string",
    "heartbeatMd": "string",
    "maxTasks": 1,
    "emptyPollCount": 0,
    "lastActivityAt": "2019-08-24T14:15:22Z",
    "provider": "claude",
    "harnessProvider": "claude",
    "credentialMissing": [
      "string"
    ],
    "credStatus": {
      "ready": true,
      "missing": [],
      "satisfiedBy": "env",
      "hint": null,
      "liveTest": null,
      "latestModel": null,
      "reportedAt": 0,
      "reportKind": "boot",
      "bedrock": null,
      "acp": null
    },
    "avatar": {
      "type": "lucide",
      "icon": "string",
      "color": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "lastUpdatedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET/api/runtime-pools/{id}/runtimes

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/runtime-pools/string/runtimes"
{
  "runtimes": [
    {
      "id": "string",
      "agentId": "string",
      "status": "active",
      "poolId": "string",
      "controllerId": "string",
      "externalHandle": {
        "property1": null,
        "property2": null
      },
      "provisionAttempts": 0,
      "provisionError": "string",
      "provisionRequestedAt": "string",
      "draining": true,
      "idleSince": "string",
      "leaseExpiresAt": "string",
      "taskId": "string",
      "reportedSlots": 0,
      "credentialReady": true,
      "metadata": {
        "property1": null,
        "property2": null
      },
      "lastSeenAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}

Rooms

Rooms API endpoints

Schedules

Create and manage scheduled tasks — run agents on cron expressions or one-time delays