For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList agents
      • POSTCreate agent
      • POSTFetch external agent card
      • GETGet agent details
      • PUTUpdate agent
      • DELDelete agent
      • STREAMResolve a pending agent tool approval
      • POSTAdd capability to agent
      • DELRemove capability from agent
      • STREAMExecute agent
      • GETList agent executions
      • GETGet execution detail
      • GETList tool calls
      • GETGet tool call detail
      • GETExport agent for runtime
      • POSTPublish agent
      • POSTRefresh cached agent card
      • STREAMResume a paused agent execution
      • POSTExecute agent voice (text-to-speech)
Dashboard
LogoLogo
Runtype APIAgents

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  "config": {
19    "maxResponseTokens": 1500,
20    "temperature": 0.7,
21    "language": "en"
22  },
23  "createdAt": "2024-05-01T08:00:00Z",
24  "description": "Customer support chatbot agent for handling user queries",
25  "externalConfig": {
26    "apiEndpoint": "https://externalapi.example.com/v1/process",
27    "authToken": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
28  },
29  "healthStatus": "healthy",
30  "icon": "https://runtype.com/assets/icons/chatbot-icon.png",
31  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
32  "lastHealthCheckAt": "2024-06-01T12:00:00Z",
33  "name": "SupportBot Alpha",
34  "organizationId": "org-7890mnop",
35  "primaryFlow": {
36    "id": "flow-1234abcd",
37    "name": "Main Conversation Flow"
38  },
39  "primaryFlowId": "flow-1234abcd",
40  "publishedVersionId": "v1.2.3",
41  "status": "active",
42  "updatedAt": "2024-05-25T09:30:00Z",
43  "userId": "user-4567qrst",
44  "dashboardUrl": "https://dashboard.runtype.com/agents/a1b2c3d4-e5f6-7890-ab12-cd34ef567890"
45}
Get an agent by ID including its capabilities and configuration.
Was this page helpful?
Previous

Update agent

Next
Built with

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
createdAtstring
descriptionstring or null
externalConfigmap from strings to any or null
healthStatusstring or null
iconstring or null
idstring
lastHealthCheckAtstring 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