Przejdź do głównej zawartości

API

Ostatnia aktualizacja:

Quickchat AI udostepnia REST API umozliwiajace programistyczny dostep do Bazy Wiedzy, Rozmow, Akcji AI i innych funkcji Twojego Asystenta AI.

Wszystkie endpointy API korzystaja z uwierzytelniania za pomoca tokena Bearer. Dolacz swoj token API w naglowku Authorization kazdego zadania:

Authorization: Bearer <API_TOKEN>

Tokeny tworzy sie w Panelu Quickchat w sekcji Integrations > API. Kazdy token to JWT zawierajacy Twoje scenario_id, wiec nie jest potrzebny dodatkowy naglowek identyfikujacy.

  • Waznosc tokena: 52 tygodnie od utworzenia
  • Tokeny mozna odwolac w dowolnym momencie z Panelu
  • Kazdy token jest przypisany do jednego Asystenta AI (scenariusza)
Endpoint GroupBase URL
Knowledge Base, AI Actions, File Upload, Importhttps://app.quickchat.ai/v1/api/
Conversationshttps://app.quickchat.ai/v1/api_core/
Chat (Legacy)https://chat.quickchat.ai/

Limity zapytan sa stosowane per token, per endpoint.

TierLimitApplies To
READ120 requests/minOperacje GET i listowania
WRITE60 requests/minPOST, PATCH, PUT, DELETE
HEAVY20 requests/minPrzesylanie plikow, importy, scrapowanie

Po przekroczeniu limitu zapytan API zwraca HTTP 429 Too Many Requests.

Endpointy listujace obsluguja paginacje za pomoca parametrow zapytania:

ParameterTypeDescription
limitintegerLiczba elementow na strone
offsetintegerLiczba elementow do pominiecia

Odpowiedzi z paginacja maja nastepujaca strukture:

{
"items": [],
"offset": 0,
"count": 100
}

Wszystkie bledy sa zwracane jako JSON w nastepujacym formacie:

{
"errors": {
"root": [
{
"message": "Description of the error",
"code": "ERROR_CODE"
}
]
}
}
StatusCodeDescription
400BAD_REQUESTNieprawidlowe dane wejsciowe lub brakujace wymagane pola
401PERMISSION_DENIEDNieprawidlowy, wygasly lub odwolany token
402PAYMENT_REQUIREDWymagana aktywna subskrypcja
404NOT_FOUNDZasob nie znaleziony
409CONFLICTKonflikt operacji (np. rownolegle modyfikacje)
422VALIDATION_ERRORTresc zadania nie przeszla walidacji schematu
429TOO_MANY_REQUESTSPrzekroczono limit zapytan
500UNKNOWNWewnetrzny blad serwera
503SERVICE_UNAVAILABLETymczasowa niedostepnosc

Endpoint Chat uzywa starszego uwierzytelniania z api_key i scenario_id w tresci zadania. Nie uzywa tokenow Bearer.

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

Request Body

ParameterTypeRequiredDescription
api_keystringYesTwoj klucz API z Panelu
scenario_idstringYesID Twojego Asystenta AI
textstringYesWiadomosc od uzytkownika
conv_idstringNoID rozmowy. Pomin, aby rozpoczac nowa rozmowe
message_contextstringNoDodatkowy kontekst per wiadomosc przekazywany do AI
client_metadataobjectNoNiestandardowe pary klucz-wartosc (maks. 5 kluczy) dolaczane do wiadomosci
Okno terminala
curl -X POST https://chat.quickchat.ai/chat \
-H 'Content-Type: application/json' \
-d '{
"api_key": "<API_KEY>",
"scenario_id": "<SCENARIO_ID>",
"text": "Hello!",
"conv_id": "abcd1234"
}'

Response 200 OK

{
"ord_number": 236,
"conv_id": "abcd1234",
"reply": "Hey there!"
}
FieldTypeDescription
ord_numberintegerKolejny numer wiadomosci w rozmowie
conv_idstringIdentyfikator rozmowy (uzyj do kontynuowania rozmowy)
replystringOdpowiedz Asystenta AI

Pobierz konfiguracje Bazy Wiedzy.

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

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

Response 200 OK

{
"one_word_description": "Support Agent",
"short_description": "A helpful customer support assistant.",
"ai_commands": ["Be polite", "Stay on topic"],
"retrain_state": null
}
FieldTypeDescription
one_word_descriptionstringKrotka etykieta Bazy Wiedzy
short_descriptionstringOpis przeznaczenia Asystenta AI
ai_commandsarray of stringsNiestandardowe instrukcje dla AI
retrain_statestring or nullAktualny status trenowania

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

