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>'
import requests

url = "https://api.openmic.ai/v2/agents/{uid}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.openmic.ai/v2/agents/{uid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openmic.ai/v2/agents/{uid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.openmic.ai/v2/agents/{uid}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.openmic.ai/v2/agents/{uid}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.openmic.ai/v2/agents/{uid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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": "<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_message": "<string>",
    "voicemail_post_detection_delay": 15,
    "hipaa_compliance_enabled": true,
    "pci_compliance_enabled": true
  },
  "advanced_settings": {
    "humanize_conversation": true,
    "background_noise_reduction": true,
    "allow_interruptions": true,
    "min_interruption_duration": 2.6,
    "background_sound": "<string>",
    "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>",
    "structured_extraction_prompt": "<string>",
    "structured_extraction_json_schema": {}
  }
}
{
"error": "<string>",
"details": "<string>"
}
{
"error": "<string>",
"details": "<string>"
}
{
"success": true,
"message": "<string>",
"error": "<string>",
"retryAfter": 123
}
{
"error": "<string>",
"details": "<string>"
}

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