Hoppa till innehåll

Artiklar är byggstenarna i din Knowledge Base. Skapa, lista, uppdatera och ta bort det innehåll din AI Agent använder för att besvara frågor.

Artiklar är byggstenarna i din AI Agents Knowledge Base. Varje artikel representerar en del kunskap — en hjälpsida, FAQ-post, produktbeskrivning eller vilket innehåll som helst som din AI bör känna till.

Det finns tre artikeltyper: Articles (fullständiga dokument med titel och brödtext), Paragraphs (korta fristående textposter) och URL articles (skapas automatiskt vid import av webbinnehåll). Du kan skapa artiklar manuellt via API:et, importera dem från webbplatser med Import External Content, ladda upp filer via File Upload eller synkronisera från Intercom.

Det finns inget omträningssteg. Varje artikel du skapar, uppdaterar eller tar bort bearbetas automatiskt i bakgrunden och får effekt så snart den är klar — vanligtvis inom några sekunder. Följ förloppet med fältet embed_state nedan, eller med pending_embed_count i Get Knowledge Base Settings.

Behörighetsomfång: write_all

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

Request Body

ParameterDescription
content
string, required
Artikelinnehåll
type
string
"Article" (standard) eller "Paragraph"
title
string
Artikeltitel
  • "Article" — Ett fullständigt knowledge base-dokument med titel och innehåll. Använd för FAQ-poster, hjälpartiklar, produktbeskrivningar.
  • "Paragraph" — En kort fristående textpost utan titel. Använd för korta fakta, enradssvar, snabbreferensdata.
  • "URL" (skrivskyddad) — Skapas automatiskt när innehåll importeras från en webbplats. Innehåller det skrapade sidinnehållet med käll-URL:en. Kan inte sättas vid skapande.
Terminal window
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",
"deploy_state": "draft",
"embed_state": "pending",
"refresh_failure_reason": "",
"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
}
FieldDescription
id
integer
Artikelns numeriska ID. Detta är den kanoniska identifieraren som används i alla URL-sökvägar
article_id
string
Äldre strängidentifierare. Kan vara tom — använd id i stället
type
string
"Article", "Paragraph" eller "URL"
title
string
Artikeltitel
description
string
Artikelbeskrivning
content
string
Artikelinnehåll
deploy_state
string
"draft" eller "published" — endast en etikett (se notisen nedan)
embed_state
string or null
Om artikeln är live: "pending", "embedding", "embedded" eller "failed" (se notisen nedan)
state
string
Intern bearbetningsstatus (se notisen nedan)
refresh_failure_reason
string
Varför den senaste URL-uppdateringen misslyckades. Tomt när ingen klassificerad orsak till uppdateringsfelet har sparats
version
integer or null
Aktuellt versionsnummer
max_available_version
integer or null
Högsta tillgängliga version
url
string or null
Käll-URL (för URL-artiklar)
tags
array of strings
Kopplade taggar
created_timestamp
string
Skapandedatum
last_modified_timestamp
string
Senaste ändringsdatum
downloaded_timestamp
string
Nedladdningsdatum
last_updated_timestamp
string
Senaste uppdateringsdatum
last_updated_from_external_source_timestamp
string or null
Senaste uppdatering från extern källa

Artiklar har tre tillståndsfält. Bara ett av dem talar om huruvida din AI Agent använder artikeln:

  • embed_state: Det som spelar roll. "pending" och "embedding" betyder att artikeln fortfarande bearbetas; "embedded" betyder att den är live och att din AI Agent använder den; "failed" betyder att bearbetningen inte slutfördes och att artikeln inte används. Det är det här fältet du ska polla efter en skrivning.
  • deploy_state: "draft" eller "published". Endast en etikett för din egen organisation — det påverkar inte om AI:n använder artikeln.
  • state: Intern status för innehållshämtning. För de flesta API-användare kan detta ignoreras. På en URL-artikel betyder "refresh_failed" att den senaste uppdateringen inte ersatte det sparade innehållet.
  • refresh_failure_reason: En stabil kategori för ett klassificerat URL-uppdateringsfel: "http_error", "soft_404", "off_domain_redirect", "auth_wall", "error_page", "empty_content" eller "thin_content". Fältet kan vara tomt om skrapningen misslyckades innan Quickchat kunde klassificera sidan. Det senast sparade innehållet förblir live om inte embed_state också har värdet "failed".
Behörighetsomfång: read_all

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

Query Parameters

ParameterDescription
limit
integer
Objekt per sida
offset
integer
Objekt att hoppa över
types
string
Filtrera efter typ: Article, Paragraph, URL
tags
string
Filtrera efter tagg
url
string
Filtrera efter URL
title
string
Filtrera efter titel
query
string
Sök efter innehåll
Terminal window
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",
"deploy_state": "published",
"embed_state": "embedded",
"refresh_failure_reason": "",
"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
}

Listsvaret inkluderar inte fältet content. Använd Get Article för att hämta det fullständiga innehållet i en specifik artikel.

Behörighetsomfång: read_all

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

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

Response 200 OK — Returnerar det fullständiga artikelobjektet (samma schema som svaret för Create Article), inklusive fältet content.

Behörighetsomfång: write_all

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

Request Body

ParameterDescription
content
string
Uppdaterat artikelinnehåll
title
string
Uppdaterad titel
tags
array of strings
Uppdaterade taggar
save_mode
string
"draft" (standard) eller "publish"

Alternativet save_mode: "draft" sätter endast flaggan deploy_state — det hindrar inte innehållet från att nå AI:n. En draft-artikel bearbetas och används precis som en publicerad. Förlita dig inte på det för att förbereda innehåll i förväg; skriv en artikel först när du är redo för att den ska gå live.

Terminal window
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 — Returnerar det uppdaterade artikelobjektet.

Ta bort en eller flera artiklar via ID.

Behörighetsomfång: write_all

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

Request Body — JSON-array med artikel-ID:n.

Terminal window
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

Sök igenom artikelinnehåll med textmatchning.

Behörighetsomfång: read_all

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

Query Parameters

ParameterDescription
query
string, required
Sökfråga
is_case_insensitive
boolean
Skiftlägesokänslig sökning (standard: true)
with_title_url_and_tags
boolean
Inkludera titel/URL/taggar i sökningen (standard: true)
strict_search
boolean
Kräv exakt matchning (standard: false)
num_of_display_articles
integer
Antal artiklar att visa (standard: 5)
num_of_data_articles
integer
Antal artiklar att söka i (standard: 15)
Terminal window
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 alla artiklar av typen Paragraph. Stycken är korta fristående textposter utan titel — till skillnad från fullständiga Articles som har både en titel och en innehållstext.

Behörighetsomfång: read_all

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

Query Parameters

ParameterDescription
limit
integer
Objekt per sida
offset
integer
Objekt att hoppa över
query
string
Filtrera efter innehåll
Terminal window
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
}