Request Body

ParameterTypeRequiredDescription
one_word_descriptionstringNoKrotka etykieta Bazy Wiedzy
short_descriptionstringNoOpis przeznaczenia Asystenta AI
ai_commandsarray of stringsNoNiestandardowe instrukcje dla AI
Okno terminala
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"
}'

Response 200 OK — Zwraca zaktualizowane ustawienia Bazy Wiedzy (ten sam schemat co Pobierz ustawienia).


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

Request Body

ParameterTypeRequiredDescription
contentstringYesTresc artykulu
typestringNo"Article" (domyslnie) lub "Paragraph"
titlestringNoTytul artykulu
Okno terminala
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/articles/ \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"content": "Our return policy allows returns within 30 days.",
"title": "Return Policy"
}'

Response 201 Created

{
"id": 1234,
"article_id": "abc-123",
"type": "Article",
"title": "Return Policy",
"description": "",
"content": "Our return policy allows returns within 30 days.",
"state": "draft",
"url": null,
"parent_id": null,
"parent_type": null,
"shortened": false,
"tags": [],
"created_timestamp": "2026-01-15",
"last_modified_timestamp": "2026-01-15"
}

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

Query Parameters

ParameterTypeRequiredDescription
limitintegerNoElementow na strone
offsetintegerNoElementow do pominiecia
typesstringNoFiltruj po typie: Article, Paragraph
tagsstringNoFiltruj po tagu
urlstringNoFiltruj po URL
titlestringNoFiltruj po tytule
querystringNoSzukaj po tresci
Okno terminala
curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/?limit=10&offset=0' \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK

{
"items": [
{
"id": 1234,
"article_id": "abc-123",
"type": "Article",
"title": "Return Policy",
"description": "",
"state": "published",
"url": null,
"parent_id": null,
"parent_type": null,
"shortened": false,
"tags": ["policies"],
"created_timestamp": "2026-01-15",
"last_modified_timestamp": "2026-01-15"
}
],
"offset": 0,
"count": 1
}

GET https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}

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

Response 200 OK — Zwraca pelny obiekt artykulu (ten sam schemat co odpowiedz Utworz artykul).

PATCH https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}

Request Body

ParameterTypeRequiredDescription
contentstringNoZaktualizowana tresc artykulu
titlestringNoZaktualizowany tytul
tagsarray of stringsNoZaktualizowane tagi
save_modestringNo"draft" (domyslnie) lub "publish"
Okno terminala
curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/articles/1234 \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"title": "Updated Return Policy",
"content": "Returns accepted within 60 days.",
"save_mode": "publish"
}'

Response 200 OK — Zwraca zaktualizowany obiekt artykulu.

Usun jeden lub wiecej artykulow po ID.

DELETE https://app.quickchat.ai/v1/api/knowledge_base/articles/

Request Body — Tablica JSON z ID artykulow.

Okno terminala
curl -X DELETE https://app.quickchat.ai/v1/api/knowledge_base/articles/ \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '[1234, 5678]'

Response 200 OK

Wyszukuj w tresci artykulow za pomoca dopasowania tekstowego.

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

Query Parameters

ParameterTypeRequiredDescription
querystringYesZapytanie wyszukiwania
is_case_insensitivebooleanNoWyszukiwanie bez rozrozniania wielkosci liter (domyslnie: true)
with_title_url_and_tagsbooleanNoUwzglednij tytul/URL/tagi w wyszukiwaniu (domyslnie: true)
strict_searchbooleanNoWymagaj dokladnego dopasowania (domyslnie: false)
num_of_display_articlesintegerNoLiczba artykulow do wyswietlenia (domyslnie: 5)
num_of_data_articlesintegerNoLiczba artykulow do przeszukania (domyslnie: 15)
Okno terminala
curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/search?query=return%20policy' \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK

{
"article_snippets": [
{
"article_id": 1234,
"expository_sentence": "Our return policy allows returns within 30 days.",
"query_words_ids": [
{"start_char": 4, "end_char": 10, "text": "return"}
]
}
],
"article_snapshots": {
"items": [],
"offset": 0,
"count": 1
}
}

Lista wszystkich akapitow (podzielonej tresci) w Bazie Wiedzy.

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

Query Parameters

ParameterTypeRequiredDescription
limitintegerNoElementow na strone
offsetintegerNoElementow do pominiecia
querystringNoFiltruj po tresci
Okno terminala
curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/paragraphs?limit=10' \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK

