Update BYO Agent

Updates an existing BYO Agent by its UID. Use this endpoint to modify agent configuration, update referenced tools, or change the connected AI framework. Validation: Referenced tools and actions

PATCH /ai-agents/agents/{uid}

Update BYO Agent

cURL

curl --request PATCH \
  --url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agents/{uid} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "<string>",
  "icon": "<string>",
  "isActive": true,
  "integrationMeta": {
    "baseUrl": "https://my-mastra-app.example.com",
    "agentId": "weatherAgent"
  },
  "tools": [
    "<string>"
  ],
  "actions": [
    "<string>"
  ],
  "metaData": {
    "greetingMessage": "<string>",
    "introductoryMessage": "<string>",
    "suggestedMessages": [
      "<string>"
    ]
  }
}
'

200

{
  "success": true
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key (i.e. Rest API Key from the Dashboard).

Headers

chatApiVersion · string · default: v3.0

Chat API version. Defaults to v3.0.

Path Parameters

uid · string · required

Unique identifier of the agent

Body

application/json

Mastra

Mastra (Legacy)

LangGraph

CrewAI

Vercel AI V5

AG2

Rasa

Agno

AG-UI

name · string

Name of the agent

icon · string<url>

URL to the icon/avatar of the agent

isActive · boolean · default: true

Whether the agent is active

integrateWith · enum<string>

Integration platform identifier

Available options: mastra

integrationType · enum<string>

Type of connection

Available options: agent

integrationMeta · object

Mastra-specific configuration

Show child attributes

tools · string[]

List of tool names (must exist in the app's tools)

actions · string[]

List of action names (must exist in the app's actions)

metaData · object

Metadata for the agent

Show child attributes

Response

200 - application/json

Agent updated successfully

success · boolean · required

Indicates whether the operation was successful

Example:

true