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
      • POSTRefresh cached agent card
      • GETGet agent details
      • PUTUpdate agent
      • DELDelete agent
      • GETExport agent for runtime
      • GETList agent executions
      • GETGet execution detail
      • GETList tool calls
      • GETGet tool call detail
      • POSTPublish agent
      • POSTAdd capability to agent
      • DELRemove capability from agent
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: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3  "userId": "user-9876543210",
4  "organizationId": "org-1234567890",
5  "name": "Customer Support AI Agent",
6  "description": "An AI agent specialized in handling customer support queries and automating responses.",
7  "icon": "https://runtype.com/assets/icons/support-agent.png",
8  "primaryFlowId": "flow-1122334455",
9  "agentType": "support-bot",
10  "config": {
11    "language": "en-US",
12    "responseTimeout": 30,
13    "maxConcurrentSessions": 5
14  },
15  "externalConfig": {
16    "integration": "Zendesk",
17    "apiKey": "sk_live_1234567890abcdef"
18  },
19  "claudeManagedConfig": {
20    "model": "claude-v1",
21    "temperature": 0.7
22  },
23  "healthStatus": "healthy",
24  "lastHealthCheckAt": "2024-06-10T12:45:00Z",
25  "publishedVersionId": "v1.3.0",
26  "status": "active",
27  "createdAt": "2023-11-01T09:00:00Z",
28  "updatedAt": "2024-06-10T11:30:00Z",
29  "primaryFlow": {
30    "id": "flow-1122334455",
31    "name": "Main Support Conversation Flow"
32  },
33  "capabilities": [
34    {
35      "id": "cap-0011223344",
36      "flowId": "flow-1122334455",
37      "subAgentId": null,
38      "toolId": "tool-9988776655",
39      "toolName": "FAQ Lookup",
40      "toolDescription": "Provides answers from the frequently asked questions database.",
41      "enabled": true,
42      "displayOrder": 1,
43      "agentId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
44      "parametersSchema": null,
45      "createdAt": "2023-11-01T09:05:00Z"
46    }
47  ],
48  "dashboardUrl": "https://dashboard.runtype.com/agents/a1b2c3d4-e5f6-7890-ab12-cd34ef567890"
49}
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
idstring
userIdstring
organizationIdstring or null
namestring
descriptionstring or null
iconstring or null
primaryFlowIdstring or null
agentTypestring
configmap from strings to any or null
externalConfigmap from strings to any or null
claudeManagedConfigmap from strings to any or null
healthStatusstring or null
lastHealthCheckAtstring or null
publishedVersionIdstring or null
statusstring
createdAtstring
updatedAtstring
primaryFlowobject or null
capabilitieslist of objects
dashboardUrlstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error