{
"items": [
{
"id": 1,
"content": "Our return policy allows returns within 30 days."
}
],
"offset": 0,
"count": 1
}

Zarzadzaj adresami URL artykulow specyficznymi dla danego jezyka. Pozwalaja one na linkowanie artykulow do zlokalizowanych wersji tresci.

GET https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}/lang_urls/{language}

Okno terminala
curl https://app.quickchat.ai/v1/api/knowledge_base/articles/1234/lang_urls/en \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK

{
"url": "https://example.com/en/return-policy"
}

POST https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}/lang_urls/{language}

Request Body

ParameterTypeRequiredDescription
urlstringYesURL wersji jezykowej
Okno terminala
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/articles/1234/lang_urls/en \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{"url": "https://example.com/en/return-policy"}'

Response 200 OK

{
"url": "https://example.com/en/return-policy"
}

PATCH https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}/lang_urls/{language}

Request Body

ParameterTypeRequiredDescription
urlstringYesZaktualizowany URL

Response 200 OK — Zwraca zaktualizowany obiekt URL.

DELETE https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}/lang_urls/{language}

Okno terminala
curl -X DELETE https://app.quickchat.ai/v1/api/knowledge_base/articles/1234/lang_urls/en \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK


Pobierz wszystkie tagi uzywane w artykulach Bazy Wiedzy.

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

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

Response 200 OK

["policies", "faq", "product-info"]

Przesylaj pliki, ktore zostana przetworzone i dodane do Bazy Wiedzy jako artykuly.

POST https://app.quickchat.ai/v1/api/knowledge_base/file_upload_api/pdf

Przeslij plik PDF. Tresc zostanie wyekstrahowana i dodana jako artykul.

Okno terminala
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/file_upload_api/pdf \
-H 'Authorization: Bearer <API_TOKEN>' \
-F 'pdf_file=@document.pdf'

Response 200 OK

{
"status": "success",
"message": "File processed successfully.",
"article": {
"id": 1234,
"title": "document.pdf"
}
}
FieldTypeDescription
statusstringStatus przetwarzania
messagestringCzytelny dla czlowieka komunikat wyniku
articleobjectUtworzony artykul

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

Przeslij obslugiwany plik (PDF, DOCX). Tresc zostanie wyekstrahowana i dodana jako artykul.

Okno terminala
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/file_upload_api/ \
-H 'Authorization: Bearer <API_TOKEN>' \
-F 'file=@document.docx'

Response 200 OK — Ten sam schemat co Przeslij PDF.


Importuj tresc ze zrodel zewnetrznych do Bazy Wiedzy. Te endpointy przetwarzaja tresc asynchronicznie.

Scrapuj pojedyncza strone lub cala witryne i zaimportuj tresc.

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/website

Request Body

ParameterTypeRequiredDescription
urlstringYesURL do scrapowania
modestringNo"individual" (domyslnie), "site_wide" lub "individual_with_summary"
phrasesarray of stringsNoKluczowe frazy do wyekstrahowania
html_selectorstringNoSelektor CSS do wybrania konkretnej tresci
Okno terminala
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/website \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"url": "https://example.com/docs",
"mode": "individual"
}'

Response 200 OK

{
"status": "success",
"url": "https://example.com/docs",
"article": {}
}

Importuj transkrypcje z filmu na YouTube.

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/youtube

Request Body

ParameterTypeRequiredDescription
urlstringYesURL filmu na YouTube
toast_process_uuidstringYesUUID v4 do sledzenia procesu importu
Okno terminala
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/youtube \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"toast_process_uuid": "550e8400-e29b-41d4-a716-446655440000"
}'

Response 202 Accepted — Transkrypcja jest przetwarzana asynchronicznie.

Importuj tresc ze wszystkich linkow w mapie witryny XML.

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/site-map

Request Body

ParameterTypeRequiredDescription
site_mapstringYesURL do mapy witryny XML
link_filter_regexstringNoWyrazenie regularne do filtrowania importowanych linkow (domyslnie: ".*")
html_selectorstringNoSelektor CSS do wybrania konkretnej tresci
summarizebooleanNoCzy podsumowac importowana tresc (domyslnie: false)
Okno terminala
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/site-map \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"site_map": "https://example.com/sitemap.xml"
}'

Response 200 OK

{
"status": "success",
"links": ["https://example.com/page1", "https://example.com/page2"]
}

