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

List agents

GET
/v1/agents
GET
/v1/agents
$curl https://api.runtype.com/v1/agents \
> -H "Authorization: <apiKey>" \
> -H "Content-Type: application/json"
1{
2 "data": [
3 {
4 "capabilityCount": 5,
5 "config": {
6 "maxConcurrentRuns": 3,
7 "retryOnFailure": true,
8 "timeoutSeconds": 120
9 },
10 "createdAt": "2024-05-10T09:15:00Z",
11 "description": "Agent for automating customer support ticket triage",
12 "icon": "🤖",
13 "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
14 "name": "Support Triage Bot",
15 "primaryFlowId": "flow-9876543210",
16 "status": "active",
17 "updatedAt": "2024-06-01T15:00:00Z",
18 "lastRunAt": "2024-06-01T14:45:30Z"
19 }
20 ],
21 "pagination": {
22 "currentOffset": 0,
23 "hasMore": true,
24 "hasPrev": false,
25 "limit": 10,
26 "nextCursor": "cursor_abc123",
27 "prevCursor": null,
28 "currentPage": 1,
29 "totalCount": 25,
30 "totalPages": 3
31 }
32}
Get all agents for the authenticated user with filtering and cursor pagination.
Was this page helpful?
Previous

Create agent

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Query parameters

limitstringOptional
cursorstringOptional
includeCountstringOptional
searchstringOptional

Response

Paginated list of agents
datalist of objects
paginationobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error