Skip to main content
POST
Create a test agent

Authorizations

Authorization
string
header
required

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

Body

application/json
agent_name
string
required

Name of the test agent.

assistant_id
string
required

ID of the Telnyx AI assistant under test.

description
string
contact_number
string
language
string

ISO language code the test agent converses in.

llm_model
string
llm_system_prompt
string
llm_temperature
number
llm_max_tokens
integer
sip_endpoint
string
inbound
boolean
outbound_auto_call
boolean
auto_update_dropoff_nodes
boolean
auto_update_topic_nodes
boolean
auto_fetch_calls_enabled
boolean
auto_sync_prompt_enabled
boolean

Response

Test agent created.

id
integer
required
agent_name
string
required

Name of the test agent.

assistant_id
string
required

ID of the Telnyx AI assistant under test.

created_at
string<date-time>
required
updated_at
string<date-time>
required
contact_number
string

Contact phone number for the test agent.

inbound
boolean

Whether the test agent accepts inbound calls.

description
string
language
string

ISO language code the test agent converses in.

chat_assistant_id
string

ID of the chat assistant under test, when testing text channels.

llm_system_prompt
string
llm_model
string

Model used to drive the test agent's side of the conversation.

llm_temperature
number
llm_max_tokens
integer
outbound_auto_call
boolean
sip_endpoint
string
sip_auth
object | null
knowledge_base_files
any[]

Knowledge-base files associated with the test agent.

enabled_personalities
integer[]

IDs of the test personalities enabled for this agent.

auto_update_dropoff_nodes
boolean
auto_update_topic_nodes
boolean
hallucination_metric_kb_files
integer[]
outbound_numbers
any[] | null

Outbound numbers associated with the test agent.