Skip to main content
PATCH
Update agent settings

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

agents:write

Edit agent configuration, handbook, memory, tone examples, and schedules, and give agents tasks.

Path Parameters

agentId
string
required

Agent id from list_agents.

Required string length: 1 - 64

Body

application/json
name
string
Required string length: 1 - 100
icon
enum<string>

Choose a supported icon name, not an emoji or description. Use an empty string to restore the default icon.

Available options:
brain,
bot,
sparkles,
zap,
rocket,
wand,
lightbulb,
star,
target,
compass,
message,
mail,
inbox,
send,
phone,
headphones,
lifebuoy,
calendar,
clipboard,
file,
search,
chart,
briefcase,
wrench,
bug,
shield,
cpu,
bell,
flame,
heart,
leaf,
bird,
ghost,
user,
users,
handshake,
smile,
crown,
graduation,
stethoscope,
chef,
hardhat,
building,
store,
globe,
pin,
home,
hotel,
landmark,
plane,
car,
truck,
package,
hammer,
palette,
camera,
mic,
code,
terminal,
database,
key,
lock,
sun,
moon,
cloud,
snowflake,
flower,
paw,
cat,
dog,
fish,
gift,
trophy,
flag,
gem,
puzzle,
coffee,
book,
megaphone,
scale,
piggy,
workspaceId
string

Response

Success

agentId
string
required
saved
boolean
required