Assistants

Update Assistant

Update the configuration of an existing AI assistant

Docs

put/user/assistant/{id}

Request

  • Base URL: https://app.famulor.de/api
  • URL: https://app.famulor.de/api/user/assistant/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

The unique identifier of the assistant to be updated

Request body

namestring

The name of the assistant (max. 255 characters)

voice_idinteger

The voice ID to be used for the assistant. Use the Get Voices endpoint with the mode parameter to get voices compatible with your engine mode.

language_idinteger

The language ID for the assistant. Use the Get Languages endpoint to retrieve available languages.

type'inbound' | 'outbound'

The assistant type. Options: inbound, outbound

mode'pipeline' | 'multimodal' | 'dualplex'

The engine mode. Options: pipeline, multimodal, dualplex

<Warning> Changing the mode resets mode-specific settings to their default values for the new mode. </Warning>
timezonestring

The timezone for the assistant (e.g., "Europe/Berlin", "America/New_York")

initial_messagestring

The initial message the assistant will speak at call start (max. 200 characters)

system_promptstring

The system prompt defining the assistant's behaviour and personality

llm_model_idinteger

The LLM model ID to use. Only applicable in pipeline mode.

Use the Get Models endpoint to retrieve available models.

multimodal_model_idinteger

The multimodal model ID. Applicable only in multimodal and dualplex modes.

Use the Get Models endpoint to retrieve available multimodal models.

chat_llm_fallback_idinteger

Fallback LLM model ID for tool calls in multimodal/dualplex modes. Set to null to remove.

turn_detection_thresholdnumber

Sensitivity of speaker turn detection for multimodal/dualplex modes (0-1). Set to null for automatic.

secondary_language_idsinteger[]

Array of additional language IDs the assistant can speak. Replaces existing secondary languages. Pass an empty array [] to remove all secondary languages.

knowledgebase_idinteger

The ID of the knowledgebase to link. Set to null to remove.

knowledgebase_modestring

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)
folder_idinteger

ID of a folder to move this assistant into. Must belong to your account. Set to null to make it uncategorized. Omit to leave the folder unchanged.

label_idsinteger[]

Array of label IDs for this assistant. Each label must belong to your account. When provided, this replaces the assistant's current labels. Omit to leave labels unchanged; send [] to remove all labels.

phone_number_idinteger

The ID of a phone number to assign. Set to null to unassign. Must belong to your account.

<Warning> For `inbound` assistants, the phone number cannot be a caller ID type and must not already be assigned to another inbound assistant. </Warning>
tool_idsinteger[]

Array of custom mid-call tool IDs to synchronize. Replaces all existing tool assignments. Pass an empty array [] to remove all tools. Each tool must belong to your account.

tts_emotion_enabledboolean

Whether emotional text-to-speech synthesis is enabled

voice_stabilitynumber

Voice stability setting (0-1). Higher = more consistent voice

voice_similaritynumber

Voice similarity setting (0-1). Higher = closer to original voice

speech_speednumber

Speech speed multiplier (0.7-1.2)

llm_temperaturenumber

LLM temperature setting (0-1). Lower = more deterministic

synthesizer_provider_idinteger

Custom TTS provider ID. Set to null to use the system default voice. See Get Synthesizer Providers.

transcriber_provider_idinteger

Custom STT provider ID. Pipeline mode only. Set to null to use the system default voice. See Get Transcriber Providers.

allow_interruptionsboolean

Whether caller interruptions are allowed.

<Warning>Cannot be disabled in multimodal and dualplex modes.</Warning>

fillersboolean

Whether filler audio should be used during processing.

<Warning>Available only in pipeline mode.</Warning>

filler_configobject

Custom filler profiles per category. Replaces the existing filler configuration. Each category is an array of short phrases.

  • positive: Fillers for affirmative responses
  • negative: Fillers for negative/neutral responses
  • question: Fillers when processing a question
  • neutral: Fillers for neutral confirmations
recordboolean

Whether the call should be recorded

enable_noise_cancellationboolean

Whether noise cancellation should be enabled

wait_for_customerboolean

If true, the assistant waits for the customer to speak first

max_durationinteger

Maximum call duration in seconds (20-1200)

max_silence_durationinteger

Maximum silence duration before re-engagement in seconds (1-360)

max_initial_silence_durationinteger

Maximum silence at the start of the call before termination (1-120 seconds). Set to null to disable.

ringing_timeinteger

Maximum ringing time before aborting (1-60 seconds)

reengagement_intervalinteger

Interval for re-engagement in seconds (7-600)

reengagement_promptstring

Custom prompt for re-engagement messages (max. 1000 characters). Set to null to use the default.

end_call_on_voicemailboolean

Whether to end the call when voicemail is detected

voice_mail_messagestring

Message to leave on voicemail before hanging up (max. 1000 characters). Set to null to disable.

endpoint_type'vad' | 'ai'

Type of voice activity detection. Options: vad, ai

endpoint_sensitivitynumber

Endpoint sensitivity level (0-5)

interrupt_sensitivitynumber

Interruption sensitivity level (0-5)

min_interrupt_wordsinteger

Minimum number of words before interruption is allowed (0-10). Set to null to disable.

ambient_sound'off' | 'office' | 'city' | 'forest' | 'crowded_room' | 'cafe' | 'nature'

Background ambient sound. Options: off, office, city, forest, crowded_room, cafe, nature

ambient_sound_volumenumber

Volume of the ambient sound (0-1)

is_webhook_activeboolean

Whether webhook notifications are enabled

webhook_urlstring

The webhook URL for post-call notifications. Set to null to remove.

send_webhook_only_on_completedboolean

Whether webhooks should be sent only for successfully completed calls (not on failed/no-answer)

include_recording_in_webhookboolean

Whether the recording URL should be included in the webhook payload

post_call_evaluationboolean

Whether AI-based post-call evaluation is enabled

variablesobject

Key-value pairs for custom variables. Replaces all existing variables.

Response

Success

messagestring

Success message confirming the assistant update

Changes

No recorded changes to this operation across all 1 revision of this API.