List Assistants
curl --request GET \
--url https://app.famulor.de/api/user/assistants/get \
--header 'Authorization: Bearer <token>'{
"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>'{
"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
Number of assistants per page (1-100, default: 10)
Page number (default: 1)
Response Fields
Array of assistants
Show Assistant Properties
Show Assistant Properties
The unique identifier of the assistant
The ID of the user who owns this assistant
The ID of the phone number assigned to the assistant
Engine ID
Synthesizer ID
Transcriber ID
The ID of the voice used by the assistant
The instance ID for the assistant
The name of the assistant
Custom variables for the assistant
Whether post-call evaluation is enabled
Whether filler audio is enabled (1 = enabled, 0 = disabled)
Schema definition for post-call data extraction
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)
Whether webhook notifications are enabled
The webhook URL for post-call notifications
The webhook URL for inbound call notifications
Language
The type of assistant (inbound or outbound)
The current status of the assistant (active or inactive)
Maximum call duration in seconds
Whether calls should be recorded
The first message the assistant will speak
The system prompt that defines the assistant’s behavior
ID for Flows platform integration
The timezone setting for the assistant
Date and time when the assistant was created
Date and time of the last update to the assistant
Maximum silence duration in seconds before re-engagement
Re-engagement interval in seconds
Soft deletion timestamp (null if not deleted)
Whether the call should end upon voicemail detection (1 = yes, 0 = no)
LLM temperature setting as a string
Voice stability setting as a string
Voice similarity setting as a string
Whether interruptions by the caller are allowed
Whether noise cancellation is enabled
Endpoint sensitivity level
Speech speed multiplier as a string
Voice activity detection type (vad or ai)
Whether to wait for the first customer speech input
The engine mode (pipeline or multimodal)
The ID of the language used by the assistant
ID of the transcriber provider
ID of the synthesizer provider
ID of the LLM model used
ID of the multimodal model used
Ambient sound setting
Unique UUID for the assistant
Whether webhooks are sent only for completed calls
Whether recording URL should be included in webhook payload
Interruption sensitivity level
Configuration for filler audio responses
ID of the associated knowledge base
Knowledge base mode setting
Minimum number of words before interruption is allowed
Ambient sound volume as a string
Settings for web widget integration
Ring time in seconds before ending the call
Maximum initial silence duration in seconds
The current page number
Number of items per page
Total number of assistants
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