Request
- Base URL: https://app.famulor.de/api
- URL: https://app.famulor.de/api/user/assistant
- Auth: HTTP bearer
Request body
The name of the assistant (max. 255 characters)
The voice ID for the assistant. Use the endpoint Retrieve Voices with the query parameter mode to get compatible voices for your engine mode.
The language ID for the assistant. Use the endpoint Retrieve Languages to get available languages.
The assistant type. Options: inbound, outbound
The engine mode. Options: pipeline, multimodal, dualplex
The time zone of the assistant (e.g., "Europe/Berlin", "America/New_York")
The first message the assistant speaks at the start of the call (max. 200 characters)
The system prompt that defines the assistant’s behavior and personality
The LLM model ID. Required for mode pipeline.
Use the endpoint Retrieve Models to get available models.
The multimodal model ID. Required for modes multimodal and dualplex.
Use the endpoint Retrieve Models to get available multimodal models.
Fallback LLM model ID for tool calls in multimodal/dualplex. Optional.
Sensitivity of turn detection in multimodal/dualplex (0-1). Default: auto
Array of additional language IDs that the assistant can speak. The assistant automatically recognizes the language and switches accordingly.
The knowledgebase ID to attach to this assistant
How to use the knowledgebase. Options:
- function_call - AI calls a function to search (required for multimodal/dualplex)
- prompt - Knowledge is injected into prompt (pipeline only)
ID of a folder to place this assistant in. Must belong to your account. Send null to leave the assistant uncategorized.
Array of label IDs to apply to this assistant. Each label must belong to your account.
The ID of a phone number to assign to the assistant. Must belong to your account.
<Warning> For `inbound` assistants, the phone number must not be a caller ID type and must not already be assigned to another `inbound` assistant. </Warning>Array of IDs for custom mid-call tools to attach. Each tool must belong to your account.
Whether emotional text-to-speech synthesis is enabled
Voice stability (0-1). Higher = more consistent
Voice similarity (0-1). Higher = closer to the original
Speech speed multiplier (0.7-1.2)
LLM temperature (0-1). Lower = more deterministic
Custom TTS provider ID. If not set, selected automatically based on language. See Retrieve Synthesizer Providers.
Custom STT provider ID. If not set, selected automatically based on language. Only for pipeline. See Retrieve Transcriber Providers.
Whether interruptions from the caller are allowed.
<Warning>Cannot be disabled for multimodal and dualplex.</Warning>
Whether filler audio should be used during processing (e.g., "uh", "just a moment").
<Warning>Only available in pipeline mode.</Warning>
Custom filler profiles per category. If not specified, language-dependent defaults are used. Each category is an array of short phrases.
- positive: Fillers for affirmative responses (e.g., "Great!", "Perfect!")
- negative: Fillers for negative/neutral responses (e.g., "Hmm.", "Mhm.")
- question: Fillers while processing a question (e.g., "Good question.", "One moment.")
- neutral: Fillers for neutral acknowledgments (e.g., "Okay.", "Understood.")
Whether the call should be recorded
Whether noise cancellation should be enabled
If true, the assistant waits for the customer to speak first
Maximum call duration in seconds (20-1200)
Maximum silence duration until re-engagement in seconds (1-360)
Maximum silence directly after call start before termination (1-120 seconds). Optional.
Maximum ringing time before canceling (1-60 seconds)
Re-engagement interval in seconds (7-600)
Custom prompt for re-engagement messages (max. 1000 characters)
Example: "Are you still there? Do you have any other questions?"
Whether to end the call if voicemail is detected
Message to leave on voicemail (max. 1000 characters)
Voice activity detection type. Options: vad, ai
Endpoint sensitivity (0-5)
Interrupt sensitivity (0-5)
Minimum number of words before interruption is allowed (0-10). Set to enable.
Background ambient sound. Options: off, office, city, forest, crowded_room, cafe, nature
Ambient sound volume (0-1)
Whether webhook notifications are enabled
The webhook URL for post-call notifications. Required if is_webhook_active is true.
Whether to send webhooks only for completed calls (not for failed/no-answer)
Whether to include the recording URL in the webhook payload
Whether AI post-call evaluation is enabled
Key-value pairs of custom variables that can be used in prompts via {{variable_name}}
Minutes of chat inactivity before the conversation is considered ended (1–1440)
Whether the conversation can be restarted after inactivity end
Webhook URL invoked when a chat conversation ends due to inactivity. Separate from the call webhook.
Response
Success Response
Success message confirming the creation of the assistant
Changes
No recorded changes to this operation across all 1 revision of this API.