Ga naar inhoud

Haal de volledige configuratie van je AI-agent op en werk deze bij via de REST API.

Haal de volledige configuratie van je AI-agent op en werk deze bij, inclusief persoonlijkheid, gespreksstijl en systeemprompt.

Gedragsinstellingen staan in het dashboard onder Identiteit > AI-persona. Tekst voor bezoekers staat onder Kanalen > Je website > Tekstinhoud. De onderstaande veldentabel geeft de exacte locatie van elke instelling.

Bereik: read_all

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

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

Antwoord 200 OK

{
"personality": 0,
"profession": "helpful_assistant",
"creativity_level": 1,
"greeting": "<p>Hello! How can I help you today?</p>",
"greeting2": "",
"header": "Support Assistant",
"header2": "",
"language_chosen": "en",
"reply_length": 1,
"one_word_description": "Support Agent",
"short_description": "A helpful customer support assistant.",
"ai_commands": ["Be polite", "Stay on topic"]
}
VeldBeschrijving
one_word_description
string
Naam van de AI-agent. Dashboard: Identiteit > AI-persona > Naam. De API accepteert maximaal 200 tekens; het veld in de app beperkt dit tot 40.
short_description
string
De Hoofdprompt (systeemprompt). Dashboard: Identiteit > AI-persona > Hoofdprompt. De API accepteert bij elk abonnement maximaal 25.000 tekens; de editor in de app beperkt dit tot de limiet van je abonnement, vanaf 15.000.
ai_commands
array van strings
Gedragsrichtlijnen voor de AI, één per array-item. Dashboard: Identiteit > AI-persona > Richtlijnen. Maximaal 250 items, 5.000 tekens per item en 10.000 tekens over alle items samen.
personality
integer (0–13)
Voorinstelling voor de AI-persoonlijkheid. Dashboard: Identiteit > AI-persona > Persoonlijkheid. Zie de onderstaande tabel
profession
string
Beroep of rol van de AI. Dashboard: Identiteit > AI-persona > Rol (maximaal 200 tekens). Zie de onderstaande tabel
creativity_level
integer (0–2)
Dashboard: Identiteit > AI-persona > Creativiteit. 0 = Laag, 1 = Normaal, 2 = Hoog
reply_length
integer (0–2)
Dashboard: Identiteit > AI-persona > Antwoordlengte. 0 = Kort, 1 = Normaal, 2 = Langer
greeting
string
Primair begroetingsbericht (HTML). Dashboard: Kanalen > Je website > Tekstinhoud > Welkomstbericht (maximaal 1.000 tekens). Dit is hetzelfde veld als welcome_message in Widgetconfiguratie.
greeting2
string
Secundair begroetingsbericht (HTML). Beschikbaar via de API; hiervoor is geen editorveld in het dashboard.
header
string
Koptekst van de chat. Dashboard: Kanalen > Je website > Tekstinhoud > Koptekst (maximaal 200 tekens)
header2
string
Secundaire koptekst (maximaal 200 tekens). Beschikbaar via de API als header2 of als subtitle in Widgetconfiguratie; hiervoor is geen editorveld in het dashboard.
language_chosen
string
Door komma’s gescheiden taalcodes (bijvoorbeeld "en,es,de"). Dashboard: Identiteit > AI-persona > Talen (maximaal 200 tekens totaal; codes boven de limiet van 30 talen worden weggelaten)

Waarden voor persoonlijkheid:

WaardeLabelBeschrijving
0KlassiekVeelzijdig, met een balans tussen professionaliteit en toegankelijkheid (standaard)
1HumoristischGeestige toon met woordspelingen en grappen voor vermakelijke interacties
2FormeelFormeel en serieus, met beknopte feitelijke informatie voor zakelijke situaties
3VriendelijkInformele gesprekken met een persoonlijke, toegankelijke benadering
4BrutaalZelfverzekerd en speels, met humor
5IntelligentGedetailleerde, nauwkeurige informatie voor diepgaand begrip
6EmpathischZorgzame, meelevende interacties met aandacht voor gevoelens
7ZelfverzekerdDuidelijke meningen en aanbevelingen, met overtuiging gebracht
9EnthousiastLevendige en energieke interactie
10MysterieusRaadselachtige, intrigerende antwoorden voor een unieke ervaring
11InspirerendStimuleert positief denken en doelen bereiken, als een coach
12AvontuurlijkMoedigt aan om de comfortzone te verlaten en nieuwe kansen te verkennen
13ElegantVerfijnde ervaring voor unieke en exclusieve merken

Waarden voor rol:

WaardeLabel in dashboardBeschrijving
helpful_assistantBehulpzame assistentVeelzijdig en breed inzetbaar. Aanbevolen voor de meeste toepassingen
customer_support_representativeSupportmedewerkerEmpathisch, biedt stapsgewijze oplossingen en probleemoplossing
shopping_assistantWinkelassistentGeeft proactief productaanbevelingen met links
field_expertVakexpertProfessionele adviseur, stelt verduidelijkende vragen en geeft deskundige begeleiding
interviewerInterviewerStelt vragen in plaats van antwoorden te geven. Voor enquêtes, interviews en feedback

De velden one_word_description, short_description en ai_commands zijn ook beschikbaar via het endpoint Kennisbank-instellingen. Deze velden worden gedeeld: bijwerken via een van beide endpoints wijzigt dezelfde onderliggende gegevens.

Bereik: write_all

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

Requestbody: alle velden zijn optioneel. Neem alleen de velden op die je wilt bijwerken.

ParameterBeschrijving
personality
integer (0–13)
Voorinstelling voor de AI-persoonlijkheid
profession
string
Beroep of rol van de AI (maximaal 200 tekens)
creativity_level
integer (0–2)
0 = Laag, 1 = Normaal, 2 = Hoog
greeting
string
Primair welkomstbericht (HTML, maximaal 1.000 tekens)
greeting2
string
Secundair welkomstbericht
header
string
Koptekst van de chat (maximaal 200 tekens)
header2
string
Secundaire koptekst (maximaal 200 tekens)
language_chosen
string
Door komma’s gescheiden taalcodes (maximaal 200 tekens totaal; codes boven de limiet van 30 talen worden weggelaten)
reply_length
integer (0–2)
0 = Kort, 1 = Normaal, 2 = Langer
one_word_description
string
Naam van de AI-agent. API maximaal 200 tekens; het veld in de app beperkt dit tot 40.
short_description
string
Hoofdprompt van de AI (systeemprompt). De API accepteert bij elk abonnement maximaal 25.000 tekens; de editor in de app beperkt dit tot de limiet van je abonnement, vanaf 15.000. Een te lange waarde retourneert 422.
ai_commands
array van strings
AI-richtlijnen, één per array-item. Maximaal 250 items, 5.000 tekens per item en 10.000 tekens over alle items samen. Een te lange waarde retourneert 422.

Elk array-item is één richtlijn en wordt exact opgeslagen zoals je die verstuurt. Leestekens, inclusief puntkomma’s, blijven behouden. Dit endpoint verwijderde vroeger ; uit je tekst vóór het opslaan. Als je puntkomma’s daarom verwijderde of verving, hoeft dat niet meer.

Laat ai_commands weg of stuur null om de richtlijnen ongewijzigd te laten. Stuur [] om ze te wissen.

Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/chatbot_settings \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"greeting": "<p>Welcome! Ask me anything.</p>",
"creativity_level": 2
}'

Antwoord 200 OK: retourneert de bijgewerkte chatbotinstellingen (hetzelfde schema als het antwoord van Chatbotinstellingen ophalen).