Skip to main content
GET
/
v2
/
agents
/
{uid}
Get an agent
curl --request GET \
  --url https://api.openmic.ai/v2/agents/{uid} \
  --header 'Authorization: Bearer <token>'
{
  "uid": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "first_message": "<string>",
  "auto_first_message": true,
  "knowledge_base_id": 123,
  "voice_provider": "OpenAI",
  "voice": "<string>",
  "voice_model": "<string>",
  "voice_speed": 123,
  "llm_model_name": "<string>",
  "llm_model_temperature": 1,
  "llm_max_tokens": 123,
  "stt_provider": "Deepgram",
  "stt_model": "<string>",
  "auto_end_call": true,
  "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": "hangup",
    "voicemail_message_type": "prompt",
    "voicemail_message": "<string>",
    "voicemail_post_detection_delay": 15,
    "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>"
  },
  "boosted_keywords": [
    "<string>"
  ],
  "selected_jargons": [
    "<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": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.openmic.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Path Parameters

uid
string
required

The agent UID.

Response

Agent details.

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