POST
/
v1
/
bots
curl --request POST \
  --url https://api.openmic.ai/v1/bots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Customer Support Bot",
  "prompt": "You are a helpful customer support assistant. Be polite, professional, and always try to resolve customer issues.",
  "first_message": "Hello! I'\''m here to help you with any questions or concerns you may have. How can I assist you today?",
  "knowledge_base_id": 123,
  "voice_provider": "OpenAI",
  "voice": "alloy",
  "voice_model": "tts-1",
  "voice_speed": 1,
  "llm_model_name": "gpt-4",
  "llm_model_temperature": 0.7,
  "stt_provider": "Deepgram",
  "stt_model": "nova-2",
  "call_settings": {
    "max_call_duration": 10,
    "silence_timeout": 15,
    "silence_timeout_max_retries": 3,
    "silence_timeout_message": "I didn'\''t hear anything. Are you still there?",
    "call_recording_enabled": true,
    "voicemail_detection_enabled": true,
    "hipaa_compliance_enabled": false,
    "pci_compliance_enabled": false
  },
  "advanced_settings": {
    "agent_personality": "friendly",
    "humanize_conversation": true,
    "background_noise_reduction": true,
    "allow_interruptions": true,
    "min_interruption_duration": 0.5,
    "agent_response_length": "normal",
    "short_pause": 0.3,
    "long_pause": 1
  },
  "post_call_settings": {
    "summary_prompt": "Provide a brief summary of the customer interaction and any action items.",
    "success_evaluation_prompt": "Rate the success of this call on a scale of 1-10 based on customer satisfaction.",
    "success_evaluation_rubric_type": "NUMERIC_SCALE"
  }
}'
{
  "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": "<any>"
  },
  "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

Body

application/json

Bot configuration details

The body is of type object.

Response

201
application/json

Bot created successfully

The response is of type object.