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": "<string>",
  "actions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "config": {
        "phone_number": "<string>"
      },
      "type": "action_transfer_call"
    }
  ],
  "voice": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "voice_name": "<string>",
    "type": "voice_azure",
    "pitch": 0,
    "rate": 15
  },
  "initial_message": "<string>",
  "webhook": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subscriptions": [],
    "url": "<string>",
    "method": "POST"
  }
}

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
string
required
​
actions
(TransferCallAction · object | EndConversationAction · object | DTMFAction · object)[]
required
​
voice
AzureVoice · object
required
​
initial_message
string
​
webhook
Webhook · object