Skip to main content
PATCH
/
v1
/
bots
/
{uid}
Update Bot
curl --request PATCH \
  --url https://api.openmic.ai/v1/bots/{uid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Updated Customer Support Bot",
  "prompt": "You are an advanced customer support assistant with expertise in technical issues.",
  "voice_speed": 1.1,
  "llm_model_temperature": 0.8,
  "call_settings": {
    "max_call_duration": 15,
    "silence_timeout": 20
  }
}'
{
  "uid": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "first_message": "<string>",
  "knowledge_base_id": 123,
  "voice_provider": "OpenAI",
  "voice": "<string>",
  "voice_model": "<string>",
  "voice_speed": 123,
  "llm_model_name": "<string>",
  "llm_model_temperature": 123,
  "stt_provider": "Deepgram",
  "stt_model": "<string>",
  "call_settings": {
    "max_call_duration": 16,
    "silence_timeout": 25,
    "silence_timeout_max_retries": 3,
    "silence_timeout_message": "<string>",
    "call_recording_enabled": true,
    "voicemail_detection_enabled": true,
    "hipaa_compliance_enabled": true,
    "pci_compliance_enabled": true
  },
  "advanced_settings": {
    "agent_personality": "casual",
    "humanize_conversation": true,
    "background_noise_reduction": true,
    "allow_interruptions": true,
    "min_interruption_duration": 2.6,
    "background_sound": "<string>",
    "agent_response_length": "normal",
    "short_pause": 1.1,
    "long_pause": 3.25,
    "filter_phrases": "<string>"
  },
  "post_call_settings": {
    "summary_prompt": "<string>",
    "success_evaluation_prompt": "<string>",
    "success_evaluation_rubric_type": "NUMERIC_SCALE",
    "structured_extraction_prompt": "<string>",
    "structured_extraction_json_schema": {}
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer token authentication using API key. Find it at: https://chat.openmic.ai/api-key

Path Parameters

uid
string
required

The unique identifier of the bot

Body

application/json

Updated bot configuration

All fields are optional for updates

name
string
required

Name of the bot (max 255 characters)

Maximum length: 255
prompt
string
required

System prompt for the bot

first_message
string

Initial message the bot will send

knowledge_base_id
integer

ID of the knowledge base to use

voice_provider
enum<string>

Voice synthesis provider

Available options:
OpenAI,
ElevenLabs,
Deepgram
voice
string

Voice ID or name

voice_model
string

Voice model to use

voice_speed
number

Speech speed multiplier

llm_model_name
string

Large language model to use

llm_model_temperature
number

Temperature setting for the LLM

stt_provider
enum<string>

Speech-to-text provider

Available options:
Deepgram
stt_model
string

Speech-to-text model

call_settings
object
advanced_settings
object
post_call_settings
object

Response

Bot updated successfully

uid
string
required

Unique identifier of the bot

name
string
required

Name of the bot

prompt
string
required

System prompt for the bot

created_at
string<date-time>
required

Bot creation timestamp

updated_at
string<date-time>
required

Bot last update timestamp

first_message
string

Initial message the bot will send

knowledge_base_id
integer

ID of the knowledge base

voice_provider
enum<string>

Voice synthesis provider

Available options:
OpenAI,
ElevenLabs,
Deepgram
voice
string

Voice ID or name

voice_model
string

Voice model being used

voice_speed
number

Speech speed multiplier

llm_model_name
string

Large language model being used

llm_model_temperature
number

Temperature setting for the LLM

stt_provider
enum<string>

Speech-to-text provider

Available options:
Deepgram
stt_model
string

Speech-to-text model

call_settings
object
advanced_settings
object
post_call_settings
object