Get agent details

GET

/v1/agents/:id

GET

/v1/agents/:id

$ curl https://api.runtype.com/v1/agents/id \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "agentType": "chatbot",
3   "capabilities": [
4     {
5       "displayOrder": 1,
6       "enabled": true,
7       "flowId": "flow-1234abcd",
8       "id": "cap-5678efgh",
9       "subAgentId": "subagent-9012ijkl",
10       "toolDescription": "Generates natural language responses based on user input",
11       "toolId": "tool-nlp-001",
12       "toolName": "Natural Language Processor",
13       "agentId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
14       "createdAt": "2024-05-20T10:15:30Z"
15     }
16   ],
17   "claudeManagedConfig": {
18     "maxTokens": 2048,
19     "temperature": 0.7
20   },
21   "config": {
22     "language": "en",
23     "timezone": "UTC"
24   },
25   "configHash": "9f86d081884c7d659a2feaa0c55ad015",
26   "createdAt": "2024-05-01T08:00:00Z",
27   "description": "Customer support chatbot agent for handling user queries",
28   "externalConfig": {
29     "integration": "Zendesk",
30     "apiVersion": "v2"
31   },
32   "healthStatus": "healthy",
33   "icon": "https://runtype.com/assets/icons/chatbot.png",
34   "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
35   "lastHealthCheckAt": "2024-06-10T12:00:00Z",
36   "lastModifiedSource": "dashboard",
37   "name": "SupportBot",
38   "organizationId": "org-7890mnop",
39   "primaryFlow": {
40     "id": "flow-1234abcd",
41     "name": "Main Support Flow"
42   },
43   "primaryFlowId": "flow-1234abcd",
44   "publishedVersionId": "ver-20240601",
45   "status": "active",
46   "updatedAt": "2024-06-10T12:05:00Z",
47   "userId": "user-4567qrst",
48   "dashboardUrl": "https://dashboard.runtype.com/agents/a1b2c3d4-e5f6-7890-ab12-cd34ef567890"
49 }

Get an agent by ID including its capabilities and configuration.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Response

Agent details with capabilities

agentTypestring

capabilitieslist of objects

claudeManagedConfigmap from strings to any or null

configmap from strings to any or null

configHashstring or null

createdAtstring

descriptionstring or null

externalConfigmap from strings to any or null

healthStatusstring or null

iconstring or null

idstring

lastHealthCheckAtstring or null

lastModifiedSourcestring or null

namestring

organizationIdstring or null

primaryFlowobject or null

primaryFlowIdstring or null

publishedVersionIdstring or null

statusstring

updatedAtstring

userIdstring

dashboardUrlstring

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error