Update Agent

PATCH/v1/agents/{id}

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

id (path) *

Request Body (JSON)

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes

Request Body

Property	Type	Required	Description
`tenantId`	`string`	No
`name`	`string`	No
`description`	`string`	No
`model`	`string`	No
`systemPrompt`	`string`	No
`tools`	`string[]`	No
`config`	`object`	No
`maxTurns`	`integer`	No
`maxToolCallsPerTurn`	`integer`	No
`enabled`	`boolean`	No
`mode`	`"AGENT_MODE_UNSPECIFIED" \| "AGENT_MODE_PRIMARY" \| "AGENT_MODE_SUBAGENT"`	No	AgentMode controls whether an agent is user-facing or delegation-only.
`maxSteps`	`integer`	No
`taskPermissionMode`	`"TASK_PERMISSION_MODE_UNSPECIFIED" \| "TASK_PERMISSION_MODE_ASK" \| "TASK_PERMISSION_MODE_ALWAYS" \| "TASK_PERMISSION_MODE_DENY"`	No	TaskPermissionMode controls delegation behavior for task/spawn execution.
`hidden`	`boolean`	No
`color`	`string`	No
`workingDirectory`	`string`	No
`mentionAlias`	`string`	No
`executionPolicy`	`object`	No	AgentExecutionPolicy is a typed policy container for runtime controls.
`memoryConfig`	`object`	No	AgentMemoryConfig configures persistent memory for an agent.
`clearTools`	`boolean`	No	Explicitly clears tools when true.

Responses

200 Update agent definition

Property	Type	Description
`agent`	`object`	AgentDefinition is the blueprint/config for an agent.

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X PATCH "http://localhost:8089/v1/agents/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"string","name":"string","description":"string","model":"string","systemPrompt":"string","tools":[],"maxTurns":0,"maxToolCallsPerTurn":0,"enabled":true,"mode":"AGENT_MODE_UNSPECIFIED","maxSteps":0,"taskPermissionMode":"TASK_PERMISSION_MODE_UNSPECIFIED","hidden":true,"color":"string","workingDirectory":"string","mentionAlias":"string","executionPolicy":{"taskPermissionMode":"TASK_PERMISSION_MODE_UNSPECIFIED","maxSteps":0,"workingDirectory":"string"},"memoryConfig":{"enabled":true,"scope":"string","autoRetrieve":true,"autoRetrieveTopK":0,"autoExtract":true},"clearTools":true}'

const response = await fetch("http://localhost:8089/v1/agents/{id}", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "model": "string",
  "systemPrompt": "string",
  "tools": [],
  "maxTurns": 0,
  "maxToolCallsPerTurn": 0,
  "enabled": true,
  "mode": "AGENT_MODE_UNSPECIFIED",
  "maxSteps": 0,
  "taskPermissionMode": "TASK_PERMISSION_MODE_UNSPECIFIED",
  "hidden": true,
  "color": "string",
  "workingDirectory": "string",
  "mentionAlias": "string",
  "executionPolicy": {
    "taskPermissionMode": "TASK_PERMISSION_MODE_UNSPECIFIED",
    "maxSteps": 0,
    "workingDirectory": "string"
  },
  "memoryConfig": {
    "enabled": true,
    "scope": "string",
    "autoRetrieve": true,
    "autoRetrieveTopK": 0,
    "autoExtract": true
  },
  "clearTools": true
}),
});
const data = await response.json();

import requests

response = requests.patch(
    "http://localhost:8089/v1/agents/{id}",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "model": "string",
  "systemPrompt": "string",
  "tools": [],
  "maxTurns": 0,
  "maxToolCallsPerTurn": 0,
  "enabled": true,
  "mode": "AGENT_MODE_UNSPECIFIED",
  "maxSteps": 0,
  "taskPermissionMode": "TASK_PERMISSION_MODE_UNSPECIFIED",
  "hidden": true,
  "color": "string",
  "workingDirectory": "string",
  "mentionAlias": "string",
  "executionPolicy": {
    "taskPermissionMode": "TASK_PERMISSION_MODE_UNSPECIFIED",
    "maxSteps": 0,
    "workingDirectory": "string"
  },
  "memoryConfig": {
    "enabled": true,
    "scope": "string",
    "autoRetrieve": true,
    "autoRetrieveTopK": 0,
    "autoExtract": true
  },
  "clearTools": true
},
)
data = response.json()

Response

{
  "agent": {
    "id": "string",
    "tenantId": "string",
    "name": "string",
    "description": "string",
    "model": "string",
    "systemPrompt": "string",
    "tools": [
      "string"
    ],
    "maxTurns": 0,
    "maxToolCallsPerTurn": 0,
    "enabled": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z",
    "mode": "AGENT_MODE_UNSPECIFIED",
    "maxSteps": 0,
    "taskPermissionMode": "TASK_PERMISSION_MODE_UNSPECIFIED",
    "hidden": true,
    "color": "string",
    "workingDirectory": "string",
    "mentionAlias": "string",
    "executionPolicy": {
      "taskPermissionMode": "TASK_PERMISSION_MODE_UNSPECIFIED",
      "maxSteps": 0,
      "workingDirectory": "string"
    },
    "memoryConfig": {
      "enabled": true,
      "scope": "string",
      "autoRetrieve": true,
      "autoRetrieveTopK": 0,
      "autoExtract": true
    }
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}