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

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: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "id": "a1b2c3d4-e5f6-7890-ab12-cdef34567890",
3 "userId": "user_987654321",
4 "organizationId": "org_123456789",
5 "name": "Customer Support Agent",
6 "description": "Agent specialized in handling customer inquiries and support tickets.",
7 "icon": "https://cdn.runtype.com/icons/support-agent.png",
8 "primaryFlowId": "flow_456def789abc",
9 "agentType": "external",
10 "config": {
11 "language": "en-US",
12 "timezone": "America/New_York",
13 "maxConcurrentSessions": 5
14 },
15 "externalConfig": {
16 "agentCardUrl": "https://agents.example.com/cards/customer-support-agent.json",
17 "refreshIntervalMinutes": 60
18 },
19 "claudeManagedConfig": {
20 "model": "claude-v1",
21 "temperature": 0.7,
22 "maxTokens": 1500
23 },
24 "status": "active",
25 "createdAt": "2024-05-10T09:15:00Z",
26 "updatedAt": "2024-06-01T12:00:00Z",
27 "changeReport": {
28 "skillsAdded": [
29 "ticket-management",
30 "live-chat"
31 ],
32 "skillsRemoved": [
33 "email-support"
34 ],
35 "rolesAutoApplied": [
36 "support-agent",
37 "chat-operator"
38 ],
39 "lastRefresh": "2024-06-01T12:00:00Z"
40 }
41}

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

Get agent details

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Response

Updated agent with change report
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
statusstring
createdAtstring
updatedAtstring
changeReportmap from strings to any

Errors

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