Knowledge Base

Knowledge Base är kärnan i din AI Agents expertis — den innehåller all information som din AI använder för att besvara frågor. Dessa endpoints låter dig hantera Knowledge Base-konfigurationen och följa bearbetningsstatusen för dess innehåll.

Knowledge Base bygger på Articles som du skapar, importerar från webbplatser eller laddar upp som filer. Det finns inget omträningssteg: varje artikel du skapar, uppdaterar eller tar bort bearbetas automatiskt i bakgrunden och får effekt i konversationer så snart den är klar.

Get Settings

Hämta din Knowledge Base-konfiguration.

Behörighetsomfång: read_all

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

Shell

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

Python

import requests

response = requests.get(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
data = response.json()

Response 200 OK

{
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"],
  "pending_embed_count": 0,
  "failed_embed_count": 0
}

Field	Description
one_word_description string	AI Agent-namn. Panelen: Identitet > AI-persona > Namn
short_description string	Systemprompt / Huvudprompt. Panelen: Identitet > AI-persona > Huvudprompt
ai_commands array of strings	Beteenderiktlinjer, en riktlinje per arrayobjekt. Panelen: Identitet > AI-persona > Riktlinjer. Upp till 250 objekt, 5 000 tecken per objekt och 10 000 tecken totalt över alla objekt.
pending_embed_count integer	Artiklar som fortfarande bearbetas. 0 betyder att allt du har skickat in är live
failed_embed_count integer	Artiklar vars bearbetning misslyckades. Försök igen med Retry Failed Articles

Vänta på att innehållet går live

Polla den här endpointen efter en skrivning och vänta tills pending_embed_count når 0. Status per artikel finns också som fältet embed_state på Articles.

Note

Dessa tre fält (one_word_description, short_description, ai_commands) delas med Chatbot Settings. Att uppdatera via någon av endpointsen ändrar samma underliggande data.

Update Settings

Behörighetsomfång: write_all

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

Request Body

Parameter	Description
one_word_description string	AI Agent-namn
short_description string	Systemprompt / AI Agent-beskrivning. API:et accepterar upp till 25 000 tecken på alla planer; in-app-editorn begränsar värdet till din plans tak, som börjar vid 15 000. Ett för långt värde returnerar 422.
ai_commands array of strings	AI Guidelines, en riktlinje per arrayobjekt. Upp till 250 objekt, 5 000 tecken per objekt och 10 000 tecken totalt över alla objekt. Ett för långt värde returnerar 422.

Så lagras riktlinjer

Varje arrayobjekt är en riktlinje som sparas exakt så som du skickar den. Skiljetecken bevaras, inklusive semikolon. Tidigare returnerades en riktlinje som innehöll ; som två separata riktlinjer. Om du undvek semikolon på grund av det behöver du inte längre göra det.

Den här endpointen accepterade tidigare riktlinjer av valfri längd. Gränserna ovan gäller nu även här och matchar Chatbot Settings exakt.

Utelämna ai_commands, eller skicka null, för att lämna riktlinjerna oförändrade. Skicka [] för att rensa dem.

Shell

curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "one_word_description": "Sales Bot"
}'

Python

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={"one_word_description": "Sales Bot"},
)
data = response.json()

Response 200 OK — Returnerar de uppdaterade Knowledge Base-inställningarna (samma schema som Get Settings).

Retry Failed Articles

Bearbeta om varje artikel vars bearbetning misslyckades. Artiklar som redan är live eller fortfarande pågår lämnas orörda, och anropet är säkert att upprepa.

Misslyckade artiklar görs också om automatiskt, så den här endpointen behövs bara när du inte vill vänta på det.

Behörighetsomfång: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)

Response 200 OK

{
  "retried": 2
}

Field	Description
retried integer	Hur många misslyckade artiklar som köades för ombearbetning

Retrain Knowledge Base Utfasad

POST https://app.quickchat.ai/v1/api/knowledge_base/retrain/

Omträning finns inte längre — artikeländringar bearbetas automatiskt. Den här endpointen finns kvar enbart för att befintliga integrationer ska fortsätta fungera: den tar emot förfrågan, gör ingenting och returnerar 200 OK.

Du kan ta bort anropet från din integration. Om du pollade tills omträningen var klar, vänta i stället tills pending_embed_count når 0 i Get Settings.

---