Agents
Create an agent
Requires agents:write.
POST
/
v1
/
agents
Create an agent
curl --request POST \
--url https://api.voice.wixzel.com/v1/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"system_prompt": "<string>",
"opening_message": "<string>",
"voice": {
"turn_taking": {
"interrupt_sensitivity": "normal",
"silence_wait_ms": 2550
}
},
"language": "en-US",
"knowledge_base_id": "6a96a3ead6e886d42462dd3e",
"outbound_phone_number_id": "6a96a3ead6e886d42462dd3e",
"appointment_booking_enabled": false
}
'import requests
url = "https://api.voice.wixzel.com/v1/agents"
payload = {
"name": "<string>",
"system_prompt": "<string>",
"opening_message": "<string>",
"voice": { "turn_taking": {
"interrupt_sensitivity": "normal",
"silence_wait_ms": 2550
} },
"language": "en-US",
"knowledge_base_id": "6a96a3ead6e886d42462dd3e",
"outbound_phone_number_id": "6a96a3ead6e886d42462dd3e",
"appointment_booking_enabled": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
system_prompt: '<string>',
opening_message: '<string>',
voice: {turn_taking: {interrupt_sensitivity: 'normal', silence_wait_ms: 2550}},
language: 'en-US',
knowledge_base_id: '6a96a3ead6e886d42462dd3e',
outbound_phone_number_id: '6a96a3ead6e886d42462dd3e',
appointment_booking_enabled: false
})
};
fetch('https://api.voice.wixzel.com/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voice.wixzel.com/v1/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'system_prompt' => '<string>',
'opening_message' => '<string>',
'voice' => [
'turn_taking' => [
'interrupt_sensitivity' => 'normal',
'silence_wait_ms' => 2550
]
],
'language' => 'en-US',
'knowledge_base_id' => '6a96a3ead6e886d42462dd3e',
'outbound_phone_number_id' => '6a96a3ead6e886d42462dd3e',
'appointment_booking_enabled' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voice.wixzel.com/v1/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"opening_message\": \"<string>\",\n \"voice\": {\n \"turn_taking\": {\n \"interrupt_sensitivity\": \"normal\",\n \"silence_wait_ms\": 2550\n }\n },\n \"language\": \"en-US\",\n \"knowledge_base_id\": \"6a96a3ead6e886d42462dd3e\",\n \"outbound_phone_number_id\": \"6a96a3ead6e886d42462dd3e\",\n \"appointment_booking_enabled\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.voice.wixzel.com/v1/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"opening_message\": \"<string>\",\n \"voice\": {\n \"turn_taking\": {\n \"interrupt_sensitivity\": \"normal\",\n \"silence_wait_ms\": 2550\n }\n },\n \"language\": \"en-US\",\n \"knowledge_base_id\": \"6a96a3ead6e886d42462dd3e\",\n \"outbound_phone_number_id\": \"6a96a3ead6e886d42462dd3e\",\n \"appointment_booking_enabled\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voice.wixzel.com/v1/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"opening_message\": \"<string>\",\n \"voice\": {\n \"turn_taking\": {\n \"interrupt_sensitivity\": \"normal\",\n \"silence_wait_ms\": 2550\n }\n },\n \"language\": \"en-US\",\n \"knowledge_base_id\": \"6a96a3ead6e886d42462dd3e\",\n \"outbound_phone_number_id\": \"6a96a3ead6e886d42462dd3e\",\n \"appointment_booking_enabled\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "6a96a3ead6e886d42462dd3e",
"object": "agent",
"name": "<string>",
"system_prompt": "<string>",
"opening_message": "<string>",
"voice": {
"stt": {
"model": "deepgram/nova-3",
"language": "en-US",
"endpointing_ms": 1525
},
"llm": {
"model": "openrouter/gpt-4o-mini",
"temperature": 1,
"max_tokens": 2048
},
"tts": {
"model": "elevenlabs/eleven_turbo_v2_5",
"voice": "21m00Tcm4TlvDq8ikWAM",
"stability": 0.5,
"similarity_boost": 0.5,
"speed": 1.25
},
"realtime": {
"model": "google/gemini-live",
"voice": "Charon",
"language": "auto"
},
"turn_taking": {
"interrupt_sensitivity": "normal",
"silence_wait_ms": 2550
}
},
"language": "<string>",
"knowledge_base_id": "6a96a3ead6e886d42462dd3e",
"outbound_phone_number_id": "6a96a3ead6e886d42462dd3e",
"appointment_booking_enabled": true,
"created_at": "2026-09-01T12:00:00.000Z"
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}Authorizations
Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.
Body
application/json
Required string length:
1 - 200The agent's instructions. Spoken conversation, so keep it short and concrete.
Required string length:
1 - 20000Spoken as soon as the call connects. Supports {{name}} style merge fields. Required — an agent without one answers in silence.
Required string length:
1 - 1000Either a composed pipeline (stt + llm + tts) or a single realtime model. Not both.
Show child attributes
Show child attributes
Pattern:
^[0-9a-f]{24}$Example:
"6a96a3ead6e886d42462dd3e"
Pattern:
^[0-9a-f]{24}$Example:
"6a96a3ead6e886d42462dd3e"
Response
The created an agent
Pattern:
^[0-9a-f]{24}$Example:
"6a96a3ead6e886d42462dd3e"
Available options:
agent Either a composed pipeline (stt + llm + tts) or a single realtime model. Not both.
Show child attributes
Show child attributes
Pattern:
^[0-9a-f]{24}$Example:
"6a96a3ead6e886d42462dd3e"
Pattern:
^[0-9a-f]{24}$Example:
"6a96a3ead6e886d42462dd3e"
ISO 8601, always UTC.
Example:
"2026-09-01T12:00:00.000Z"
⌘I
Create an agent
curl --request POST \
--url https://api.voice.wixzel.com/v1/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"system_prompt": "<string>",
"opening_message": "<string>",
"voice": {
"turn_taking": {
"interrupt_sensitivity": "normal",
"silence_wait_ms": 2550
}
},
"language": "en-US",
"knowledge_base_id": "6a96a3ead6e886d42462dd3e",
"outbound_phone_number_id": "6a96a3ead6e886d42462dd3e",
"appointment_booking_enabled": false
}
'import requests
url = "https://api.voice.wixzel.com/v1/agents"
payload = {
"name": "<string>",
"system_prompt": "<string>",
"opening_message": "<string>",
"voice": { "turn_taking": {
"interrupt_sensitivity": "normal",
"silence_wait_ms": 2550
} },
"language": "en-US",
"knowledge_base_id": "6a96a3ead6e886d42462dd3e",
"outbound_phone_number_id": "6a96a3ead6e886d42462dd3e",
"appointment_booking_enabled": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
system_prompt: '<string>',
opening_message: '<string>',
voice: {turn_taking: {interrupt_sensitivity: 'normal', silence_wait_ms: 2550}},
language: 'en-US',
knowledge_base_id: '6a96a3ead6e886d42462dd3e',
outbound_phone_number_id: '6a96a3ead6e886d42462dd3e',
appointment_booking_enabled: false
})
};
fetch('https://api.voice.wixzel.com/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voice.wixzel.com/v1/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'system_prompt' => '<string>',
'opening_message' => '<string>',
'voice' => [
'turn_taking' => [
'interrupt_sensitivity' => 'normal',
'silence_wait_ms' => 2550
]
],
'language' => 'en-US',
'knowledge_base_id' => '6a96a3ead6e886d42462dd3e',
'outbound_phone_number_id' => '6a96a3ead6e886d42462dd3e',
'appointment_booking_enabled' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voice.wixzel.com/v1/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"opening_message\": \"<string>\",\n \"voice\": {\n \"turn_taking\": {\n \"interrupt_sensitivity\": \"normal\",\n \"silence_wait_ms\": 2550\n }\n },\n \"language\": \"en-US\",\n \"knowledge_base_id\": \"6a96a3ead6e886d42462dd3e\",\n \"outbound_phone_number_id\": \"6a96a3ead6e886d42462dd3e\",\n \"appointment_booking_enabled\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.voice.wixzel.com/v1/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"opening_message\": \"<string>\",\n \"voice\": {\n \"turn_taking\": {\n \"interrupt_sensitivity\": \"normal\",\n \"silence_wait_ms\": 2550\n }\n },\n \"language\": \"en-US\",\n \"knowledge_base_id\": \"6a96a3ead6e886d42462dd3e\",\n \"outbound_phone_number_id\": \"6a96a3ead6e886d42462dd3e\",\n \"appointment_booking_enabled\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voice.wixzel.com/v1/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"opening_message\": \"<string>\",\n \"voice\": {\n \"turn_taking\": {\n \"interrupt_sensitivity\": \"normal\",\n \"silence_wait_ms\": 2550\n }\n },\n \"language\": \"en-US\",\n \"knowledge_base_id\": \"6a96a3ead6e886d42462dd3e\",\n \"outbound_phone_number_id\": \"6a96a3ead6e886d42462dd3e\",\n \"appointment_booking_enabled\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "6a96a3ead6e886d42462dd3e",
"object": "agent",
"name": "<string>",
"system_prompt": "<string>",
"opening_message": "<string>",
"voice": {
"stt": {
"model": "deepgram/nova-3",
"language": "en-US",
"endpointing_ms": 1525
},
"llm": {
"model": "openrouter/gpt-4o-mini",
"temperature": 1,
"max_tokens": 2048
},
"tts": {
"model": "elevenlabs/eleven_turbo_v2_5",
"voice": "21m00Tcm4TlvDq8ikWAM",
"stability": 0.5,
"similarity_boost": 0.5,
"speed": 1.25
},
"realtime": {
"model": "google/gemini-live",
"voice": "Charon",
"language": "auto"
},
"turn_taking": {
"interrupt_sensitivity": "normal",
"silence_wait_ms": 2550
}
},
"language": "<string>",
"knowledge_base_id": "6a96a3ead6e886d42462dd3e",
"outbound_phone_number_id": "6a96a3ead6e886d42462dd3e",
"appointment_booking_enabled": true,
"created_at": "2026-09-01T12:00:00.000Z"
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}
