Skip to main content
POST
Create agent

Authorizations

Authorization
string
header
required

Workspace API token. Include abilities external-api:read and/or external-api:write.

Body

application/json
name
string
required
Maximum string length: 255
description
string | null
avatar_url
string<uri> | null
Maximum string length: 500
max_messages_per_session
integer | null
Required range: 1 <= x <= 1000
tone
string | null
Maximum string length: 255
response_length
string | null
Maximum string length: 255
is_active
boolean | null

Response

Agent created

id
string<uuid>
name
string
slug
string
description
string | null
avatar_url
string<uri> | null
max_messages_per_session
integer | null
tone
string | null
response_length
string | null
is_active
boolean
is_copilot
boolean
prohibited_phrases
object[]
escalation_rules
object[]
created_at
string<date-time> | null
updated_at
string<date-time> | null