curl --request POST \
--url https://api.openmic.ai/v1/bots \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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,
"voicemail_action": "leave_message",
"voicemail_message_type": "static",
"voicemail_message": "<string>",
"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": {}
}
}
'{
"uid": "<string>",
"name": "<string>",
"prompt": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"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,
"voicemail_action": "leave_message",
"voicemail_message_type": "static",
"voicemail_message": "<string>",
"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": {}
}
}Create Bot
Create a new bot with specified configuration.
curl --request POST \
--url https://api.openmic.ai/v1/bots \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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,
"voicemail_action": "leave_message",
"voicemail_message_type": "static",
"voicemail_message": "<string>",
"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": {}
}
}
'{
"uid": "<string>",
"name": "<string>",
"prompt": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"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,
"voicemail_action": "leave_message",
"voicemail_message_type": "static",
"voicemail_message": "<string>",
"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": {}
}
}Authorizations
Bearer token authentication using API key. Find it at: https://chat.openmic.ai/api-key
Body
Bot configuration details
Name of the bot (max 255 characters)
255System prompt for the bot
Initial message the bot will send
ID of the knowledge base to use
Voice synthesis provider
OpenAI, ElevenLabs, Deepgram Voice ID or name
Voice model to use
Speech speed multiplier
Large language model to use
Temperature setting for the LLM
Speech-to-text provider
Deepgram Speech-to-text model
Show child attributes
Show child attributes
Maximum call duration in minutes (2-30)
2 <= x <= 30Silence timeout in seconds (5-45)
5 <= x <= 45Maximum retries for silence timeout (1-5)
1 <= x <= 5Message to play when silence timeout occurs
Whether to record calls
Whether to detect voicemail
Action to take when voicemail is detected. 'leave_message' will deliver a custom voicemail message, 'hangup' will end the call immediately.
leave_message, hangup Type of voicemail message. 'static' uses a fixed pre-written message, 'prompt' uses AI-generated messages based on conversation context.
static, prompt The voicemail message content. Required when voicemail_action is 'leave_message'. For 'static' type, this is the exact message to be delivered. For 'prompt' type, this provides instructions to the AI.
Whether HIPAA compliance is enabled
Whether PCI compliance is enabled
Show child attributes
Show child attributes
Personality type for the agent
casual, humorous, direct, formal, persuasive, friendly Whether to humanize the conversation
Whether to reduce background noise
Whether to allow user interruptions
Minimum interruption duration in seconds (0.2-5, step 0.1)
0.2 <= x <= 5Must be a multiple of 0.1Background sound to play
Preferred response length
normal, short, concise, long Short pause duration in seconds (0.2-2, step 0.1)
0.2 <= x <= 2Must be a multiple of 0.1Long pause duration in seconds (0.5-6, step 0.1)
0.5 <= x <= 6Must be a multiple of 0.1Phrases to filter from speech
Show child attributes
Show child attributes
Prompt for generating call summary
Prompt for evaluating call success
Type of success evaluation rubric
NUMERIC_SCALE, DESCRIPTIVE_SCALE, PERCENTAGE_SCALE, LIKERT_SCALE, PASS_FAIL, SENTIMENT Prompt for structured data extraction
JSON schema for structured extraction
Response
Bot created successfully
Unique identifier of the bot
Name of the bot
System prompt for the bot
Bot creation timestamp
Bot last update timestamp
Initial message the bot will send
ID of the knowledge base
Voice synthesis provider
OpenAI, ElevenLabs, Deepgram Voice ID or name
Voice model being used
Speech speed multiplier
Large language model being used
Temperature setting for the LLM
Speech-to-text provider
Deepgram Speech-to-text model
Show child attributes
Show child attributes
Maximum call duration in minutes (2-30)
2 <= x <= 30Silence timeout in seconds (5-45)
5 <= x <= 45Maximum retries for silence timeout (1-5)
1 <= x <= 5Message to play when silence timeout occurs
Whether to record calls
Whether to detect voicemail
Action to take when voicemail is detected. 'leave_message' will deliver a custom voicemail message, 'hangup' will end the call immediately.
leave_message, hangup Type of voicemail message. 'static' uses a fixed pre-written message, 'prompt' uses AI-generated messages based on conversation context.
static, prompt The voicemail message content. Required when voicemail_action is 'leave_message'. For 'static' type, this is the exact message to be delivered. For 'prompt' type, this provides instructions to the AI.
Whether HIPAA compliance is enabled
Whether PCI compliance is enabled
Show child attributes
Show child attributes
Personality type for the agent
casual, humorous, direct, formal, persuasive, friendly Whether to humanize the conversation
Whether to reduce background noise
Whether to allow user interruptions
Minimum interruption duration in seconds (0.2-5, step 0.1)
0.2 <= x <= 5Must be a multiple of 0.1Background sound to play
Preferred response length
normal, short, concise, long Short pause duration in seconds (0.2-2, step 0.1)
0.2 <= x <= 2Must be a multiple of 0.1Long pause duration in seconds (0.5-6, step 0.1)
0.5 <= x <= 6Must be a multiple of 0.1Phrases to filter from speech
Show child attributes
Show child attributes
Prompt for generating call summary
Prompt for evaluating call success
Type of success evaluation rubric
NUMERIC_SCALE, DESCRIPTIVE_SCALE, PERCENTAGE_SCALE, LIKERT_SCALE, PASS_FAIL, SENTIMENT Prompt for structured data extraction
JSON schema for structured extraction
Was this page helpful?