Skip to main content
POST
Create agent

Autorizações

X-Api-Key
string
header
obrigatório

Corpo

application/json

Body for creating a new agent in the workspace.

avatarUrl
string

Optional avatar URL (http or https).

Maximum string length: 1024
Pattern: ^https?://.+
Exemplo:

"https://cdn.example.com/avatars/support-bot.png"

categories
string[]

Up to 10 free-form category tags. Each tag must not exceed 100 characters.

Maximum array length: 10
Maximum string length: 100
Exemplo:
description
string

Short description shown in the agent catalogue.

Maximum string length: 2000
Exemplo:

"Answers questions about billing, refunds and account access."

name
string

Display name of the agent.

Required string length: 1 - 150
Exemplo:

"Support Bot"

Resposta

Created

Agent metadata + editable-state configuration.

aiModelName
string

Selected AI model display name; null when not yet configured.

aiModelPublicId
string<uuid>

Selected AI model public ID; null when not yet configured.

audioListeningEnabled
boolean
audioResponseEnabled
boolean
avatarUrl
string
categories
string[]
createdAt
string<date-time>
description
string
draftVersionNumber
integer<int32>
dynamicPromptEnabled
boolean
followUpAfterHours
integer<int32>
followUpBusinessHoursEnd
string
Exemplo:

"14:30:00"

followUpBusinessHoursStart
string
Exemplo:

"14:30:00"

followUpEnabled
boolean
followUpInactivityMinutes
integer<int32>
followUpIntervalMinutes
integer<int32>
followUpMaxAttempts
integer<int32>
followUpPrompt
string
genuiEnabled
boolean
hasExternalChannel
boolean
hasUnpublishedChanges
boolean

True if the editable state differs from the published snapshot.

longTermMemoryEnabled
boolean
memoryCustomInstructions
string
messageDelayEnabled
boolean
messageDelayType
enum<string>

Delay tier when messageDelayEnabled=true.

Opções disponíveis:
LOW,
MEDIUM,
HIGH,
RANDOM
messageSplittingEnabled
boolean
name
string
publicId
string<uuid>
publishedVersionNumber
integer<int32>
sandboxEnabled
boolean
status
enum<string>
Opções disponíveis:
draft,
active,
inactive,
archived
systemPrompt
string
temperature
number<float>
thinkingEffort
enum<string>

Thinking effort tier.

Opções disponíveis:
low,
medium,
high
thinkingEnabled
boolean
ttsVoice
string
updatedAt
string<date-time>
webSearchEnabled
boolean