Skip to content

Initiate a test call with voice AI agent configuration

POST
/voice/test

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
phoneNumber
required
string
config
required
object
instructions
required
string
firstAction
required
string
Allowed values: speak wait
greeting
string
aiModel
required
string
sttConfig
object
provider
required
string
Allowed values: deepgram openai assemblyai
model
string
language
string
ttsConfig
object
provider
required
string
Allowed values: elevenlabs cartesia openai
voiceId
string
model
string
speed
number
tools
Array<object>
object
name
required
string
description
required
string
parameters
required
object
key
additional properties
temperature
number
maxTokens
number
maxCallLengthSeconds
number
silenceTimeoutSeconds
number
recordingEnabled
boolean
endpointingMode
string
Allowed values: smart vad
minEndOfTurnSilenceMs
number
allowInterruptions
boolean
minInterruptionDurationMs
number

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

object
callControlId
required
string
websocket
required
string

400

Section titled “400 ”

Bad Request - validation errors, invalid input

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
provider

Provider that caused the error (e.g. telnyx, ses).

string
providerCode

Provider-specific error code.

string

401

Section titled “401 ”

Unauthorized

402

Section titled “402 ”

Payment Required - usage limits exceeded

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
provider

Provider that caused the error (e.g. telnyx, ses).

string
providerCode

Provider-specific error code.

string

500

Section titled “500 ”

Internal Server Error

502

Section titled “502 ”

Bad Gateway - provider error

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
provider

Provider that caused the error (e.g. telnyx, ses).

string
providerCode

Provider-specific error code.

string