List assistants
curl --request GET \
--url https://app.voxial.pt/api/user/assistants/get \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.voxial.pt/api/user/assistants/get"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.voxial.pt/api/user/assistants/get', 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://app.voxial.pt/api/user/assistants/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.voxial.pt/api/user/assistants/get"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.voxial.pt/api/user/assistants/get")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voxial.pt/api/user/assistants/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"current_page": 1,
"data": [
{
"id": 127,
"user_id": 1,
"phone_number_id": 45,
"engine_id": null,
"synthesizer_id": null,
"transcriber_id": null,
"voice_id": 8,
"instance_id": 1,
"name": "Sales Outreach Assistant",
"variables": {
"company_name": "Your Company",
"product_line": "Premium Services",
"rep_name": "Assistant"
},
"post_call_evaluation": true,
"fillers": 1,
"post_call_schema": [
{
"name": "interest_level",
"type": "string",
"description": "Customer's level of interest (high, medium, low)"
},
{
"name": "budget_qualified",
"type": "bool",
"description": "Whether the prospect has adequate budget"
},
{
"name": "follow_up_date",
"type": "string",
"description": "Preferred date for follow-up contact"
}
],
"tools": [],
"is_webhook_active": true,
"webhook_url": "https://yourcompany.com/api/webhooks/sales-calls",
"inbound_webhook_url": null,
"language": null,
"type": "outbound",
"status": "active",
"max_duration": 900,
"record": true,
"initial_message": "Hi, this is an assistant from Your Company. I hope I'm catching you at a good time. How are you doing today?",
"system_prompt": "You are a sales representative for Your Company. Be professional, friendly, and focus on qualifying leads for premium services.",
"flows_platform_id": null,
"timezone": "America/Los_Angeles",
"created_at": "2025-07-15T14:32:15.000000Z",
"updated_at": "2025-08-02T09:18:42.000000Z",
"max_silence_duration": 25,
"reengagement_interval": 45,
"deleted_at": null,
"end_call_on_voicemail": 1,
"llm_temperature": "0.35",
"voice_stability": "0.75",
"voice_similarity": "0.85",
"allow_interruptions": true,
"enable_noise_cancellation": true,
"endpoint_sensitivity": 1.8,
"speech_speed": "1.10",
"endpoint_type": "vad",
"wait_for_customer": true,
"mode": "pipeline",
"language_id": 1,
"transcriber_provider_id": null,
"synthesizer_provider_id": null,
"llm_model_id": 3,
"multimodal_model_id": null,
"ambient_sound": "office",
"uuid": "a7b3c942-5f1e-4d28-8c59-2e4f7a8b9c3d",
"send_webhook_only_on_completed": true,
"include_recording_in_webhook": true,
"interrupt_sensitivity": 1.2,
"filler_config": {
"neutral": [
"I see.",
"Understood.",
"Right.",
"Got it.",
"Okay."
],
"negative": [
"I understand.",
"Hmm.",
"I see.",
"Okay."
],
"positive": [
"Excellent!",
"That's great!",
"Wonderful!",
"Perfect!"
],
"question": [
"Let me think...",
"Good question.",
"Hmm.",
"Right."
]
},
"knowledgebase_id": 12,
"knowledgebase_mode": "hybrid",
"min_interrupt_words": 3,
"ambient_sound_volume": "0.30",
"widget_settings": {
"theme": "modern",
"color": "#2563eb",
"position": "bottom-right"
}
}
],
"first_page_url": "https://app.voxial.pt/api/user/assistants/get?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "https://app.voxial.pt/api/user/assistants/get?page=5",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://app.voxial.pt/api/user/assistants/get?page=1",
"label": "1",
"active": true
},
{
"url": "https://app.voxial.pt/api/user/assistants/get?page=2",
"label": "2",
"active": false
}
],
"next_page_url": "https://app.voxial.pt/api/user/assistants/get?page=2",
"path": "https://app.voxial.pt/api/user/assistants/get",
"per_page": 10,
"prev_page_url": null,
"to": 10,
"total": 47
}
Assistants
List assistants
List all assistants for the authenticated user with pagination
GET
/
user
/
assistants
/
get
List assistants
curl --request GET \
--url https://app.voxial.pt/api/user/assistants/get \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.voxial.pt/api/user/assistants/get"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.voxial.pt/api/user/assistants/get', 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://app.voxial.pt/api/user/assistants/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.voxial.pt/api/user/assistants/get"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.voxial.pt/api/user/assistants/get")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voxial.pt/api/user/assistants/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"current_page": 1,
"data": [
{
"id": 127,
"user_id": 1,
"phone_number_id": 45,
"engine_id": null,
"synthesizer_id": null,
"transcriber_id": null,
"voice_id": 8,
"instance_id": 1,
"name": "Sales Outreach Assistant",
"variables": {
"company_name": "Your Company",
"product_line": "Premium Services",
"rep_name": "Assistant"
},
"post_call_evaluation": true,
"fillers": 1,
"post_call_schema": [
{
"name": "interest_level",
"type": "string",
"description": "Customer's level of interest (high, medium, low)"
},
{
"name": "budget_qualified",
"type": "bool",
"description": "Whether the prospect has adequate budget"
},
{
"name": "follow_up_date",
"type": "string",
"description": "Preferred date for follow-up contact"
}
],
"tools": [],
"is_webhook_active": true,
"webhook_url": "https://yourcompany.com/api/webhooks/sales-calls",
"inbound_webhook_url": null,
"language": null,
"type": "outbound",
"status": "active",
"max_duration": 900,
"record": true,
"initial_message": "Hi, this is an assistant from Your Company. I hope I'm catching you at a good time. How are you doing today?",
"system_prompt": "You are a sales representative for Your Company. Be professional, friendly, and focus on qualifying leads for premium services.",
"flows_platform_id": null,
"timezone": "America/Los_Angeles",
"created_at": "2025-07-15T14:32:15.000000Z",
"updated_at": "2025-08-02T09:18:42.000000Z",
"max_silence_duration": 25,
"reengagement_interval": 45,
"deleted_at": null,
"end_call_on_voicemail": 1,
"llm_temperature": "0.35",
"voice_stability": "0.75",
"voice_similarity": "0.85",
"allow_interruptions": true,
"enable_noise_cancellation": true,
"endpoint_sensitivity": 1.8,
"speech_speed": "1.10",
"endpoint_type": "vad",
"wait_for_customer": true,
"mode": "pipeline",
"language_id": 1,
"transcriber_provider_id": null,
"synthesizer_provider_id": null,
"llm_model_id": 3,
"multimodal_model_id": null,
"ambient_sound": "office",
"uuid": "a7b3c942-5f1e-4d28-8c59-2e4f7a8b9c3d",
"send_webhook_only_on_completed": true,
"include_recording_in_webhook": true,
"interrupt_sensitivity": 1.2,
"filler_config": {
"neutral": [
"I see.",
"Understood.",
"Right.",
"Got it.",
"Okay."
],
"negative": [
"I understand.",
"Hmm.",
"I see.",
"Okay."
],
"positive": [
"Excellent!",
"That's great!",
"Wonderful!",
"Perfect!"
],
"question": [
"Let me think...",
"Good question.",
"Hmm.",
"Right."
]
},
"knowledgebase_id": 12,
"knowledgebase_mode": "hybrid",
"min_interrupt_words": 3,
"ambient_sound_volume": "0.30",
"widget_settings": {
"theme": "modern",
"color": "#2563eb",
"position": "bottom-right"
}
}
],
"first_page_url": "https://app.voxial.pt/api/user/assistants/get?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "https://app.voxial.pt/api/user/assistants/get?page=5",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://app.voxial.pt/api/user/assistants/get?page=1",
"label": "1",
"active": true
},
{
"url": "https://app.voxial.pt/api/user/assistants/get?page=2",
"label": "2",
"active": false
}
],
"next_page_url": "https://app.voxial.pt/api/user/assistants/get?page=2",
"path": "https://app.voxial.pt/api/user/assistants/get",
"per_page": 10,
"prev_page_url": null,
"to": 10,
"total": 47
}
This endpoint allows you to retrieve all AI assistants belonging to the authenticated user.
Query Parameters
integer
Number of assistants per page (1-100, default: 10)
integer
Page number (default: 1)
Response fields
array
Show properties
Show properties
integer
The unique identifier of the assistant
integer
The ID of the user who owns this assistant
integer
The ID of the phone number assigned to the assistant
integer
Engine ID
integer
Synthesizer ID
integer
Transcriber ID
integer
The ID of the voice used by the assistant
integer
The instance ID for the assistant
string
The name of the assistant
object
Custom variables defined for the assistant
boolean
Whether post-call evaluation is enabled
integer
Whether filler audio is enabled (1 = enabled, 0 = disabled)
array
array
Array of tools available to the assistant
boolean
Whether webhook notifications are enabled
string
The webhook URL for post-call notifications
string
The webhook URL for inbound call notifications
string
Language
string
The type of assistant (inbound or outbound)
string
The current status of the assistant (active or inactive)
integer
Maximum call duration in seconds
boolean
Whether to record calls
string
The initial message the assistant will speak
string
The system prompt that defines the assistant’s behavior
integer
ID for flows platform integration
string
The timezone setting for the assistant
string
The date and time when the assistant was created
string
The date and time when the assistant was last updated
integer
Maximum silence duration in seconds before re-engagement
integer
Re-engagement interval in seconds
string
Soft deletion timestamp (null if not deleted)
integer
Whether to end call when voicemail is detected (1 = yes, 0 = no)
string
LLM temperature setting as string
string
Voice stability setting as string
string
Voice similarity setting as string
boolean
Whether to allow caller interruptions
boolean
Whether noise cancellation is enabled
number
Endpoint sensitivity level
string
Speech speed multiplier as string
string
Voice activity detection type (vad or ai)
boolean
Whether to wait for customer to speak first
string
The engine mode (pipeline or multimodal)
integer
The ID of the language used by the assistant
integer
ID of the transcriber provider
integer
ID of the synthesizer provider
integer
ID of the LLM model used
integer
ID of the multimodal model used
string
Ambient sound setting
string
Unique UUID for the assistant
boolean
Whether to send webhooks only on completed calls
boolean
Whether to include recording URL in webhook payload
number
Interrupt sensitivity level
object
integer
ID of the associated knowledge base
string
Knowledge base mode setting
integer
Minimum number of words before interruption is allowed
string
Ambient sound volume level as string
object
Settings for web widget integration
integer
The current page number
integer
Number of items per page
integer
Total number of assistants
integer
The last page number
{
"current_page": 1,
"data": [
{
"id": 127,
"user_id": 1,
"phone_number_id": 45,
"engine_id": null,
"synthesizer_id": null,
"transcriber_id": null,
"voice_id": 8,
"instance_id": 1,
"name": "Sales Outreach Assistant",
"variables": {
"company_name": "Your Company",
"product_line": "Premium Services",
"rep_name": "Assistant"
},
"post_call_evaluation": true,
"fillers": 1,
"post_call_schema": [
{
"name": "interest_level",
"type": "string",
"description": "Customer's level of interest (high, medium, low)"
},
{
"name": "budget_qualified",
"type": "bool",
"description": "Whether the prospect has adequate budget"
},
{
"name": "follow_up_date",
"type": "string",
"description": "Preferred date for follow-up contact"
}
],
"tools": [],
"is_webhook_active": true,
"webhook_url": "https://yourcompany.com/api/webhooks/sales-calls",
"inbound_webhook_url": null,
"language": null,
"type": "outbound",
"status": "active",
"max_duration": 900,
"record": true,
"initial_message": "Hi, this is an assistant from Your Company. I hope I'm catching you at a good time. How are you doing today?",
"system_prompt": "You are a sales representative for Your Company. Be professional, friendly, and focus on qualifying leads for premium services.",
"flows_platform_id": null,
"timezone": "America/Los_Angeles",
"created_at": "2025-07-15T14:32:15.000000Z",
"updated_at": "2025-08-02T09:18:42.000000Z",
"max_silence_duration": 25,
"reengagement_interval": 45,
"deleted_at": null,
"end_call_on_voicemail": 1,
"llm_temperature": "0.35",
"voice_stability": "0.75",
"voice_similarity": "0.85",
"allow_interruptions": true,
"enable_noise_cancellation": true,
"endpoint_sensitivity": 1.8,
"speech_speed": "1.10",
"endpoint_type": "vad",
"wait_for_customer": true,
"mode": "pipeline",
"language_id": 1,
"transcriber_provider_id": null,
"synthesizer_provider_id": null,
"llm_model_id": 3,
"multimodal_model_id": null,
"ambient_sound": "office",
"uuid": "a7b3c942-5f1e-4d28-8c59-2e4f7a8b9c3d",
"send_webhook_only_on_completed": true,
"include_recording_in_webhook": true,
"interrupt_sensitivity": 1.2,
"filler_config": {
"neutral": [
"I see.",
"Understood.",
"Right.",
"Got it.",
"Okay."
],
"negative": [
"I understand.",
"Hmm.",
"I see.",
"Okay."
],
"positive": [
"Excellent!",
"That's great!",
"Wonderful!",
"Perfect!"
],
"question": [
"Let me think...",
"Good question.",
"Hmm.",
"Right."
]
},
"knowledgebase_id": 12,
"knowledgebase_mode": "hybrid",
"min_interrupt_words": 3,
"ambient_sound_volume": "0.30",
"widget_settings": {
"theme": "modern",
"color": "#2563eb",
"position": "bottom-right"
}
}
],
"first_page_url": "https://app.voxial.pt/api/user/assistants/get?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "https://app.voxial.pt/api/user/assistants/get?page=5",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://app.voxial.pt/api/user/assistants/get?page=1",
"label": "1",
"active": true
},
{
"url": "https://app.voxial.pt/api/user/assistants/get?page=2",
"label": "2",
"active": false
}
],
"next_page_url": "https://app.voxial.pt/api/user/assistants/get?page=2",
"path": "https://app.voxial.pt/api/user/assistants/get",
"per_page": 10,
"prev_page_url": null,
"to": 10,
"total": 47
}
⌘I