Update assistant

curl --request PUT \
  --url https://app.famulor.de/api/user/assistant/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_name": "<string>",
  "voice_id": 123,
  "language": "<string>",
  "llm_model": "<string>",
  "calls_direction": "<string>",
  "engine_type": "<string>",
  "timezone": "<string>",
  "initial_message": "<string>",
  "system_prompt": "<string>",
  "phone_number_id": 123,
  "tool_ids": [
    123
  ],
  "endpoint_type": "<string>",
  "endpoint_sensitivity": 123,
  "interrupt_sensitivity": 123,
  "ambient_sound_volume": 123,
  "post_call_evaluation": true,
  "send_webhook_only_on_completed": true,
  "include_recording_in_webhook": true,
  "is_webhook_active": true,
  "webhook_url": "<string>",
  "use_min_interrupt_words": true,
  "min_interrupt_words": 123,
  "variables": {},
  "post_call_schema": [
    {
      "post_call_schema[].name": "<string>",
      "post_call_schema[].type": "<string>",
      "post_call_schema[].description": "<string>"
    }
  ],
  "end_call_tool.description": "<string>",
  "llm_temperature": 123,
  "voice_stability": 123,
  "voice_similarity": 123,
  "speech_speed": 123,
  "allow_interruptions": true,
  "filler_audios": true,
  "re_engagement_interval": 123,
  "max_call_duration": 123,
  "max_silence_duration": 123,
  "end_call_on_voicemail": true,
  "noise_cancellation": true,
  "record_call": true,
  "who_speaks_first": "<string>"
}
'

{
  "message": "Assistant updated successfully",
  "data": {
    "id": 789,
    "name": "Updated Sales Assistant",
    "status": "active",
    "type": "outbound",
    "mode": "pipeline"
  }
}

PUT

https://app.famulor.de/api/

user

assistant

{id}

Update assistant

curl --request PUT \
  --url https://app.famulor.de/api/user/assistant/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_name": "<string>",
  "voice_id": 123,
  "language": "<string>",
  "llm_model": "<string>",
  "calls_direction": "<string>",
  "engine_type": "<string>",
  "timezone": "<string>",
  "initial_message": "<string>",
  "system_prompt": "<string>",
  "phone_number_id": 123,
  "tool_ids": [
    123
  ],
  "endpoint_type": "<string>",
  "endpoint_sensitivity": 123,
  "interrupt_sensitivity": 123,
  "ambient_sound_volume": 123,
  "post_call_evaluation": true,
  "send_webhook_only_on_completed": true,
  "include_recording_in_webhook": true,
  "is_webhook_active": true,
  "webhook_url": "<string>",
  "use_min_interrupt_words": true,
  "min_interrupt_words": 123,
  "variables": {},
  "post_call_schema": [
    {
      "post_call_schema[].name": "<string>",
      "post_call_schema[].type": "<string>",
      "post_call_schema[].description": "<string>"
    }
  ],
  "end_call_tool.description": "<string>",
  "llm_temperature": 123,
  "voice_stability": 123,
  "voice_similarity": 123,
  "speech_speed": 123,
  "allow_interruptions": true,
  "filler_audios": true,
  "re_engagement_interval": 123,
  "max_call_duration": 123,
  "max_silence_duration": 123,
  "end_call_on_voicemail": true,
  "noise_cancellation": true,
  "record_call": true,
  "who_speaks_first": "<string>"
}
'

{
  "message": "Assistant updated successfully",
  "data": {
    "id": 789,
    "name": "Updated Sales Assistant",
    "status": "active",
    "type": "outbound",
    "mode": "pipeline"
  }
}

Update one or more settings of an existing AI assistant. All fields are optional - only include the fields you want to modify.

Path Parameters

integer

required

The unique identifier of the assistant to update

Request Body

Core Fields

assistant_name

string

Assistant display name (maximum 255 characters)

voice_id

integer

Voice identifier to use (must exist in available voices list)

language

string

Language name for the assistant (maximum 100 characters)

llm_model

string

Large Language Model name to use (maximum 100 characters)

calls_direction

string

Call direction configuration. Options: receive, make

engine_type

string

Engine type selection. Options: pipeline, multimodal

timezone

string

Timezone setting (example: “America/New_York”)

initial_message

string

Opening message the assistant will speak at call start

system_prompt

string

System prompt that defines the assistant’s behavior, personality, and instructions

Optional Configuration

phone_number_id

integer

Phone number identifier to assign (set to null to remove assignment)

tool_ids

integer[]

