List Assistants
curl --request GET \
--url https://app.famulor.de/api/user/assistants/get \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.de/api/user/assistants/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.famulor.de/api/user/assistants/get"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.famulor.de/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.famulor.de/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))
}{
"data": [
{
"id": 123,
"user_id": 456,
"phone_number_id": 789,
"engine_id": 1,
"synthesizer_id": 2,
"transcriber_id": 3,
"voice_id": 4,
"instance_id": 5,
"name": "Sales Assistant",
"variables": {
"company_name": "Famulor",
"product_focus": "AI Telephony"
},
"post_call_evaluation": true,
"fillers": 1,
"post_call_schema": [
{
"name": "customer_interested",
"type": "boolean",
"description": "Is the customer interested?"
}
],
"tools": [
{
"type": "end_call",
"data": {
"description": "End call when done"
}
},
{
"type": "assistant_transfer",
"data": {
"description": "Transfer to the Support Assistant when the customer needs technical help.",
"assistant_id": 13766,
"message_before_transfer": "Sure — let me transfer you to our support specialist.",
"speak_transfer_greeting": true
}
},
{
"type": "warm_call_transfer",
"data": {
"supervisor_phone": "+14155552001",
"outbound_phone_id": "7",
"description": "Transfer the call to a human supervisor when the customer requests to speak with a real person.",
"custom_sip": false,
"caller_id_mode": "outbound_number",
"hold_music": "hold_music",
"hold_music_volume": 80,
"hold_message": "Please hold while I connect you with a supervisor.",
"summary_instructions": "Introduce the conversation from your perspective:\n- WHO is calling (name, company if mentioned)\n- WHY they called (their goal or problem)\n- WHY a human is needed at this point\n\nKeep it brief (2-3 sentences).",
"briefing_initial_message": "Hello! I have a caller on the line who needs your assistance. May I brief you on the situation?",
"connected_message": "You are now connected with a supervisor. I'll leave you to it."
}
}
],
"is_webhook_active": true,
"webhook_url": "https://example.com/webhook",
"inbound_webhook_url": "https://example.com/inbound-webhook",
"language": "de",
"type": "outbound",
"status": "active",
"max_duration": 1800,
"record": true,
"initial_message": "Good day! I'm calling from Famulor...",
"system_prompt": "You are a friendly sales assistant...",
"flows_platform_id": null,
"timezone": "Europe/Berlin",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"max_silence_duration": 3,
"reengagement_interval": 5,
"deleted_at": null,
"end_call_on_voicemail": 1,
"llm_temperature": "0.7",
"voice_stability": "0.8",
"voice_similarity": "0.9",
"allow_interruptions": true,
"enable_noise_cancellation": true,
"endpoint_sensitivity": 0.5,
"speech_speed": "1.0",
"endpoint_type": "vad",
"wait_for_customer": false,
"mode": "pipeline",
"language_id": 1,
"transcriber_provider_id": 1,
"synthesizer_provider_id": 1,
"llm_model_id": 1,
"multimodal_model_id": null,
"ambient_sound": "office",
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"send_webhook_only_on_completed": true,
"include_recording_in_webhook": false,
"interrupt_sensitivity": 0.3,
"filler_config": {
"enabled": true,
"phrases": ["Hmm...", "I understand..."]
},
"knowledgebase_id": 100,
"knowledgebase_mode": "semantic",
"min_interrupt_words": 2,
"ambient_sound_volume": "0.3",
"widget_settings": {
"enabled": false
}
}
],
"current_page": 1,
"per_page": 10,
"total": 1,
"last_page": 1
}
List Assistants
List all assistants for the authenticated user with pagination
GET
/
api
/
user
/
assistants
/
get
List Assistants
curl --request GET \
--url https://app.famulor.de/api/user/assistants/get \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.de/api/user/assistants/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.famulor.de/api/user/assistants/get"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.famulor.de/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.famulor.de/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))
}{
"data": [
{
"id": 123,
"user_id": 456,
"phone_number_id": 789,
"engine_id": 1,
"synthesizer_id": 2,
"transcriber_id": 3,
"voice_id": 4,
"instance_id": 5,
"name": "Sales Assistant",
"variables": {
"company_name": "Famulor",
"product_focus": "AI Telephony"
},
"post_call_evaluation": true,
"fillers": 1,
"post_call_schema": [
{
"name": "customer_interested",
"type": "boolean",
"description": "Is the customer interested?"
}
],
"tools": [
{
"type": "end_call",
"data": {
"description": "End call when done"
}
},
{
"type": "assistant_transfer",
"data": {
"description": "Transfer to the Support Assistant when the customer needs technical help.",
"assistant_id": 13766,
"message_before_transfer": "Sure — let me transfer you to our support specialist.",
"speak_transfer_greeting": true
}
},
{
"type": "warm_call_transfer",
"data": {
"supervisor_phone": "+14155552001",
"outbound_phone_id": "7",
"description": "Transfer the call to a human supervisor when the customer requests to speak with a real person.",
"custom_sip": false,
"caller_id_mode": "outbound_number",
"hold_music": "hold_music",
"hold_music_volume": 80,
"hold_message": "Please hold while I connect you with a supervisor.",
"summary_instructions": "Introduce the conversation from your perspective:\n- WHO is calling (name, company if mentioned)\n- WHY they called (their goal or problem)\n- WHY a human is needed at this point\n\nKeep it brief (2-3 sentences).",
"briefing_initial_message": "Hello! I have a caller on the line who needs your assistance. May I brief you on the situation?",
"connected_message": "You are now connected with a supervisor. I'll leave you to it."
}
}
],
"is_webhook_active": true,
"webhook_url": "https://example.com/webhook",
"inbound_webhook_url": "https://example.com/inbound-webhook",
"language": "de",
"type": "outbound",
"status": "active",
"max_duration": 1800,
"record": true,
"initial_message": "Good day! I'm calling from Famulor...",
"system_prompt": "You are a friendly sales assistant...",
"flows_platform_id": null,
"timezone": "Europe/Berlin",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"max_silence_duration": 3,
"reengagement_interval": 5,
"deleted_at": null,
"end_call_on_voicemail": 1,
"llm_temperature": "0.7",
"voice_stability": "0.8",
"voice_similarity": "0.9",
"allow_interruptions": true,
"enable_noise_cancellation": true,
"endpoint_sensitivity": 0.5,
"speech_speed": "1.0",
"endpoint_type": "vad",
"wait_for_customer": false,
"mode": "pipeline",
"language_id": 1,
"transcriber_provider_id": 1,
"synthesizer_provider_id": 1,
"llm_model_id": 1,
"multimodal_model_id": null,
"ambient_sound": "office",
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"send_webhook_only_on_completed": true,
"include_recording_in_webhook": false,
"interrupt_sensitivity": 0.3,
"filler_config": {
"enabled": true,
"phrases": ["Hmm...", "I understand..."]
},
"knowledgebase_id": 100,
"knowledgebase_mode": "semantic",
"min_interrupt_words": 2,
"ambient_sound_volume": "0.3",
"widget_settings": {
"enabled": false
}
}
],
"current_page": 1,
"per_page": 10,
"total": 1,
"last_page": 1
}
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
Array of assistants
Show Assistant Properties
Show Assistant 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 for the assistant
boolean
Whether post-call evaluation is enabled
integer
Whether filler audio is enabled (1 = enabled, 0 = disabled)
array
Schema definition for post-call data extraction
array
Array of built-in tools configured on the assistant. Each item has
type (tool identifier) and data (tool-specific settings). This response shape differs from the flat object used in Create and Update requests.Show Response item shape
Show Response item shape
type— e.g.end_call,call_transfer,warm_call_transfer,dtmf_input,collect_keypad,calendar_integration,assistant_transferdata— object with the tool’s configuration fields (same names as in the request body, nested underdatainstead of top-level)
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 calls should be recorded
string
The first 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
Date and time when the assistant was created
string
Date and time of the last update to the assistant
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 the call should end upon voicemail detection (1 = yes, 0 = no)
string
LLM temperature setting as a string
string
Voice stability setting as a string
string
Voice similarity setting as a string
boolean
Whether interruptions by the caller are allowed
boolean
Whether noise cancellation is enabled
number
Endpoint sensitivity level
string
Speech speed multiplier as a string
string
Voice activity detection type (vad or ai)
boolean
Whether to wait for the first customer speech input
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 webhooks are sent only for completed calls
boolean
Whether recording URL should be included in webhook payload
number
Interruption sensitivity level
object
Configuration for filler audio responses
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 as a string
object
Settings for web widget integration
integer
Ring time in seconds before ending the call
integer
Maximum initial silence duration in seconds
integer
The current page number
integer
Number of items per page
integer
Total number of assistants
integer
The last page number
{
"data": [
{
"id": 123,
"user_id": 456,
"phone_number_id": 789,
"engine_id": 1,
"synthesizer_id": 2,
"transcriber_id": 3,
"voice_id": 4,
"instance_id": 5,
"name": "Sales Assistant",
"variables": {
"company_name": "Famulor",
"product_focus": "AI Telephony"
},
"post_call_evaluation": true,
"fillers": 1,
"post_call_schema": [
{
"name": "customer_interested",
"type": "boolean",
"description": "Is the customer interested?"
}
],
"tools": [
{
"type": "end_call",
"data": {
"description": "End call when done"
}
},
{
"type": "assistant_transfer",
"data": {
"description": "Transfer to the Support Assistant when the customer needs technical help.",
"assistant_id": 13766,
"message_before_transfer": "Sure — let me transfer you to our support specialist.",
"speak_transfer_greeting": true
}
},
{
"type": "warm_call_transfer",
"data": {
"supervisor_phone": "+14155552001",
"outbound_phone_id": "7",
"description": "Transfer the call to a human supervisor when the customer requests to speak with a real person.",
"custom_sip": false,
"caller_id_mode": "outbound_number",
"hold_music": "hold_music",
"hold_music_volume": 80,
"hold_message": "Please hold while I connect you with a supervisor.",
"summary_instructions": "Introduce the conversation from your perspective:\n- WHO is calling (name, company if mentioned)\n- WHY they called (their goal or problem)\n- WHY a human is needed at this point\n\nKeep it brief (2-3 sentences).",
"briefing_initial_message": "Hello! I have a caller on the line who needs your assistance. May I brief you on the situation?",
"connected_message": "You are now connected with a supervisor. I'll leave you to it."
}
}
],
"is_webhook_active": true,
"webhook_url": "https://example.com/webhook",
"inbound_webhook_url": "https://example.com/inbound-webhook",
"language": "de",
"type": "outbound",
"status": "active",
"max_duration": 1800,
"record": true,
"initial_message": "Good day! I'm calling from Famulor...",
"system_prompt": "You are a friendly sales assistant...",
"flows_platform_id": null,
"timezone": "Europe/Berlin",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"max_silence_duration": 3,
"reengagement_interval": 5,
"deleted_at": null,
"end_call_on_voicemail": 1,
"llm_temperature": "0.7",
"voice_stability": "0.8",
"voice_similarity": "0.9",
"allow_interruptions": true,
"enable_noise_cancellation": true,
"endpoint_sensitivity": 0.5,
"speech_speed": "1.0",
"endpoint_type": "vad",
"wait_for_customer": false,
"mode": "pipeline",
"language_id": 1,
"transcriber_provider_id": 1,
"synthesizer_provider_id": 1,
"llm_model_id": 1,
"multimodal_model_id": null,
"ambient_sound": "office",
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"send_webhook_only_on_completed": true,
"include_recording_in_webhook": false,
"interrupt_sensitivity": 0.3,
"filler_config": {
"enabled": true,
"phrases": ["Hmm...", "I understand..."]
},
"knowledgebase_id": 100,
"knowledgebase_mode": "semantic",
"min_interrupt_words": 2,
"ambient_sound_volume": "0.3",
"widget_settings": {
"enabled": false
}
}
],
"current_page": 1,
"per_page": 10,
"total": 1,
"last_page": 1
}
Related pages: Introduction and Authentication Guide, and API Integration Examples.
Was this page helpful?
⌘I