API

I den här guiden går vi igenom hur du integrerar din Quickchat‑assistent med ditt system via ett API‑endpoint.

Autentisering

Inkludera din API Key och scenario_id i varje begäran.

För att få din nyckel: uppgradera din prenumeration för API‑åtkomst.

Chat

Initiera ny konversation / nytt användarhistorik

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

Svaret ser ut så här:

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

conv_id är valfri. Utelämnar du den startas en ny konversation och ett nytt conv_id returneras.

Koppla conv_id till din användare för att bevara kontext över tid och flera interaktioner.

Detta endpoint utför ett enda utbyte.

HTTP‑begäran

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

Parametrar

Parameter	Typ	Beskrivning
api_key	string	Skapa konto och teckna plan för att få din API‑nyckel
scenario_id	Text	ID för din Quickchat‑API‑implementation
text	string	Användarens inmeddelande

Skicka meddelande till AI‑assistenten

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

Svaret ser ut så här:

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

HTTP‑begäran

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

Parametrar

Parameter	Typ	Beskrivning
api_key	string	Skapa konto och teckna plan för att få din API‑nyckel
scenario_id	string	ID för din Quickchat‑API‑implementation.
conv_id	string (Valfri)	Identifierar en konversation/användare.
text	string	Användarens inmeddelande.
message_context	string (Valfri)	Extra kontext per meddelande som skickas till AI tillsammans med meddelandet.
client_metadata	dict (Valfri)	T.ex. {userId: 12, website: mywebsite.com}. Max 5 nycklar. Länkas till varje nytt meddelande och syns som kolumner i konversationsexport (CSV).

Meddelanden med anpassad kontext och metadata

Som beskrivet ovan stöder https://chat.quickchat.ai/chat parametrarna message_context och client_metadata.

client_metadata är egna attribut som kopplas till varje nytt meddelande och visas i CSV‑exporten.

message_context möjliggör per‑användare‑kontext för mer personliga svar.

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

Filtrera på kunskapstaggar via API

I Quickchat AI‑appen kan du tagga varje artikel. Taggarna kan användas för att filtrera kunskapsbasen så att AI bara svarar utifrån en delmängd artiklar.

För att filtrera efter ämnen (taggar), lägg till kb_topic i client_metadata. Se till att nyckeln finns i alla anrop, även initialiseringen; värdet kan ändras men nyckeln behöver vara med varje gång.

Exempel:

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

Fel

Möjliga felkoder, beskrivning och åtgärd:

Kod	Beskrivning	Åtgärd
400	Parametrarna api_key, scenario_id, text krävs	Kontrollera att alla obligatoriska parametrar skickas.
400	conv_id abcd1234 finns inte	Kontrollera att conv_id är korrekt.
400	Gränsen för message_context är 1000 tecken	Korta ned message_context till max 1000 tecken inklusive mellanslag.
401	Otillåten	Kontrollera api_key och scenario_id (se Integrations - API).
500	Internt serverfel	Fel på vår sida. Kontakta support.
503	Tjänsten otillgänglig	Överbelastad eller under underhåll. Vid fortsatt fel, kontakta support.