Skip to main content
GET
/
v1
/
agents
Get Agent
curl --request GET \
  --url https://api.vocode.dev/v1/agents \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompt": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "content": "",
    "collect_fields": [
      {
        "label": "<string>",
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "context_endpoint": "<string>",
    "prompt_template": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "required_context_keys": [
        "<string>"
      ],
      "label": ""
    }
  },
  "actions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "config": {
        "phone_number": "<string>"
      },
      "action_trigger": {
        "type": "action_trigger_function_call",
        "config": {}
      }
    }
  ],
  "voice": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "voice_name": "<string>",
    "pitch": 0,
    "rate": 15
  },
  "name": "<string>",
  "language": "en",
  "initial_message": "<string>",
  "webhook": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subscriptions": [],
    "url": "<string>",
    "method": "POST"
  },
  "vector_database": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "index": "<string>",
    "api_key": "<string>",
    "api_environment": "<string>"
  },
  "interrupt_sensitivity": "low",
  "context_endpoint": "<string>",
  "noise_suppression": false,
  "endpointing_sensitivity": "auto",
  "ivr_navigation_mode": "off",
  "conversation_speed": 1,
  "initial_message_delay": 0,
  "openai_model_name_override": "<string>",
  "ask_if_human_present_on_idle": false,
  "openai_account_connection": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "credentials": {
      "openai_api_key": "<string>"
    }
  },
  "run_do_not_call_detection": false,
  "llm_fallback": {
    "model_name": "<string>"
  },
  "deepgram_keywords": {},
  "idle_time_seconds": 123,
  "llm_temperature": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.vocode.dev/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
user_id
string<uuid>
required
​
prompt
Prompt · object
required
​
actions
(TransferCallAction · object | EndConversationAction · object | DTMFAction · object | AddToConferenceAction · object | SetHoldAction · object | ExternalAction · object)[]
required
​
voice
AzureVoice · object
required
​
name
string | null
​
language
enum<string>
default:en
Available options:
en,
es,
de,
hi,
pt,
fr,
nl,
id,
it,
ja,
ko
​
initial_message
string | null
​
webhook
Webhook · object
​
vector_database
PineconeVectorDatabase · object
​
interrupt_sensitivity
enum<string>
default:low
Available options:
low,
high
​
context_endpoint
string | null
​
noise_suppression
boolean
default:false
​
endpointing_sensitivity
enum<string>
default:auto
Available options:
auto,
relaxed,
sensitive
​
ivr_navigation_mode
enum<string>
default:off
Available options:
default,
off
​
conversation_speed
number
default:1
​
initial_message_delay
number
default:0
​
openai_model_name_override
string | null
​
ask_if_human_present_on_idle
boolean
default:false
​
openai_account_connection
OpenAIAccountConnection · object
​
run_do_not_call_detection
boolean
default:false
​
llm_fallback
InternalLLMFallback · object
​
deepgram_keywords
Deepgram Keywords · object
​
idle_time_seconds
integer | null
​
llm_temperature
number
default:0