Skip to main content
POST
Create Voice AI Agent

Authorizations

string
required
Enter your ContactSwing JWT Bearer token.

Request Body

string
required
Assistant display name. Example: "Insurance Darren"
string
required
Assistant type. Example: "VOICE_INCOMING"
string
required
LLM model. Example: "cw-llm-1"

API Keys

array
API key configuration
number
API key ID
string
Key type: MODEL | CALL | DEEPGRAM | VOICE

Instructions

string
required
Detailed agent instructions and behavior rules

Prompts

object
required
Agent prompt configuration
string
Agent system prompt
string
Primary agent goal

Phone & Greetings

string
Assigned phone number. Example: "+13465842882"
string
Greeting played on incoming calls
string
Greeting played on outgoing calls

Voice & Language

string
Voice synthesizer. Example: "AZURE"
string
Voice ID. Example: "en-US-LunaNeural"
string
Language. Example: "english"
boolean
Enable call recordings

Behaviour Settings

object
Agent speaking behavior
string
Speech speed. Example: "medium"
object
Emotional tone levels
string
default:"medium"
string
default:"medium"
string
default:"medium"
string
default:"medium"
string
default:"medium"

Knowledge Base

string
Knowledge base ID (nullable)

Additional Settings

object
object
object
string
string
string
object
string
object
object
string
string
string
string
object
object
string
string[]
object
object
number
number
number
string
number
number
boolean
string
string
number
string
number
boolean
string[]
object
number
number
string[]
string
string
string
string
boolean
boolean
string
boolean

Actions & Meta

string[]
Linked action IDs
number
string
Example: "v1"

Response

201 Created
string
Request context ID
object
string
New assistant ID
string
Assistant name
400 Bad Request – Invalid configuration
401 Unauthorized – Invalid token