Skip to main content
PATCH
Update an agent

Authorizations

Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Path Parameters

uid
string
required

The agent UID.

Body

application/json
name
string
Required string length: 1 - 255
prompt
string
Minimum string length: 1
first_message
string

Cannot be combined with auto_first_message: true.

auto_first_message
boolean
knowledge_base_id
integer | null

Set to null to detach the current knowledge base.

voice_provider
enum<string>
Available options:
OpenAI,
ElevenLabs,
Deepgram,
Cartesia
voice
string
voice_model
string
voice_speed
number
llm_model_name
string
llm_model_temperature
number
Required range: 0 <= x <= 2
llm_max_tokens
integer
stt_provider
enum<string>
Available options:
Deepgram
stt_model
string
auto_end_call
boolean
call_settings
object
advanced_settings
object
boosted_keywords
string[]
Maximum array length: 30
selected_jargons
string[]
post_call_settings
object

Response

Updated agent.

uid
string
required

Unique agent identifier (slug/UUID).

name
string
required
prompt
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
first_message
string
auto_first_message
boolean
knowledge_base_id
integer
voice_provider
enum<string>
Available options:
OpenAI,
ElevenLabs,
Deepgram,
Cartesia
voice
string
voice_model
string
voice_speed
number
llm_model_name
string
llm_model_temperature
number
Required range: 0 <= x <= 2
llm_max_tokens
integer
stt_provider
enum<string>
Available options:
Deepgram
stt_model
string
auto_end_call
boolean
call_settings
object
advanced_settings
object
boosted_keywords
string[]
Maximum array length: 30
selected_jargons
string[]
post_call_settings
object