Articles

Artykuły to cegiełki Bazy Wiedzy Twojego AI Agenta. Każdy artykuł reprezentuje fragment wiedzy — stronę pomocy, wpis FAQ, opis produktu lub dowolną treść, którą Twoje AI powinno znać.

Istnieją trzy typy artykułów: Articles (pełne dokumenty z tytułem i treścią), Paragraphs (krótkie samodzielne wpisy tekstowe) oraz URL articles (tworzone automatycznie przy imporcie treści z sieci). Artykuły możesz tworzyć ręcznie przez API, importować ze stron internetowych za pomocą Import External Content, przesyłać pliki przez File Upload lub synchronizować z Intercomem.

Po utworzeniu lub zaktualizowaniu artykułów pamiętaj o ponownym wytrenowaniu Bazy Wiedzy, aby zmiany zaczęły obowiązywać.

Create Article

Scope: write_all

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

Request Body

Parameter	Description
content string, required	Treść artykułu
type string	"Article" (domyślnie) lub "Paragraph"
title string	Tytuł artykułu

Typy artykułów

• "Article" — Pełny dokument bazy wiedzy z tytułem i treścią. Używaj do wpisów FAQ, artykułów pomocy, opisów produktów.
• "Paragraph" — Krótki samodzielny wpis tekstowy bez tytułu. Używaj do krótkich faktów, jednozdaniowych odpowiedzi, danych szybkiego odniesienia.
• "URL" (tylko do odczytu) — Tworzony automatycznie, gdy treść jest importowana ze strony internetowej. Zawiera zescrapowaną treść strony wraz z URL źródłowym. Nie można go ustawić przy tworzeniu.

Shell

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

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/articles/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "content": "Our return policy allows returns within 30 days.",
        "title": "Return Policy",
    },
)
data = response.json()

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",
  "deploy_state": "draft",
  "version": null,
  "max_available_version": null,
  "url": null,
  "tags": [],
  "created_timestamp": "2026-01-15",
  "last_modified_timestamp": "2026-01-15",
  "downloaded_timestamp": "2026-01-15",
  "last_updated_timestamp": "2026-01-15",
  "last_updated_from_external_source_timestamp": null
}

Field	Description
id integer	Numeryczne ID artykułu. To kanoniczny identyfikator używany we wszystkich ścieżkach URL
article_id string	Starszy identyfikator tekstowy. Może być pusty — używaj id zamiast niego
type string	"Article", "Paragraph" lub "URL"
title string	Tytuł artykułu
description string	Opis artykułu
content string	Treść artykułu
deploy_state string	"draft" lub "published" — kontroluje widoczność artykułu
state string	Wewnętrzny status przetwarzania (zobacz uwagę poniżej)
version integer or null	Aktualny numer wersji
max_available_version integer or null	Najwyższa dostępna wersja
url string or null	URL źródłowy (dla artykułów typu URL)
tags array of strings	Powiązane tagi
created_timestamp string	Data utworzenia
last_modified_timestamp string	Data ostatniej modyfikacji
downloaded_timestamp string	Data pobrania
last_updated_timestamp string	Data ostatniej aktualizacji
last_updated_from_external_source_timestamp string or null	Ostatnia aktualizacja ze źródła zewnętrznego

Zrozumienie stanów artykułów

Artykuły mają dwa pola stanu:

• deploy_state: Kontroluje, czy artykuł jest "draft" czy "published". To główne pole, którego powinieneś używać do zarządzania widocznością artykułu.
• state: Odzwierciedla wewnętrzny status przetwarzania. Dla większości użytkowników API to pole można zignorować — śledzi ono kroki przetwarzania w backendzie i może pokazywać wartości takie jak "done" czy "published".

List Articles

Scope: read_all

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

Query Parameters

Parameter	Description
limit integer	Elementów na stronę
offset integer	Elementów do pominięcia
types string	Filtruj według typu: Article, Paragraph, URL
tags string	Filtruj według tagu
url string	Filtruj według URL
title string	Filtruj według tytułu
query string	Wyszukaj według treści

Shell

curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/?limit=10&offset=0' \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

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

Response 200 OK

{
  "items": [
    {
      "id": 1234,
      "article_id": "abc-123",
      "type": "Article",
      "title": "Return Policy",
      "description": "",
      "state": "published",
      "deploy_state": "published",
      "version": 1,
      "max_available_version": 1,
      "url": null,
      "tags": ["policies"],
      "created_timestamp": "2026-01-15",
      "last_modified_timestamp": "2026-01-15",
      "downloaded_timestamp": "2026-01-15",
      "last_updated_timestamp": "2026-01-15",
      "last_updated_from_external_source_timestamp": null
    }
  ],
  "offset": 0,
  "limit": 10,
  "count": 1
}

Notatka

Odpowiedź listy nie zawiera pola content. Użyj Get Article, aby pobrać pełną treść konkretnego artykułu.

Get Article

Scope: read_all

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

Shell

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

Python

import requests

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

Response 200 OK — Zwraca pełny obiekt artykułu (ten sam schemat co odpowiedź Create Article), w tym pole content.

Update Article

Scope: write_all

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

Request Body

Parameter	Description
content string	Zaktualizowana treść artykułu
title string	Zaktualizowany tytuł
tags array of strings	Zaktualizowane tagi
save_mode string	"draft" (domyślnie) lub "publish"

Uwaga

Opcja save_mode: "draft" ustawia jedynie flagę deploy_state — nie zapobiega wykorzystaniu treści artykułu przez AI po ponownym wytrenowaniu Bazy Wiedzy. W przypadku workflow programistycznych używaj save_mode: "publish" i wyzwalaj ponowne trenowanie, gdy będziesz gotowy, aby zmiany zaczęły obowiązywać.

Shell

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

Python

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/knowledge_base/articles/1234",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "title": "Updated Return Policy",
        "content": "Returns accepted within 60 days.",
        "save_mode": "publish",
    },
)
data = response.json()

Response 200 OK — Zwraca zaktualizowany obiekt artykułu.

Delete Articles

Usuń jeden lub więcej artykułów według ID.

Scope: write_all

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

Request Body — Tablica JSON z ID artykułów.

Shell

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

Python

import requests

response = requests.delete(
    url="https://app.quickchat.ai/v1/api/knowledge_base/articles/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json=[1234, 5678],
)

Response 200 OK

Search Articles

Przeszukuj treść artykułów z dopasowaniem tekstu.

Scope: read_all

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

Query Parameters

Parameter	Description
query string, required	Zapytanie wyszukiwania
is_case_insensitive boolean	Wyszukiwanie bez rozróżniania wielkości liter (domyślnie: true)
with_title_url_and_tags boolean	Uwzględnij tytuł/URL/tagi w wyszukiwaniu (domyślnie: true)
strict_search boolean	Wymagaj dokładnego dopasowania (domyślnie: false)
num_of_display_articles integer	Liczba artykułów do wyświetlenia (domyślnie: 5)
num_of_data_articles integer	Liczba artykułów do przeszukania (domyślnie: 15)

Shell

curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/search?query=return%20policy' \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

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

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

List Paragraphs

Listuj wszystkie artykuły typu Paragraph. Paragraphs to krótkie samodzielne wpisy tekstowe bez tytułu — w przeciwieństwie do pełnych Articles, które mają zarówno tytuł, jak i treść.

Scope: read_all

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

Query Parameters

Parameter	Description
limit integer	Elementów na stronę
offset integer	Elementów do pominięcia
query string	Filtruj według treści

Shell

curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/paragraphs?limit=10' \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

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

Response 200 OK

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

---