Skip to main content
POST
/
v1
/
voice
/
agents
cURL
curl --request POST \
  --url https://api.comm.com/api/v1/voice/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "greeting_message": "<string>",
  "prompt": "<string>",
  "tools": [
    "<string>"
  ],
  "post_processing_agents": [
    "<string>"
  ],
  "variables": [
    "<string>"
  ],
  "voice_id": "<string>",
  "voice_name": "<string>",
  "gpt_model_id": "<string>",
  "language": "multi",
  "time_limit": 120,
  "start_with_greeting": false,
  "millis_sip_endpoint": "<string>",
  "voice_speed": 1,
  "voice_volume": 1,
  "background_noise": false,
  "suggestion_reason": "<string>",
  "provider": "openai",
  "model": "gpt-4o",
  "voice_provider": "vapi",
  "voice_model": "eleven_turbo_v2",
  "agent_description": "<string>",
  "silence_timeout_seconds": 15,
  "voice_mail_detection": true,
  "speaking_plan_num_words": 3,
  "allow_interruptions": true,
  "pixel_is_lead": false,
  "pixel_is_sale": false,
  "pixel_sale_amount": 0
}
'
{
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "meta": {
      "name": "<string>",
      "greeting_message": "<string>",
      "prompt": "<string>",
      "tools": [
        "<string>"
      ],
      "post_processing_agents": [
        "<string>"
      ],
      "variables": [
        "<string>"
      ],
      "voice_id": "<string>",
      "voice_name": "<string>",
      "gpt_model_id": "<string>",
      "language": "multi",
      "time_limit": 120,
      "start_with_greeting": false,
      "millis_sip_endpoint": "<string>",
      "voice_speed": 1,
      "voice_volume": 1,
      "background_noise": false,
      "suggestion_reason": "<string>",
      "provider": "openai",
      "model": "gpt-4o",
      "voice_provider": "vapi",
      "voice_model": "eleven_turbo_v2",
      "agent_description": "<string>",
      "silence_timeout_seconds": 15,
      "voice_mail_detection": true,
      "speaking_plan_num_words": 3,
      "allow_interruptions": true,
      "pixel_is_lead": false,
      "pixel_is_sale": false,
      "pixel_sale_amount": 0
    },
    "default_voice": {
      "id": "<string>",
      "name": "Eric"
    },
    "prompts": [
      {
        "id": "<string>",
        "agent_id": "<string>",
        "welcome_message": "<string>",
        "prompt": "<string>",
        "voice_id": "<string>",
        "voice_name": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "team_id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

AgentMetaDataRequest

​
name
string | null
​
greeting_message
string | null
​
prompt
string | null
​
tools
string[] | null
​
post_processing_agents
string[] | null
​
variables
string[] | null
​
voice_id
string | null
​
voice_name
string | null
​
gpt_model_id
string | null
​
language
string | null
default:multi
​
time_limit
integer
default:120
Required range: x >= 1
​
start_with_greeting
boolean
default:false
​
millis_sip_endpoint
string | null
​
voice_speed
number
default:1
Required range: 0 <= x <= 2
​
voice_volume
number
default:1
Required range: 0 <= x <= 2
​
background_noise
boolean
default:false
​
suggestion_reason
string | null
​
provider
string
default:openai
​
model
string
default:gpt-4o
​
voice_provider
string
default:vapi
​
voice_model
string | null
default:eleven_turbo_v2
​
agent_description
string | null
​
silence_timeout_seconds
integer
default:15
Required range: 1 <= x <= 3600
​
voice_mail_detection
boolean
default:true
​
speaking_plan_num_words
integer
default:3
Required range: 1 <= x <= 10
​
allow_interruptions
boolean | null
​
pixel_is_lead
boolean
default:false
​
pixel_is_sale
boolean
default:false
​
pixel_sale_amount
integer
default:0

Response

AgentResource

​
data
AgentResource · object
required