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

Refresh cached agent card

POST
/v1/agents/:id/refresh-agent-card
POST
/v1/agents/:id/refresh-agent-card
$curl -X POST https://api.runtype.com/v1/agents/id/refresh-agent-card \
> -H "Authorization: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "agentType": "chatbot",
3 "changeReport": {
4 "skillsAdded": [
5 "natural-language-processing",
6 "sentiment-analysis"
7 ],
8 "skillsRemoved": [
9 "basic-greeting"
10 ],
11 "rolesAutoApplied": [
12 "customer-support"
13 ]
14 },
15 "claudeManagedConfig": {
16 "model": "claude-v1",
17 "temperature": 0.7,
18 "maxTokens": 1500
19 },
20 "config": {
21 "language": "en-US",
22 "timezone": "America/New_York",
23 "responseTimeout": 5000
24 },
25 "createdAt": "2024-06-10T09:15:30Z",
26 "description": "Customer support chatbot for handling user inquiries and feedback.",
27 "externalConfig": {
28 "agentCardUrl": "https://agents.example.com/cards/customer-support.json",
29 "a2aWellKnownUrl": "https://agents.example.com/.well-known/agent-card"
30 },
31 "icon": "https://assets.runtype.com/icons/chatbot-support.png",
32 "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
33 "name": "SupportBot",
34 "organizationId": "org-987654321",
35 "primaryFlowId": "flow-1234abcd",
36 "status": "active",
37 "updatedAt": "2024-06-15T14:45:00Z",
38 "userId": "user-4567efgh"
39}

Re-fetch the agent card from the configured agentCardUrl (or derived A2A well-known URL) and update the cached copy. Detects skill changes, auto-applies roles to new skills, and returns a change report.

Was this page helpful?
Previous

Resume a paused agent execution

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Response

Updated agent with change report
agentTypestring
changeReportmap from strings to any
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
iconstring or null
idstring
namestring
organizationIdstring or null
primaryFlowIdstring or null
statusstring
updatedAtstring
userIdstring

Errors

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