GET
/
v1
/
bots
curl --request GET \
  --url https://api.openmic.ai/v1/bots \
  --header 'Authorization: Bearer <token>'
{
  "bots": [
    {
      "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"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "has_more": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer

Maximum number of bots to return (1-100)

Required range: 1 <= x <= 100
​
offset
integer

Number of bots to skip

Required range: x >= 0
​
name
string

Filter by bot name (partial match)

​
created_after
string

Filter bots created after this date (ISO 8601 format)

​
created_before
string

Filter bots created before this date (ISO 8601 format)

Response

200
application/json

List of bots retrieved successfully

The response is of type object.