Importuj tresc z okreslonej listy adresow URL.

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/scrape-list

Request Body

ParameterTypeRequiredDescription
linksarray of stringsYesLista adresow URL do scrapowania (niepusta)
tagsarray of stringsNoTagi do przypisania zaimportowanym artykulom
html_selectorstringNoSelektor CSS do wybrania konkretnej tresci
summarizebooleanNoCzy podsumowac importowana tresc (domyslnie: false)
Okno terminala
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/scrape-list \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"links": ["https://example.com/page1", "https://example.com/page2"],
"tags": ["imported"]
}'

Response 200 OK

{
"status": "success",
"links": ["https://example.com/page1", "https://example.com/page2"]
}

Zarzadzaj zewnetrznymi zrodlami tresci (np. Intercom, Shopify), ktore synchronizuja artykuly z Twoja Baza Wiedzy.

Parametr sciezki {source} przyjmuje wartosci takie jak "intercom", "shopify" itp.

POST https://app.quickchat.ai/v1/api/knowledge_base/sources/{source}/import

Okno terminala
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/sources/intercom/import \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{}'

Response 200 OK — Zwraca liste zaimportowanych migawek artykulow.

POST https://app.quickchat.ai/v1/api/knowledge_base/sources/{source}/delete

Usuwa wszystkie artykuly zaimportowane z danego zrodla.

Response 204 No Content

Porownaj lokalne artykuly ze zrodlem zewnetrznym w celu wykrycia zmian.

POST https://app.quickchat.ai/v1/api/knowledge_base/sources/{source}/articles_diff

Response 200 OK

[
{
"internal_article_diff": "CHANGED",
"external_article_diff": "UNCHANGED",
"article_snapshot": {}
}
]
FieldTypeDescription
internal_article_diffstring"CHANGED" lub "UNCHANGED"
external_article_diffstring"CHANGED", "UNCHANGED" lub "REMOVED"
article_snapshotobjectDane migawki artykulu

Dedykowane endpointy do zarzadzania integracja z Baza Wiedzy Intercom.

Ponownie pobierz tresc z Intercom dla istniejacych artykulow.

POST https://app.quickchat.ai/v1/api/knowledge_base/intercom/refresh_articles

Request Body

ParameterTypeRequiredDescription
article_idsarray of integersNoKonkretne ID artykulow do odswiezenia (domyslnie: wszystkie)
fetch_new_articlesbooleanNoCzy pobierac nowe artykuly (domyslnie: true)

Response 204 No Content

Importuj wszystkie artykuly z Intercom.

POST https://app.quickchat.ai/v1/api/knowledge_base/intercom/import

Response 200 OK — Zwraca liste zaimportowanych migawek artykulow.

Usun wszystkie artykuly pochodzace z Intercom z Bazy Wiedzy.

POST https://app.quickchat.ai/v1/api/knowledge_base/intercom/delete

Response 204 No Content

Porownaj lokalne artykuly z Intercom w celu wykrycia zmian.

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

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

Response 200 OK — Zwraca liste obiektow roznic artykulow (ten sam schemat co Porownaj artykuly ze zrodla).


GET https://app.quickchat.ai/v1/api_core/conversations

Query Parameters

ParameterTypeRequiredDescription
limitintegerNoElementow na strone
offsetintegerNoElementow do pominiecia
querystringNoSzukaj po numerze porzadkowym, UUID lub tresci wiadomosci
assignee_typestringNo"ai_assistant", "human_operator" lub "unassigned"
sourcestringNo"widget", "slack", "telegram", "whatsapp" itp.
resolution_statusstringNo"open" lub "resolved"
created_timestamp_start_datedatetimeNoFiltruj po dacie utworzenia (poczatek)
created_timestamp_end_datedatetimeNoFiltruj po dacie utworzenia (koniec)
last_message_at_start_datedatetimeNoFiltruj po dacie ostatniej wiadomosci (poczatek)
last_message_at_end_datedatetimeNoFiltruj po dacie ostatniej wiadomosci (koniec)
most_frequent_languagestringNoFiltruj po wykrytym jezyku
Okno terminala
curl 'https://app.quickchat.ai/v1/api_core/conversations?limit=10&resolution_status=open' \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK

{
"items": [
{
"id": "conv-uuid-1234",
"ord": 42,
"created_at": "2026-01-15T10:30:00Z",
"last_message_at": "2026-01-15T10:35:00Z",
"title": "Return policy question",
"source": "widget",
"terminated": false,
"resolution_status": "open",
"has_unread_messages": true,
"assignee": {
"type": "ai_assistant"
},
"visitor_name": "John",
"visitor_email": "john@example.com",
"visitor_phone_number": null,
"visitor_label": null
}
],
"offset": 0,
"count": 42
}

