POST
/
api
/
user
/
assistant
curl -X POST "https://app.famulor.de/api/user/assistant" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "assistant_name": "Mein Verkaufs-Assistent",
    "voice_id": 413,
    "language": "German",
    "llm_model": "GPT-4o",
    "calls_direction": "make",
    "engine_type": "pipeline",
    "timezone": "Europe/Berlin",
    "initial_message": "Guten Tag! Ich rufe von Famulor an.",
    "system_prompt": "Du bist ein freundlicher Verkaufsassistent..."
  }'
{
  "message": "Assistant created successfully",
  "data": {
    "id": 3579,
    "name": "Mein Verkaufs-Assistent",
    "status": "active",
    "type": "outbound",
    "mode": "pipeline"
  }
}
Dieser Endpunkt ermöglicht es Ihnen, einen neuen KI-Assistenten mit umfassenden Konfigurationsoptionen zu erstellen.

Request Body

Erforderliche Kernfelder

assistant_name
string
required
Der Name des Assistenten (max. 255 Zeichen)
voice_id
integer
required
Die Stimmen-ID für den Assistenten (muss in verfügbaren Stimmen existieren)
language
string
required
Der Sprachname für den Assistenten (max. 100 Zeichen)
llm_model
string
required
Der Name des zu verwendenden LLM-Modells (max. 100 Zeichen)
calls_direction
string
required
Der Anrufrichtungstyp. Optionen: receive, make
engine_type
string
required
Der zu verwendende Engine-Typ. Optionen: pipeline, multimodal
timezone
string
required
Die Zeitzone für den Assistenten (z.B. “Europe/Berlin”)
initial_message
string
required
Die erste Nachricht, die der Assistent beim Anrufstart sprechen wird
system_prompt
string
required
Der System-Prompt, der das Verhalten und die Persönlichkeit des Assistenten definiert

Optionale Konfiguration

phone_number_id
integer
Die ID einer Telefonnummer, die dem Assistenten zugewiesen werden soll (muss in den Telefonnummern des Benutzers existieren)
endpoint_type
string
Sprachaktivitätserkennung-Typ. Optionen: vad, ai
endpoint_sensitivity
number
Endpunkt-Sensibilitätslevel (0-5)
interrupt_sensitivity
number
Unterbrechungs-Sensibilitätslevel (0-5)
ambient_sound_volume
number
Ambiente-Sound-Lautstärke (0-1)
post_call_evaluation
boolean
Ob Post-Call-Evaluation aktiviert werden soll
send_webhook_only_on_completed
boolean
Ob Webhooks nur bei abgeschlossenen Anrufen gesendet werden sollen
include_recording_in_webhook
boolean
Ob Aufzeichnungs-URL in Webhook-Payload eingeschlossen werden soll

Webhook-Konfiguration

is_webhook_active
boolean
Ob Webhook-Benachrichtigungen aktiviert sind
webhook_url
string
Die Webhook-URL für Post-Call-Benachrichtigungen (erforderlich wenn is_webhook_active auf true gesetzt ist)

Unterbrechungseinstellungen

use_min_interrupt_words
boolean
Ob die Mindest-Unterbrechungswörter-Einstellung verwendet werden soll
min_interrupt_words
integer
Mindestanzahl von Wörtern vor erlaubter Unterbrechung (0-10)

Variablen und Schema

variables
object
Schlüssel-Wert-Paare von benutzerdefinierten Variablen für den Assistenten
post_call_schema
array
Schema-Definition für Post-Call-Datenextraktion

End Call Tool

end_call_tool.description
string
Beschreibung für die End Call Tool-Funktionalität (max. 500 Zeichen)

Stimme und Sprache

llm_temperature
number
LLM-Temperatur-Einstellung (0-1)
voice_stability
number
Stimm-Stabilität-Einstellung (0-1)
voice_similarity
number
Stimm-Ähnlichkeit-Einstellung (0-1)
speech_speed
number
Sprechgeschwindigkeits-Multiplikator (0.7-1.2)

Anrufverhalten

allow_interruptions
boolean
Ob Unterbrechungen durch den Anrufer erlaubt werden sollen
filler_audios
boolean
Ob Füller-Audio während der Verarbeitung verwendet werden soll
re_engagement_interval
integer
Re-Engagement-Intervall in Sekunden (7-600)
max_call_duration
integer
Maximale Anrufdauer in Sekunden (20-1200)
max_silence_duration
integer
Maximale Stillstand-Dauer in Sekunden (1-120)
end_call_on_voicemail
boolean
Ob Anruf bei Voicemail-Erkennung beendet werden soll
noise_cancellation
boolean
Ob Geräuschunterdrückung aktiviert werden soll
record_call
boolean
Ob der Anruf aufgezeichnet werden soll
who_speaks_first
string
Wer zuerst im Anruf spricht. Optionen: AI assistant, Customer

Response

message
string
Erfolgsmeldung, die die Assistenten-Erstellung bestätigt
data
object
Daten des erstellten Assistenten

Hinweise

  • Alle erforderlichen Felder müssen für eine erfolgreiche Assistenten-Erstellung angegeben werden
  • Der Assistent wird mit Standardeinstellungen für alle nicht angegebenen optionalen Felder erstellt
  • Die Telefonnummer-Zuweisung ist optional, aber die Telefonnummer muss dem authentifizierten Benutzer gehören
  • Webhook-URL ist nur erforderlich, wenn is_webhook_active auf true gesetzt ist
  • Stimm- und Sprach-Kennungen müssen verfügbaren Optionen im System entsprechen
curl -X POST "https://app.famulor.de/api/user/assistant" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "assistant_name": "Mein Verkaufs-Assistent",
    "voice_id": 413,
    "language": "German",
    "llm_model": "GPT-4o",
    "calls_direction": "make",
    "engine_type": "pipeline",
    "timezone": "Europe/Berlin",
    "initial_message": "Guten Tag! Ich rufe von Famulor an.",
    "system_prompt": "Du bist ein freundlicher Verkaufsassistent..."
  }'
{
  "message": "Assistant created successfully",
  "data": {
    "id": 3579,
    "name": "Mein Verkaufs-Assistent",
    "status": "active",
    "type": "outbound",
    "mode": "pipeline"
  }
}