POST
/
v1
/
agents
/
create
curl --request POST \
  --url https://api.vocode.dev/v1/agents/create \
  --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,
  "llm_temperature": 123
}'
{
  "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
headerrequired

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

Body

application/json
name
string
prompt
required
language
enum<string>

An enumeration.

Available options:
en,
es,
de,
hi,
pt,
fr,
nl,
id,
it,
ja,
ko
actions
array
voice
required
initial_message
string
webhook
vector_database
interrupt_sensitivity
enum<string>

An enumeration.

Available options:
low,
high
context_endpoint
string
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
ask_if_human_present_on_idle
boolean
default: false
openai_account_connection
run_do_not_call_detection
boolean
default: false
llm_temperature
number
default: 0

Response

200 - application/json
id
string
required
user_id
string
required
name
string
prompt
object
required
language
enum<string>

An enumeration.

Available options:
en,
es,
de,
hi,
pt,
fr,
nl,
id,
it,
ja,
ko
actions
object[]
required
voice
object
required
initial_message
string
webhook
object
vector_database
object
interrupt_sensitivity
enum<string>

An enumeration.

Available options:
low,
high
context_endpoint
string
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
ask_if_human_present_on_idle
boolean
default: false
openai_account_connection
object
run_do_not_call_detection
boolean
default: false
llm_temperature
number
default: 0
List AgentsUpdate Agent