Agents
List Agents
Agents
List Agents
GET
/
v1
/
agents
/
list
curl --request GET \
--url https://api.vocode.dev/v1/agents/list \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prompt": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "en",
"actions": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"voice": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": "<string>",
"webhook": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vector_database": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interrupt_sensitivity": "low",
"context_endpoint": "<string>",
"noise_suppression": true,
"endpointing_sensitivity": "auto",
"ivr_navigation_mode": "default",
"conversation_speed": 123,
"initial_message_delay": 123,
"openai_model_name_override": "<string>",
"ask_if_human_present_on_idle": true,
"openai_account_connection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credentials": {
"openai_api_key": "<string>"
},
"type": "account_connection_openai"
},
"run_do_not_call_detection": true,
"llm_temperature": 123
}
],
"page": 123,
"size": 123,
"has_more": true,
"total": 123,
"total_is_estimated": true
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
page
integer
default: 1size
integer
default: 10sort_column
string
sort_desc
boolean
default: falseResponse
200 - application/json
items
object[]
requireditems.id
string
requireditems.user_id
string
requireditems.name
string
items.prompt
required
items.language
enum<string>
An enumeration.
Available options:
en
, es
, de
, hi
, pt
, fr
, nl
, id
, it
, ja
, ko
items.actions
string[]
requireditems.voice
string
requireditems.initial_message
string
items.webhook
string
items.vector_database
items.interrupt_sensitivity
enum<string>
An enumeration.
Available options:
low
, high
items.context_endpoint
string
items.noise_suppression
boolean
default: falseitems.endpointing_sensitivity
enum<string>
default: autoAvailable options:
auto
, relaxed
, sensitive
items.ivr_navigation_mode
enum<string>
default: offAvailable options:
default
, off
items.conversation_speed
number
default: 1items.initial_message_delay
number
default: 0items.openai_model_name_override
string
items.ask_if_human_present_on_idle
boolean
default: falseitems.openai_account_connection
items.openai_account_connection.id
string
requireditems.openai_account_connection.user_id
string
requireditems.openai_account_connection.credentials
object
requireditems.openai_account_connection.credentials.openai_api_key
string
requireditems.openai_account_connection.type
enum<string>
requiredAvailable options:
account_connection_openai
items.run_do_not_call_detection
boolean
default: falseitems.llm_temperature
number
default: 0page
integer
requiredsize
integer
requiredhas_more
boolean
requiredtotal
integer
requiredtotal_is_estimated
boolean
requiredcurl --request GET \
--url https://api.vocode.dev/v1/agents/list \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prompt": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "en",
"actions": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"voice": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": "<string>",
"webhook": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vector_database": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interrupt_sensitivity": "low",
"context_endpoint": "<string>",
"noise_suppression": true,
"endpointing_sensitivity": "auto",
"ivr_navigation_mode": "default",
"conversation_speed": 123,
"initial_message_delay": 123,
"openai_model_name_override": "<string>",
"ask_if_human_present_on_idle": true,
"openai_account_connection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credentials": {
"openai_api_key": "<string>"
},
"type": "account_connection_openai"
},
"run_do_not_call_detection": true,
"llm_temperature": 123
}
],
"page": 123,
"size": 123,
"has_more": true,
"total": 123,
"total_is_estimated": true
}