API

Dans ce guide, nous passons en revue les étapes pour intégrer votre Assistant IA Quickchat à votre produit via un endpoint API.

Authentification

Incluez votre API Key et le scenario_id dans chaque requête.

Pour obtenir votre clé API, mettez à niveau votre abonnement pour inclure l’accès API.

Chat

Initialiser une nouvelle conversation / historique utilisateur

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

La commande ci‑dessus retourne un JSON de la forme :

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

conv_id est un paramètre optionnel. Une requête sans conv_id démarre une nouvelle conversation et un conv_id est renvoyé.

Associez conv_id à votre utilisateur pour maintenir le contexte dans le temps et à travers plusieurs interactions.

Cet endpoint réalise un échange conversationnel unique.

Requête HTTP

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

Paramètres

Paramètre	Type	Description
api_key	string	Créez un compte et abonnez‑vous pour obtenir votre clé API
scenario_id	Text	ID associé à votre implémentation Quickchat API
text	string	Message d’entrée utilisateur

Envoyer un message à l’Assistant IA

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

La commande ci‑dessus retourne un JSON de la forme :

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

Requête HTTP

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

Paramètres

Paramètre	Type	Description
api_key	string	Créez un compte et abonnez‑vous pour obtenir votre clé API
scenario_id	string	ID associé à votre implémentation Quickchat API.
conv_id	string (Optionnel)	Identifie une conversation/un utilisateur.
text	string	Message d’entrée utilisateur.
message_context	string (Optionnel)	Contexte supplémentaire passé à l’IA avec le message.
client_metadata	dict (Optionnel)	Par ex. {userId: 12, website: mywebsite.com}. Max. 5 clés. Sera ajouté à chaque nouveau message et visible comme colonnes dans l’export de conversations de l’Inbox.

Messages avec contexte et métadonnées personnalisés

Comme décrit ci‑dessus, l’endpoint https://chat.quickchat.ai/chat prend en charge message_context et client_metadata.

client_metadata représente des attributs personnalisés assignés à chaque nouveau message et visibles dans l’export.

message_context permet d’ajouter un contexte par utilisateur pour personnaliser l’échange.

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

Ajouter des filtres par Tags de Base de connaissances via l’API

Dans l’application Quickchat AI, vous pouvez ajouter des tags à chaque Article. Ils servent à filtrer la Base de connaissances pour que l’IA réponde uniquement à partir d’un sous‑ensemble d’Articles.

Pour filtrer par sujets (tags), ajoutez kb_topic dans client_metadata. Assurez‑vous que la clé kb_topic est présente à chaque appel (y compris l’initialisation). La valeur peut changer, mais la clé doit rester présente.

Exemple :

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

Erreurs

Ci‑dessous, la liste des codes d’erreurs potentiels, leur description et actions possibles.

Code	Description	Action
400	Les paramètres requis sont : api_key, scenario_id, text	Vérifiez que tous les paramètres requis sont fournis.
400	conv_id abcd1234 n’existe pas	Assurez‑vous que le conv_id est correct.
400	La limite de message_context est de 1000 caractères	Réduisez le message_context à 1000 caractères espaces inclus.
401	Non autorisé	Vérifiez api_key et scenario_id (voir Integrations - API dans l’app).
500	Erreur interne	Problème côté serveur. Contactez le support.
503	Service indisponible	Surcharge/maintenance. Si le problème persiste, contactez le support.