Agents
Create Agent
POST
/
v1
/
agents
/
create
curl --request POST \
--url https://api.vocode.dev/v1/agents/create \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"actions": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"context_endpoint": "<string>",
"conversation_speed": 123,
"endpointing_sensitivity": "auto",
"initial_message": "<string>",
"initial_message_delay": 123,
"interrupt_sensitivity": "low",
"ivr_navigation_mode": "default",
"language": "en",
"noise_suppression": true,
"openai_account_connection": {
"credentials": {
"openai_api_key": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account_connection_openai",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"openai_model_name_override": "<string>",
"prompt": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vector_database": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"voice": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"webhook": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
"actions": [
{
"config": {
"phone_number": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "action_transfer_call",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"context_endpoint": "<string>",
"conversation_speed": 123,
"endpointing_sensitivity": "auto",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": "<string>",
"initial_message_delay": 123,
"interrupt_sensitivity": "low",
"ivr_navigation_mode": "default",
"language": "en",
"noise_suppression": true,
"openai_account_connection": {
"credentials": {
"openai_api_key": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account_connection_openai",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"openai_model_name_override": "<string>",
"prompt": {
"collect_fields": [],
"content": "<string>",
"context_endpoint": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_template": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required_context_keys": [],
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vector_database": {
"api_environment": "<string>",
"api_key": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"index": "<string>",
"type": "vector_database_pinecone",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"voice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pitch": 123,
"rate": 123,
"type": "voice_azure",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"voice_name": "<string>"
},
"webhook": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"method": "GET",
"subscriptions": [],
"url": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
actions
array
context_endpoint
string
conversation_speed
number
default: 1endpointing_sensitivity
enum<string>
default: autoAvailable options:
auto
, relaxed
initial_message
string
initial_message_delay
number
default: 0interrupt_sensitivity
enum<string>
An enumeration.
Available options:
low
, high
ivr_navigation_mode
enum<string>
default: falseAvailable options:
default
, off
language
enum<string>
An enumeration.
Available options:
en
, es
, de
noise_suppression
boolean
default: falseopenai_account_connection
openai_model_name_override
string
prompt
required
vector_database
voice
required
webhook
Response
200 - application/json
actions
object[]
requiredTransferCallAction
EndConversationAction
DTMFAction
context_endpoint
string
conversation_speed
number
default: 1endpointing_sensitivity
enum<string>
default: autoAvailable options:
auto
, relaxed
id
string
requiredinitial_message
string
initial_message_delay
number
default: 0interrupt_sensitivity
enum<string>
An enumeration.
Available options:
low
, high
ivr_navigation_mode
enum<string>
default: falseAvailable options:
default
, off
language
enum<string>
An enumeration.
Available options:
en
, es
, de
noise_suppression
boolean
default: falseopenai_account_connection
object
openai_model_name_override
string
prompt
object
requireduser_id
string
requiredvector_database
object
voice
object
requiredOption 1
Option 2
Option 3
Option 4
webhook
object
curl --request POST \
--url https://api.vocode.dev/v1/agents/create \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"actions": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"context_endpoint": "<string>",
"conversation_speed": 123,
"endpointing_sensitivity": "auto",
"initial_message": "<string>",
"initial_message_delay": 123,
"interrupt_sensitivity": "low",
"ivr_navigation_mode": "default",
"language": "en",
"noise_suppression": true,
"openai_account_connection": {
"credentials": {
"openai_api_key": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account_connection_openai",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"openai_model_name_override": "<string>",
"prompt": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vector_database": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"voice": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"webhook": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
"actions": [
{
"config": {
"phone_number": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "action_transfer_call",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"context_endpoint": "<string>",
"conversation_speed": 123,
"endpointing_sensitivity": "auto",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": "<string>",
"initial_message_delay": 123,
"interrupt_sensitivity": "low",
"ivr_navigation_mode": "default",
"language": "en",
"noise_suppression": true,
"openai_account_connection": {
"credentials": {
"openai_api_key": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account_connection_openai",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"openai_model_name_override": "<string>",
"prompt": {
"collect_fields": [],
"content": "<string>",
"context_endpoint": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_template": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required_context_keys": [],
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vector_database": {
"api_environment": "<string>",
"api_key": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"index": "<string>",
"type": "vector_database_pinecone",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"voice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pitch": 123,
"rate": 123,
"type": "voice_azure",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"voice_name": "<string>"
},
"webhook": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"method": "GET",
"subscriptions": [],
"url": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}