Skip to main content
POST
Error

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required

Body

application/json
name
string
required
avatarColor
enum<string>
Available options:
primary,
red,
amber,
lime,
emerald,
sky,
blue,
indigo,
violet,
fuchsia,
gray,
black
avatarRatio
enum<string>
Available options:
1:1,
1:2,
2:1,
2:3,
1:3,
3:1
avatarShape
enum<string>
Available options:
square,
squircle,
circle,
pill,
diamond,
triangle,
pentagon,
hexagon,
octagon,
shield,
scallop,
blob,
drop,
star
description
string | null

What the agent is for, in markdown, shown to people; the brief the agent follows on every turn. Blank clears it.

enabled
boolean
role
string | null

A one-line role shown under the name, such as "Thermal reviewer". Blank clears it.

suggestOnly
boolean
triggers
object[]

The agent's triggers, written whole: each one an automation trigger's settings and the prompt a firing hands the agent. Firing one starts a side chat with the agent, as the agent, with that prompt.

Response

201 - application/json
avatarColor
enum<string>
required
Available options:
primary,
red,
amber,
lime,
emerald,
sky,
blue,
indigo,
violet,
fuchsia,
gray,
black
avatarRatio
enum<string>
required
Available options:
1:1,
1:2,
2:1,
2:3,
1:3,
3:1
avatarShape
enum<string>
required
Available options:
square,
squircle,
circle,
pill,
diamond,
triangle,
pentagon,
hexagon,
octagon,
shield,
scallop,
blob,
drop,
star
botUserId
string
required
createdAt
string
required
createdBy
string
required
description
string | null
required
enabled
boolean
required
id
string
required
name
string
required
projectId
string
required
role
string | null
required
suggestOnly
boolean
required
triggers
object[]
required
updatedAt
string
required
updatedBy
string
required