Agents
Update Agent
Agents
Update Agent
POST
/
v1
/
agents
/
update
curl --request POST \
--url https://api.vocode.dev/v1/agents/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"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
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prompt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "<string>",
"collect_fields": [
{
"field_type": "field_type_email",
"label": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"context_endpoint": "<string>",
"prompt_template": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"required_context_keys": [
"<string>"
]
}
},
"language": "en",
"actions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "action_transfer_call",
"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",
"type": "voice_azure",
"voice_name": "<string>",
"pitch": 123,
"rate": 123
},
"initial_message": "<string>",
"webhook": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptions": [
"event_message"
],
"url": "<string>",
"method": "GET"
},
"vector_database": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "vector_database_pinecone",
"index": "<string>",
"api_key": "<string>",
"api_environment": "<string>"
},
"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
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
id
string
requiredBody
application/json
name
prompt
language
An enumeration.
Available options:
en
, es
, de
, hi
, pt
, fr
, nl
, id
, it
, ja
, ko
actions
voice
initial_message
webhook
vector_database
interrupt_sensitivity
An enumeration.
Available options:
low
, high
context_endpoint
noise_suppression
endpointing_sensitivity
Available options:
auto
, relaxed
, sensitive
ivr_navigation_mode
Available options:
default
, off
conversation_speed
initial_message_delay
openai_model_name_override
ask_if_human_present_on_idle
openai_account_connection
openai_account_connection.id
string
requiredopenai_account_connection.user_id
string
requiredopenai_account_connection.credentials
object
requiredopenai_account_connection.credentials.openai_api_key
string
requiredopenai_account_connection.type
enum<string>
requiredAvailable options:
account_connection_openai
run_do_not_call_detection
Response
200 - application/json
id
string
requireduser_id
string
requiredname
string
prompt
object
requiredprompt.id
string
requiredprompt.user_id
string
requiredprompt.content
string
default: prompt.collect_fields
object[]
prompt.collect_fields.field_type
enum<string>
requiredAvailable options:
field_type_email
prompt.collect_fields.label
string
requiredprompt.collect_fields.name
string
requiredprompt.collect_fields.description
string
prompt.context_endpoint
string
prompt.prompt_template
object
prompt.prompt_template.id
string
requiredprompt.prompt_template.user_id
string
requiredprompt.prompt_template.label
string
default: prompt.prompt_template.required_context_keys
string[]
requiredlanguage
enum<string>
An enumeration.
Available options:
en
, es
, de
, hi
, pt
, fr
, nl
, id
, it
, ja
, ko
actions
object[]
requiredactions.id
string
requiredactions.user_id
string
requiredactions.type
enum<string>
requiredAvailable options:
action_transfer_call
actions.config
object
requiredactions.config.phone_number
string
requiredactions.action_trigger
object
actions.action_trigger.type
enum<string>
requiredAvailable options:
action_trigger_function_call
actions.action_trigger.config
object
voice
object
requiredvoice.id
string
requiredvoice.user_id
string
requiredvoice.type
enum<string>
requiredAvailable options:
voice_azure
voice.voice_name
string
requiredvoice.pitch
integer
default: 0voice.rate
integer
default: 15initial_message
string
webhook
object
webhook.id
string
requiredwebhook.user_id
string
requiredwebhook.subscriptions
enum<string>[]
requiredAvailable options:
event_message
, event_action
, event_phone_call_connected
, event_phone_call_ended
, event_phone_call_did_not_connect
, event_transcript
, event_recording
, event_human_detection
webhook.url
string
requiredwebhook.method
enum<string>
An enumeration.
Available options:
GET
, POST
vector_database
object
vector_database.id
string
requiredvector_database.user_id
string
requiredvector_database.type
enum<string>
requiredAvailable options:
vector_database_pinecone
vector_database.index
string
requiredvector_database.api_key
string
requiredvector_database.api_environment
string
requiredinterrupt_sensitivity
enum<string>
An enumeration.
Available options:
low
, high
context_endpoint
string
noise_suppression
boolean
default: falseendpointing_sensitivity
enum<string>
default: autoAvailable options:
auto
, relaxed
, sensitive
ivr_navigation_mode
enum<string>
default: offAvailable options:
default
, off
conversation_speed
number
default: 1initial_message_delay
number
default: 0openai_model_name_override
string
ask_if_human_present_on_idle
boolean
default: falseopenai_account_connection
object
openai_account_connection.id
string
requiredopenai_account_connection.user_id
string
requiredopenai_account_connection.credentials
object
requiredopenai_account_connection.credentials.openai_api_key
string
requiredopenai_account_connection.type
enum<string>
requiredAvailable options:
account_connection_openai
run_do_not_call_detection
boolean
default: falsellm_temperature
number
default: 0curl --request POST \
--url https://api.vocode.dev/v1/agents/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"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
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prompt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "<string>",
"collect_fields": [
{
"field_type": "field_type_email",
"label": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"context_endpoint": "<string>",
"prompt_template": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"required_context_keys": [
"<string>"
]
}
},
"language": "en",
"actions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "action_transfer_call",
"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",
"type": "voice_azure",
"voice_name": "<string>",
"pitch": 123,
"rate": 123
},
"initial_message": "<string>",
"webhook": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptions": [
"event_message"
],
"url": "<string>",
"method": "GET"
},
"vector_database": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "vector_database_pinecone",
"index": "<string>",
"api_key": "<string>",
"api_environment": "<string>"
},
"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
}