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

Create agent

POST
/v1/agents
POST
/v1/agents
$curl -X POST https://api.runtype.com/v1/agents \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "My New Agent",
>  "agentType": "runtype",
>  "config": {
>    "frequencyPenalty": 0.2,
>    "model": "gpt-4",
>    "presencePenalty": 0.1,
>    "seed": 123,
>    "systemPrompt": "You are a helpful customer support agent",
>    "temperature": 0.7,
>    "topK": 40,
>    "topP": 0.9,
>    "maxTurns": 10
>  },
>  "description": "An AI agent for customer support",
>  "primaryFlowId": "flow_01jv0000000000000000000001"
>}'
1{
2  "agentType": "string",
3  "capabilities": [
4    {
5      "displayOrder": 1,
6      "enabled": true,
7      "flowId": "string",
8      "id": "string",
9      "subAgentId": "string",
10      "toolDescription": "string",
11      "toolId": "string",
12      "toolName": "string",
13      "agentId": "string",
14      "createdAt": "string"
15    }
16  ],
17  "claudeManagedConfig": {},
18  "config": {},
19  "createdAt": "string",
20  "description": "string",
21  "draftVersionId": "string",
22  "externalConfig": {},
23  "healthStatus": "string",
24  "icon": "string",
25  "id": "string",
26  "lastHealthCheckAt": "string",
27  "name": "string",
28  "organizationId": "string",
29  "primaryFlowId": "string",
30  "publishedVersionId": "string",
31  "status": "string",
32  "updatedAt": "string",
33  "userId": "string",
34  "_warnings": [
35    "string"
36  ],
37  "dashboardUrl": "string"
38}

Create a new agent with optional capabilities and configuration. Supports runtype, external, and claude_managed agent types.

Was this page helpful?
Previous

Fetch external agent card

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Request

This endpoint expects an object.
namestringRequired>=1 character
agentTypeenumOptionalDefaults to runtype
Allowed values:
capabilitieslist of objectsOptional
claudeManagedConfigobjectOptional
configobjectOptional
descriptionstringOptional
externalConfigobjectOptional
iconstringOptional<=50 characters
maxTurnsintegerOptional1-100
primaryFlowIdstring or nullOptional

Response

Agent created
agentTypestring
capabilitieslist of objects
claudeManagedConfigmap from strings to any or null
configmap from strings to any or null
createdAtstring
descriptionstring or null
draftVersionIdstring or null
externalConfigmap from strings to any or null
healthStatusstring or null
iconstring or null
idstring
lastHealthCheckAtstring or null
namestring
organizationIdstring or null
primaryFlowIdstring or null
publishedVersionIdstring or null
statusstring
updatedAtstring
userIdstring
_warningslist of strings
dashboardUrlstring

Errors

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