Skip to main content
POST
Create an agent with explicit settings

Authorizations

Authorization
string
header
required

Opaque user-bound ca_ account credential. Each request checks live account scopes, verified email, expiry, revocation and the issuer session. Not a workspace ck_ key or OAuth access token.

Path Parameters

workspaceId
string
required
Minimum string length: 1

Body

application/json
name
string
required
Required string length: 2 - 100
systemPrompt
string
status
enum<string>
Available options:
active,
inactive,
draft
model
string
Required string length: 1 - 100
temperature
number
Required range: 0 <= x <= 1
rateLimitPerMinute
integer
Required range: 1 <= x <= 600
allowedDomains
string[]
Maximum array length: 50
Required string length: 1 - 253
widgetConfig
object
notifyConfig
object
voiceConfig
object
learningConfig
object
escalationTeamId
string | null
website
string<uri> | null

A URL with HTTP or HTTPS protocol.

Maximum string length: 500
logoUrl
string<uri> | null

A URL with HTTP or HTTPS protocol.

Maximum string length: 500
supportEmail
string
Required string length: 1 - 64
Pattern: ^[a-z0-9]+$
emailFromName
string | null
Required string length: 1 - 120
indexable
boolean

Response

Create an agent with explicit settings

id
string
required
Minimum string length: 1
workspaceId
string
required
Minimum string length: 1
name
string
required
systemPrompt
string | null
required
status
enum<string>
required
Available options:
active,
inactive,
draft
inTransfer
boolean
required
model
string
required
temperature
number
required
rateLimitPerMinute
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
allowedDomains
string[]
required
widgetConfig
object
required
notifyConfig
object
required
voiceConfig
object
required
learningConfig
object
required
escalationTeamId
string | null
required
Minimum string length: 1
supportEmail
string | null
required
website
string | null
required
logoUrl
string | null
required
chatPageEnabled
boolean
required
chatPageBlockedAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
indexable
boolean
required
emailFromName
string | null
required
deletionScheduledAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
deletionRequestedBy
string | null
required
Minimum string length: 1
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$