API

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

Authentifizierung

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.

Chat

Neue Konversation / neuer Nutzerverlauf initialisieren

Shell

curl https://chat.quickchat.ai/chat \
  -H 'Content-Type: application/json' \
  -d '{
  "api_key": "<API_KEY>",
  "scenario_id": "<SCENARIO_ID>",
  "text": "Hello!"
}'

Python

import requests, json
response = requests.post(
  url="https://chat.quickchat.ai/chat",
  json={
    "api_key": "<API_KEY>",
    "scenario_id": "<SCENARIO_ID>",
    "text": "Hello!"
  })
if response.status_code == 200:
  data = json.loads(response.content)
else:
  raise ValueError(
    "Error code {}: {}".format(
      response.status_code,
      response.content.decode('utf-8')))

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

Parameter	Typ	Beschreibung
api_key	string	Erstellen Sie ein Konto und abonnieren Sie, um den Key zu erhalten
scenario_id	Text	ID Ihrer Quickchat‑API‑Implementierung
text	string	Eingabemessage des Nutzers

Nachricht an den KI‑Assistenten senden

Shell

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!",
}'

Python

import requests, json
response = requests.post(
  url="https://chat.quickchat.ai/chat",
  json={
    "api_key": "<API_KEY>",
    "scenario_id": "<SCENARIO_ID>",
    "conv_id": "abcd1234",
    "text": "Hello!",
  })
if response.status_code == 200:
  data = json.loads(response.content)
else:
  raise ValueError(
    "Error code {}: {}".format(
      response.status_code,
      response.content.decode('utf-8')))

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

Parameter	Typ	Beschreibung
api_key	string	Erstellen Sie ein Konto und abonnieren Sie, um den Key zu erhalten
scenario_id	string	ID Ihrer Quickchat‑API‑Implementierung.
conv_id	string (Optional)	Identifiziert eine Konversation/einen Nutzer.
text	string	Eingabemessage des Nutzers.
message_context	string (Optional)	Zusätzlicher pro‑Message‑Kontext, der der KI zusammen mit der Nachricht übergeben wird.
client_metadata	dict (Optional)	Z. B. {userId: 12, website: mywebsite.com}. Max. 5 Keys. Wird jeder neuen Nachricht zugeordnet und erscheint als Spalten im Konversations‑CSV‑Export.

Nachrichten mit Custom Context und Metadaten

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.

Shell

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}
}'

Python

import requests, json
response = requests.post(
  url="https://chat.quickchat.ai/chat",
  json={
    "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'}
  })
if response.status_code == 200:
  data = json.loads(response.content)
else:
  raise ValueError(
    "Error code {}: {}".format(
      response.status_code,
      response.content.decode('utf-8')))

Knowledge‑Base Tag‑Filter per API setzen

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'}
  }

Fehler

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

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