Zum Inhalt springen

API

Zuletzt bearbeitet:

In diesem Leitfaden erläutern wir die Schritte, um Ihren Quickchat‑KI‑Assistenten per API in Ihr Produkt zu integrieren.

Fügen Sie in jeder Anfrage Ihren API Key und die scenario_id hinzu.

Um einen API‑Schlüssel zu erhalten, upgraden Sie Ihr Abonnement mit API‑Zugang.

Neue Konversation / neuer Nutzerverlauf initialisieren

Abschnitt betitelt „Neue Konversation / neuer Nutzerverlauf initialisieren“
Terminal-Fenster
curl https://chat.quickchat.ai/chat \
-H 'Content-Type: application/json' \
-d '{
"api_key": "<API_KEY>",
"scenario_id": "<SCENARIO_ID>",
"text": "Hello!"
}'

Die obige Anfrage liefert JSON in dieser Struktur:

{
"ord_number": 2,
"conv_id": "abcd1234",
"reply": "Hey there! 🙂"
}

conv_id ist optional. Ohne conv_id startet eine neue Konversation, deren conv_id zurückgegeben wird.

Verknüpfen Sie conv_id mit Ihrem Nutzer, um Kontext über Zeit und Interaktionen hinweg zu erhalten.

Dieser Endpoint führt einen einzelnen Gesprächsaustausch aus.

HTTP‑Anfrage

POST https://chat.quickchat.ai/chat

Parameter

ParameterTypBeschreibung
api_keystringErstellen Sie ein Konto und abonnieren Sie, um den Key zu erhalten
scenario_idTextID Ihrer Quickchat‑API‑Implementierung
textstringEingabemessage des Nutzers
Terminal-Fenster
curl https://chat.quickchat.ai/chat \
-H 'Content-Type: application/json' \
-d '{
"api_key": "<API_KEY>",
"scenario_id": "<SCENARIO_ID>",
"conv_id": "abcd1234",
"text": "Hello!",
}'

Die obige Anfrage liefert JSON in dieser Struktur:

{
"ord_number": 236,
"reply": "Hey, great to hear from you again! 😉"
}

HTTP‑Anfrage

POST https://chat.quickchat.ai/chat

Parameter

ParameterTypBeschreibung
api_keystringErstellen Sie ein Konto und abonnieren Sie, um den Key zu erhalten
scenario_idstringID Ihrer Quickchat‑API‑Implementierung.
conv_idstring (Optional)Identifiziert eine Konversation/einen Nutzer.
textstringEingabemessage des Nutzers.
message_contextstring (Optional)Zusätzlicher pro‑Message‑Kontext, der der KI zusammen mit der Nachricht übergeben wird.
client_metadatadict (Optional)Z. B. {userId: 12, website: mywebsite.com}. Max. 5 Keys. Wird jeder neuen Nachricht zugeordnet und erscheint als Spalten im Konversations‑CSV‑Export.

Wie in der Parametertabelle beschrieben, erlaubt https://chat.quickchat.ai/chat zwei optionale Parameter: message_context und client_metadata.

client_metadata sind benutzerdefinierte Attribute, die jeder neuen Nachricht zugeordnet werden und im CSV‑Export sichtbar sind.

message_context ermöglicht pro‑Nutzer‑Kontext für personalisierte Gespräche.

Terminal-Fenster
curl https://chat.quickchat.ai/chat \
-H 'Content-Type: application/json' \
-d '{
"api_key": "<API_KEY>",
"scenario_id": "<SCENARIO_ID>",
"conv_id": "abcd1234",
"text": "Hello!",
"message_context": "The users name is John.",
"client_metadata": {userId: 12, website: mywebsite.com}
}'

In der Quickchat‑App können Sie jedem Artikel Tags hinzufügen. Diese dienen zum Filtern der Wissensbasis, sodass die KI nur auf einem Artikel‑Subset antwortet.

Fügen Sie kb_topic zu client_metadata hinzu. Achten Sie darauf, dass der Key bei jedem API‑Call vorhanden ist (auch bei der Initialisierung). Der Wert kann sich ändern; der Key muss konstant bleiben.

Beispiel:

json={
"api_key": "<API_KEY>",
"scenario_id": "<SCENARIO_ID>",
"conv_id": "abcd1234",
"text": "Hello!",
"message_context": "The users name is John.",
"client_metadata": {'kb_topic': 'your-topic'}
}

Nachfolgend finden Sie mögliche Fehlercodes, Beschreibung und empfohlene Maßnahmen.

CodeBeschreibungMaßnahme
400Die Parameter api_key, scenario_id, text sind nötigStellen Sie sicher, dass alle Pflichtparameter vorhanden sind.
400conv_id abcd1234 existiert nichtPrüfen Sie den verwendeten conv_id.
400Das Limit für message_context liegt bei 1000 ZeichenKürzen Sie message_context auf max. 1000 Zeichen inkl. Leerzeichen.
401Nicht autorisiertPrüfen Sie api_key und scenario_id (siehe Integrations - API).
500Interner ServerfehlerProblem auf unserer Seite. Bitte Support kontaktieren.
503Dienst nicht verfügbarÜberlastung/Wartung. Wenn das Problem anhält, bitte Support kontaktieren.