Update agent | Runtype Documentation

curl -X PUT https://api.runtype.com/v1/agents/id \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "config": {
    "frequencyPenalty": 0.2,
    "model": "gpt-4-turbo",
    "presencePenalty": -0.1,
    "seed": 123,
    "temperature": 0.5,
    "topK": 40,
    "topP": 0.9
  },
  "description": "Updated description",
  "name": "Updated Agent Name"
}'

{
  "agentType": "string",
  "claudeManagedConfig": {},
  "config": {},
  "configHash": "string",
  "createdAt": "string",
  "description": "string",
  "draftVersionId": "string",
  "externalConfig": {},
  "healthStatus": "string",
  "icon": "string",
  "id": "string",
  "lastHealthCheckAt": "string",
  "lastModifiedSource": "string",
  "name": "string",
  "organizationId": "string",
  "primaryFlowId": "string",
  "publishedVersionId": "string",
  "status": "string",
  "updatedAt": "string",
  "userId": "string",
  "_warnings": [
    "string"
  ],
  "dashboardUrl": "string"
}

Update an existing agent. Supports partial updates — only provided fields are changed. Config updates are deep-merged.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.

agentTypeenumOptional

Allowed values:

claudeManagedConfigobjectOptional

configobjectOptional

descriptionstringOptional

externalConfigobject or nullOptional

iconstringOptional<=50 characters

maxTurnsintegerOptional1-100

namestringOptional>=1 character

primaryFlowIdstring or nullOptional

Response

Agent updated

agentTypestring

claudeManagedConfigmap from strings to any or null

configmap from strings to any or null

configHashstring 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

lastModifiedSourcestring 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