Update Agent

Updates an existing agent by its UID. Use this endpoint to modify an agent’s configuration, instructions, model, or connected tools. Validation: Referenced tools, API tools, and MCP servers are v

PATCH /ai-agents/agent-builder/agents/{uid}

Update Agent

cURL

curl --request PATCH \
  --url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "<string>",
  "icon": "<string>",
  "description": "<string>",
  "tools": [
    "<string>"
  ],
  "apiTools": [
    "<string>"
  ],
  "mcpServers": [
    "<string>"
  ],
  "instruction": "<string>",
  "metaData": {},
  "model": "gpt-4o-mini",
  "modelMetaData": {
    "temperature": 0.7,
    "maxTokens": 4096
  },
  "isActive": true
}
'

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}"

payload = {
    "name": "<string>",
    "icon": "<string>",
    "description": "<string>",
    "tools": ["<string>"],
    "apiTools": ["<string>"],
    "mcpServers": ["<string>"],
    "instruction": "<string>",
    "metaData": {},
    "model": "gpt-4o-mini",
    "modelMetaData": {
        "temperature": 0.7,
        "maxTokens": 4096
    },
    "isActive": True
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    icon: '<string>',
    description: '<string>',
    tools: ['<string>'],
    apiTools: ['<string>'],
    mcpServers: ['<string>'],
    instruction: '<string>',
    metaData: {},
    model: 'gpt-4o-mini',
    modelMetaData: {temperature: 0.7, maxTokens: 4096},
    isActive: true
  })
};

fetch('https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'icon' => '<string>',
    'description' => '<string>',
    'tools' => [
        '<string>'
    ],
    'apiTools' => [
        '<string>'
    ],
    'mcpServers' => [
        '<string>'
    ],
    'instruction' => '<string>',
    'metaData' => [
        
    ],
    'model' => 'gpt-4o-mini',
    'modelMetaData' => [
        'temperature' => 0.7,
        'maxTokens' => 4096
    ],
    'isActive' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tools\": [\n    \"<string>\"\n  ],\n  \"apiTools\": [\n    \"<string>\"\n  ],\n  \"mcpServers\": [\n    \"<string>\"\n  ],\n  \"instruction\": \"<string>\",\n  \"metaData\": {},\n  \"model\": \"gpt-4o-mini\",\n  \"modelMetaData\": {\n    \"temperature\": 0.7,\n    \"maxTokens\": 4096\n  },\n  \"isActive\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tools\": [\n    \"<string>\"\n  ],\n  \"apiTools\": [\n    \"<string>\"\n  ],\n  \"mcpServers\": [\n    \"<string>\"\n  ],\n  \"instruction\": \"<string>\",\n  \"metaData\": {},\n  \"model\": \"gpt-4o-mini\",\n  \"modelMetaData\": {\n    \"temperature\": 0.7,\n    \"maxTokens\": 4096\n  },\n  \"isActive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tools\": [\n    \"<string>\"\n  ],\n  \"apiTools\": [\n    \"<string>\"\n  ],\n  \"mcpServers\": [\n    \"<string>\"\n  ],\n  \"instruction\": \"<string>\",\n  \"metaData\": {},\n  \"model\": \"gpt-4o-mini\",\n  \"modelMetaData\": {\n    \"temperature\": 0.7,\n    \"maxTokens\": 4096\n  },\n  \"isActive\": true\n}"

response = http.request(request)
puts response.read_body

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).

Path Parameters

uid · string · required

Unique identifier of the agent

Body

application/json

name · string

Name of the agent

icon · string

URL to the icon/avatar of the agent

description · string

Description of the agent

tools · string[]

Array of tool names available to this agent

apiTools · string[]

Array of API tool names available to this agent

mcpServers · string[]

Array of MCP server names available to this agent

instruction · string

Instructions for the agent behavior

metaData · object

Additional metadata for the agent

model · string · default: gpt-4o-mini

AI model to use for this agent

modelMetaData · object

Configuration metadata for the AI model

Show child attributes

isActive · boolean · default: true

Is the agent active?

Response

200 - application/json

Agent updated successfully

success · boolean · required

Indicates whether the operation was successful

Example:

true