Skip to main content
PUT
Save agent draft

Authorizations

X-API-Key
string
header
required

API key issued for your workspace.

Path Parameters

agentId
string
required

Agent public ID

Body

application/json

Agent draft configuration

ambienceId
string
required

Ambience

pipelineType
enum<string>
required
Available options:
cascaded,
realtime_native
systemPrompt
string
required

Core Config

triggers
object[]
required

Triggers

ambienceVolume
number
Required range: 0 <= x <= 2
avatarUrl
string
Maximum string length: 512
description
string
Maximum string length: 512
digitPronunciation
boolean
dynamicVariables
object
endpointingPatience
number
greetingConfig
object

Voice Pipeline Configs

interruptionSensitivity
number
knowledgeBaseIds
string[]

Knowledge base public IDs to attach (max enforced by knowledgebase.Link)

languageCode
string
Maximum string length: 10
llmMaxTokens
integer
Required range: x >= 1
llmModel
string
llmProvider
enum<string>

LLM Settings

Available options:
openai,
anthropic,
google,
groq,
together,
azure,
cerebras
llmTemperature
number
Required range: 0 <= x <= 2
maxCallDurationSec
integer
Required range: x >= 1
minConsecutiveSpeechDelay
number
Required range: x >= 0
name
string

Agent-level fields

Maximum string length: 64
noiseCancellationConfig
object
piiAnonymisation
boolean

PII Settings (versioned)

piiCategories
string[]
piiRedaction
boolean
presenceDetectionConfig
object
responseEagerness
number
silenceTimeoutSec
integer

Behavior Settings

Required range: x >= 1
tools
object[]
ttsSpeed
number
Required range: 0.5 <= x <= 2
ttsVoiceModelId
integer

TTS Settings

vocabularySpecialization
enum<string>
Available options:
general,
medical
voiceVolume
number
Required range: 0 <= x <= 2

Response

OK

data
object
success
boolean