Zum Inhalt springen

Rufen Sie die vollständige Konfiguration Ihres KI-Agenten über die REST-API ab und aktualisieren Sie sie.

Rufen Sie die vollständige Konfiguration Ihres KI-Agenten ab und aktualisieren Sie sie, einschließlich Persönlichkeit, Konversationsstil und System-Prompt.

Die Verhaltenseinstellungen finden Sie im Dashboard unter Identität > AI Persona. Texte für Besucher stehen unter Kanäle > Ihre Website > Textinhalt. Die folgende Feldtabelle zeigt den genauen Ort jeder Einstellung.

Berechtigungsumfang: read_all

GET https://app.quickchat.ai/v1/api/chatbot_settings

Terminal-Fenster
curl https://app.quickchat.ai/v1/api/chatbot_settings \
-H 'Authorization: Bearer <API_TOKEN>'

Antwort 200 OK

{
"personality": 0,
"profession": "helpful_assistant",
"creativity_level": 1,
"greeting": "<p>Hello! How can I help you today?</p>",
"greeting2": "",
"header": "Support Assistant",
"header2": "",
"language_chosen": "en",
"reply_length": 1,
"one_word_description": "Support Agent",
"short_description": "A helpful customer support assistant.",
"ai_commands": ["Be polite", "Stay on topic"]
}
FieldDescription
one_word_description
string
Name des KI-Agenten. Dashboard: Identität > AI Persona > Name. Die API akzeptiert bis zu 200 Zeichen; das Feld in der App begrenzt den Namen auf 40 Zeichen.
short_description
string
Der Haupt-Prompt (System-Prompt). Dashboard: Identität > AI Persona > Haupt-Prompt. Die API akzeptiert auf allen Tarifen bis zu 25.000 Zeichen; der In-App-Editor begrenzt den Wert auf das Maximum Ihres Tarifs, das bei 15.000 beginnt.
ai_commands
array of strings
Verhaltensrichtlinien für die KI, eine Richtlinie pro Array-Element. Dashboard: Identität > AI Persona > Richtlinien. Bis zu 250 Einträge, 5.000 Zeichen pro Eintrag und 10.000 Zeichen über alle Einträge hinweg.
personality
integer (0–13)
Persönlichkeits-Preset der KI. Dashboard: Identität > AI Persona > Persönlichkeit. Siehe Tabelle unten
profession
string
Beruf/Rolle der KI. Dashboard: Identität > AI Persona > Beruf (max. 200 Zeichen). Siehe Tabelle unten
creativity_level
integer (0–2)
Dashboard: Identität > AI Persona > Kreativität. 0 = Niedrig, 1 = Normal, 2 = Hoch
reply_length
integer (0–2)
Dashboard: Identität > AI Persona > Antwortlänge. 0 = Kurz, 1 = Normal, 2 = Länger
greeting
string
Primäre Begrüßungsnachricht (HTML). Dashboard: Kanäle > Ihre Website > Textinhalt > Willkommensnachricht (max. 1000 Zeichen). Dies ist dasselbe Feld wie welcome_message in der Widget-Konfiguration.
greeting2
string
Sekundäre Begrüßungsnachricht (HTML). Über die API verfügbar; im Dashboard gibt es dafür kein Bearbeitungsfeld.
header
string
Text der Chat-Kopfzeile. Dashboard: Kanäle > Ihre Website > Textinhalt > Kopfzeilentext (max. 200 Zeichen)
header2
string
Sekundärer Kopfzeilentext (max. 200 Zeichen). Über die API als header2 oder als subtitle in der Widget-Konfiguration verfügbar; im Dashboard gibt es dafür kein Bearbeitungsfeld.
language_chosen
string
Kommagetrennte Sprachcodes (z. B. "en,es,de"). Dashboard: Identität > AI Persona > Sprachen (max. 200 Zeichen insgesamt; Codes über das Limit von 30 Sprachen hinaus werden verworfen)

Personality-Werte:

