Skip to main content
PATCH
Update BYO Agent

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

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

Response

200 - application/json

Agent updated successfully

success
boolean
required

Indicates whether the operation was successful

Example:

true