Array of mid-call tool identifiers to synchronize with the assistant. This replaces all existing tool assignments. Pass an empty array to remove all tools. Each ID must be a valid tool belonging to your account.

endpoint_type

string

Voice activity detection method. Options: vad, ai

endpoint_sensitivity

number

Endpoint sensitivity level (range: 0-5)

interrupt_sensitivity

number

Interruption sensitivity level (range: 0-5)

ambient_sound_volume

number

Ambient sound volume level (range: 0-1)

post_call_evaluation

boolean

Enable AI-powered call evaluation after call completion

send_webhook_only_on_completed

boolean

Send webhooks only for successfully completed calls

include_recording_in_webhook

boolean

Include call recording URL in webhook payload

Webhook Configuration

is_webhook_active

boolean

Enable webhook notifications

webhook_url

string

Webhook endpoint URL for post-call notifications (can be set to null to remove)

Interruption Settings

use_min_interrupt_words

boolean

Enable minimum interrupt words configuration

min_interrupt_words

integer

Minimum words required before interruption is allowed (range: 0-10)

Variables and Schema

variables

object

Custom key-value variable pairs for the assistant

post_call_schema

array

Schema definition for AI data extraction after calls

Show post_call_schema properties

post_call_schema[].name

string

required

Schema field name (alphanumeric characters and underscores only)

post_call_schema[].type

string

required

Data type. Options: string, number, bool

post_call_schema[].description

string

required

Description explaining what this field represents

End Call Tool

end_call_tool.description

string

Description for end call tool functionality (maximum 500 characters)

Voice and Speech Settings

llm_temperature

number

LLM temperature configuration (range: 0-1)

voice_stability

number

Voice stability configuration (range: 0-1)

voice_similarity

number

Voice similarity configuration (range: 0-1)

speech_speed

number

Speech speed multiplier (range: 0.7-1.2)

Call Behavior Settings

allow_interruptions

boolean

Allow customers to interrupt the assistant

filler_audios

boolean

Use filler audio responses during processing

re_engagement_interval

integer

Re-engagement interval in seconds (range: 7-600)

max_call_duration

integer

Maximum call length in seconds (range: 20-1200)

max_silence_duration

integer

Maximum silence duration before re-engagement in seconds (range: 1-120)

end_call_on_voicemail

boolean

Automatically end call when voicemail is detected

noise_cancellation

boolean

Enable noise cancellation during calls

record_call

boolean

Record the call audio

who_speaks_first

string

Party that speaks first. Options: AI assistant, Customer

Response

message

string

Success confirmation message

data

object

Show properties

integer

Unique identifier of the updated assistant

name

string

Assistant name

status

string

Current assistant status

type

string

Assistant type (inbound or outbound)

mode

string

Engine mode (pipeline or multimodal)

Error Responses

404 Not Found

Show Error Response

message

string

Error when the assistant doesn’t exist or belongs to another account

422 Validation Error

Show Error Response

message

string

Error message describing validation failure

errors

object

Detailed field-level validation errors

500 Internal Server Error

Show Error Response

message

string

Error message indicating assistant update failure

{
  "message": "Assistant updated successfully",
  "data": {
    "id": 789,
    "name": "Updated Sales Assistant",
    "status": "active",
    "type": "outbound",
    "mode": "pipeline"
  }
}

Notes

Only the fields included in your request body will be updated
All validation rules are identical to assistant creation
To remove a phone number assignment, set phone_number_id to null
To disable webhooks, set webhook_url to null or is_webhook_active to false
The assistant must belong to your account to be updated

Create assistant Delete assistant

⌘I

API Reference

Assistants

Calls

Mid Call Tools

Leads

Campaigns

SMS

Webhooks

Update assistant

Path Parameters

Request Body

Core Fields

Optional Configuration

Webhook Configuration

Interruption Settings

Variables and Schema

End Call Tool

Voice and Speech Settings

Call Behavior Settings

Response

Error Responses

Notes

API Reference

Assistants

Calls

Mid Call Tools

Leads

Campaigns

SMS

Webhooks

​Path Parameters

​Request Body

​Core Fields

​Optional Configuration

​Webhook Configuration

​Interruption Settings

​Variables and Schema

​End Call Tool

​Voice and Speech Settings

​Call Behavior Settings

​Response

​Error Responses

​Notes

Path Parameters

Request Body

Core Fields

Optional Configuration

Webhook Configuration

Interruption Settings

Variables and Schema

End Call Tool

Voice and Speech Settings

Call Behavior Settings

Response

Error Responses

Notes