ValueLabelDescription
0ClassicAusgewogen, balanciert zwischen Professionalität und Zugänglichkeit (Standard)
1HumorousWitziger Ton mit Wortspielen und Scherzen für unterhaltsame Interaktionen
2FormalFormell und seriös, knappe, sachliche Informationen für geschäftliche Umgebungen
3FriendlyLockere Gespräche mit persönlicher, zugänglicher Note
4SassySelbstbewusst und verspielt mit Humor
5IntelligentDetaillierte, präzise Informationen für ein umfassendes Verständnis
6EmpatheticFürsorgliche, mitfühlende Interaktionen, die Rücksicht auf Gefühle nehmen
7BoldKlare Meinungen und Empfehlungen, selbstbewusst vorgetragen
9ExcitedLebhaftes und energiegeladenes Engagement
10MysteriousKryptische, faszinierende Antworten für ein einzigartiges Erlebnis
11InspiringFördert positives Denken und das Erreichen von Zielen im Stil eines Coachs
12AdventurousErmutigt dazu, die Komfortzone zu verlassen und neue Möglichkeiten zu erkunden
13ElegantAnspruchsvolles Erlebnis für einzigartige und erlesene Marken

Profession-Werte:

ValueDashboard LabelDescription
helpful_assistantHelpful AssistantVielseitig, für viele Zwecke. Für die meisten Anwendungsfälle empfohlen
customer_support_representativeSupport AgentEmpathisch, bietet Schritt-für-Schritt-Lösungen und Fehlerbehebung
shopping_assistantShopping AssistantBietet proaktiv Produktempfehlungen mit Links
field_expertField ExpertProfessioneller Berater, stellt klärende Fragen, bietet fachkundige Anleitung
interviewerInterviewerStellt Fragen, statt Antworten zu geben. Für Umfragen, Interviews, Feedback

Die Felder one_word_description, short_description und ai_commands sind auch über den Endpunkt Knowledge Base Settings verfügbar. Diese Felder werden gemeinsam genutzt — eine Aktualisierung über einen der beiden Endpunkte ändert dieselben zugrunde liegenden Daten.

Berechtigungsumfang: write_all

PATCH https://app.quickchat.ai/v1/api/chatbot_settings

Request-Body — Alle Felder sind optional. Geben Sie nur die Felder an, die Sie aktualisieren möchten.

ParameterDescription
personality
integer (0–13)
Persönlichkeits-Preset der KI
profession
string
Beruf/Rolle der KI (max. 200 Zeichen)
creativity_level
integer (0–2)
0 = Niedrig, 1 = Normal, 2 = Hoch
greeting
string
Primäre Willkommensnachricht (HTML, max. 1000 Zeichen)
greeting2
string
Sekundäre Willkommensnachricht
header
string
Text der Chat-Kopfzeile (max. 200 Zeichen)
header2
string
Sekundärer Kopfzeilentext (max. 200 Zeichen)
language_chosen
string
Kommagetrennte Sprachcodes (max. 200 Zeichen insgesamt; Codes über das Limit von 30 Sprachen hinaus werden verworfen)
reply_length
integer (0–2)
0 = Kurz, 1 = Normal, 2 = Länger
one_word_description
string
Name des KI-Agenten. API-Maximum: 200 Zeichen; das Feld in der App begrenzt den Namen auf 40 Zeichen.
short_description
string
System-Prompt / Haupt-Prompt des KI-Agenten. Die API akzeptiert auf allen Tarifen bis zu 25.000 Zeichen; der In-App-Editor begrenzt den Wert auf das Maximum Ihres Tarifs, das bei 15.000 beginnt. Ein zu langer Wert gibt 422 zurück.
ai_commands
array of strings
AI Guidelines, eine Richtlinie pro Array-Element. Bis zu 250 Einträge, 5.000 Zeichen pro Eintrag und 10.000 Zeichen über alle Einträge hinweg. Ein zu langer Wert gibt 422 zurück.

Jedes Array-Element ist eine Richtlinie und wird genau so gespeichert, wie Sie sie senden. Satzzeichen bleiben erhalten, Semikolons eingeschlossen. Früher hat dieser Endpunkt ; vor dem Speichern aus Ihrem Text entfernt. Wenn Sie Semikolons deshalb weggelassen oder ersetzt haben, ist das nicht mehr nötig.

Lassen Sie ai_commands weg oder senden Sie null, um die Richtlinien unverändert zu lassen. Senden Sie [], um sie zu löschen.

Terminal-Fenster
curl -X PATCH https://app.quickchat.ai/v1/api/chatbot_settings \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"greeting": "<p>Welcome! Ask me anything.</p>",
"creativity_level": 2
}'

Antwort 200 OK — Gibt die aktualisierten Chatbot Settings zurück (gleiches Schema wie die Antwort von Chatbot Settings abrufen).