GET https://app.quickchat.ai/v1/api_core/conversations/{conversation_id}/

Okno terminala
curl https://app.quickchat.ai/v1/api_core/conversations/conv-uuid-1234/ \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK

{
"id": "conv-uuid-1234",
"ord": 42,
"created_at": "2026-01-15T10:30:00Z",
"last_message_at": "2026-01-15T10:35:00Z",
"title": "Return policy question",
"source": "widget",
"terminated": false,
"resolution_status": "open",
"has_unread_messages": true,
"assignee": {
"type": "ai_assistant"
},
"url": null,
"client_metadata": {"userId": 12},
"data_gathering": null,
"last_visitor_message_at": "2026-01-15T10:34:00Z",
"visitor_name": "John",
"visitor_email": "john@example.com",
"visitor_phone_number": null,
"visitor_label": null
}

Przechowuj i pobieraj niestandardowe metadane rozmow. Metadane sa walidowane wedlug schematu JSON, jesli taki jest skonfigurowany w Panelu.

GET https://app.quickchat.ai/v1/api_core/conversations/{conv_id}/metadata

Okno terminala
curl https://app.quickchat.ai/v1/api_core/conversations/conv-uuid-1234/metadata \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK

{
"metadata": {
"ticket_id": "T-1234",
"priority": "high"
}
}

Utworz lub zaktualizuj metadane rozmowy.

POST https://app.quickchat.ai/v1/api_core/conversations/{conv_id}/metadata

Request Body

ParameterTypeRequiredDescription
metadataobjectYesMetadane klucz-wartosc do zapisania
Okno terminala
curl -X POST https://app.quickchat.ai/v1/api_core/conversations/conv-uuid-1234/metadata \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"metadata": {
"ticket_id": "T-1234",
"priority": "high"
}
}'

Response 200 OK

{
"metadata": {
"ticket_id": "T-1234",
"priority": "high"
}
}

Utworz nowa Akcje AI Bazy Wiedzy. Akcje AI Bazy Wiedzy pozwalaja AI przeszukiwac otagowane podzbiory Bazy Wiedzy po ich wyzwoleniu.

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

Okno terminala
curl -X POST https://app.quickchat.ai/v1/api/ai_actions/knowledge_base \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{}'

Response 201 Created

{
"id": 1,
"name": "",
"description": "",
"icon": null,
"icon_color": null,
"is_active": false,
"is_valid": false,
"tag": null,
"parameter_description": "",
"type": "knowledge_base"
}
FieldTypeDescription
idintegerIdentyfikator Akcji AI
namestringNazwa wyswietlana (maks. 100 znakow)
descriptionstringOpis kiedy akcja powinna sie uruchomic (maks. 1000 znakow)
iconstring or nullIdentyfikator ikony
icon_colorstring or nullKolor ikony
is_activebooleanCzy akcja jest wlaczona
is_validbooleanCzy akcja jest prawidlowo skonfigurowana
tagstring or nullTag Bazy Wiedzy do filtrowania artykulow (maks. 255 znakow)
parameter_descriptionstringOpis parametru wyodrebnianego przez AI (maks. 500 znakow)
typestringZawsze "knowledge_base"

GET https://app.quickchat.ai/v1/api/ai_actions/{action_id}/knowledge_base

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

Response 200 OK — Zwraca obiekt Akcji AI (ten sam schemat co odpowiedz Utworz Akcje AI Bazy Wiedzy).

PUT https://app.quickchat.ai/v1/api/ai_actions/{action_id}/knowledge_base

Request Body

ParameterTypeRequiredDescription
namestringYesNazwa wyswietlana (maks. 100 znakow)
descriptionstringYesKiedy akcja powinna sie uruchomic (maks. 1000 znakow)
parameter_descriptionstringYesOpis parametru (maks. 500 znakow)
tagstringYesTag Bazy Wiedzy do filtrowania (maks. 255 znakow)
Okno terminala
curl -X PUT https://app.quickchat.ai/v1/api/ai_actions/1/knowledge_base \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Search Returns",
"description": "Search the return policy articles when customer asks about returns.",
"parameter_description": "The return-related query from the customer",
"tag": "returns"
}'

Response 200 OK — Zwraca zaktualizowany obiekt Akcji AI.