מאמרים

מאמרים הם אבני הבניין של מאגר הידע. צרו, הציגו, עדכנו ומחקו תוכן שסוכן ה-AI משתמש בו לתשובות.

מאמרים הם אבני הבניין של מאגר הידע של הסוכן. כל מאמר מייצג פיסת ידע: דף עזרה, שאלה נפוצה, תיאור מוצר או כל תוכן שה-AI צריך להכיר.

יש שלושה סוגים: מאמרים (מסמך מלא עם כותרת וגוף), פסקאות (טקסט קצר ועצמאי) ומאמרי URL (נוצרים אוטומטית בייבוא תוכן מהאינטרנט). אפשר ליצור ידנית דרך ה-API, לייבא מאתרים עם ייבוא תוכן חיצוני, להעלות קבצים דרך העלאת קבצים או לסנכרן מ-Intercom.

אין שלב אימון מחדש. כל מאמר שנוצר, מתעדכן או נמחק מעובד אוטומטית ברקע ונכנס לתוקף בסיום, לרוב בתוך שניות. עקבו עם embed_state למטה או עם pending_embed_count בקבלת הגדרות מאגר הידע.

בדיקות דוגמה אופציונליות

תצוגה מקדימה של בקשת פעולת API. הציגו תבנית שסיפקתם עם ערכי דוגמה מלאכותיים בלי לשלוח אותה. השמיטו כותרות של פרטי גישה.
תצוגה מקדימה של התאמות JSONPath. בדקו נתיבי שורש, שדות, אינדקסי מערך ותווים כלליים מול JSON שסיפקתם. אין הרצת פעולה או שמירת זיכרון שיחה.

יצירת מאמר

היקף הרשאות: write_all

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

גוף הבקשה

פרמטר	תיאור
`content` מחרוזת, חובה	תוכן המאמר
`type` מחרוזת	`"Article"` (ברירת מחדל) או `"Paragraph"`
`title` מחרוזת	כותרת המאמר

"Article": מסמך מאגר ידע מלא עם כותרת ותוכן. מתאים לשאלות נפוצות, מאמרי עזרה ותיאורי מוצרים.
"Paragraph": טקסט קצר ועצמאי ללא כותרת. מתאים לעובדות קצרות, תשובות בשורה אחת ונתוני עזר.
"URL" (קריאה בלבד): נוצר אוטומטית בייבוא מאתר. מכיל את תוכן הדף שנאסף עם כתובת המקור. אי אפשר להגדירו ביצירה.

Shell
Python

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

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()

תגובה 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
}

שדה	תיאור
`id` מספר שלם	המזהה המספרי של המאמר. זהו המזהה הקנוני בכל נתיבי הכתובות
`article_id` מחרוזת	מזהה מחרוזת ישן. עשוי להיות ריק; השתמשו ב-`id`
`type` מחרוזת	`"Article"`, `"Paragraph"` או `"URL"`
`title` מחרוזת	כותרת המאמר
`description` מחרוזת	תיאור המאמר
`content` מחרוזת	תוכן המאמר
`deploy_state` מחרוזת	`"draft"` או `"published"`: תווית בלבד (ראו הערה)
`embed_state` מחרוזת או null	האם המאמר זמין: `"pending"`, `"embedding"`, `"embedded"` או `"failed"` (ראו הערה)
`state` מחרוזת	מצב עיבוד פנימי (ראו הערה)
`refresh_failure_reason` מחרוזת	למה רענון ה-URL האחרון נכשל. ריק אם לא נשמר כשל מסווג
`version` מספר שלם או null	מספר הגרסה הנוכחית
`max_available_version` מספר שלם או null	הגרסה הגבוהה ביותר הזמינה
`url` מחרוזת או null	כתובת המקור (למאמרי URL)
`tags` מערך מחרוזות	תגיות משויכות
`created_timestamp` מחרוזת	תאריך יצירה
`last_modified_timestamp` מחרוזת	תאריך השינוי האחרון
`downloaded_timestamp` מחרוזת	תאריך הורדה
`last_updated_timestamp` מחרוזת	תאריך העדכון האחרון
`last_updated_from_external_source_timestamp` מחרוזת או null	העדכון האחרון ממקור חיצוני

למאמרים שלושה שדות מצב. רק אחד אומר אם הסוכן משתמש במאמר:

embed_state: השדה החשוב. "pending" ו-"embedding" פירושם שהעיבוד נמשך; "embedded" פירושו שהמאמר זמין והסוכן משתמש בו; "failed" פירושו שהעיבוד לא הושלם והמאמר אינו בשימוש. זה השדה לבדיקה אחרי כתיבה.
deploy_state: "draft" או "published". תווית לארגון שלכם בלבד; היא אינה משפיעה על שימוש ה-AI במאמר.
state: מצב פנימי של קבלת התוכן. רוב משתמשי ה-API יכולים להתעלם ממנו. במאמר URL, "refresh_failed" פירושו שהרענון האחרון לא החליף את התוכן השמור.
refresh_failure_reason: קטגוריה יציבה לכשל רענון URL מסווג: "http_error", "soft_404", "off_domain_redirect", "auth_wall", "error_page", "empty_content" או "thin_content". יכול להיות ריק אם האיסוף נכשל לפני סיווג הדף. התוכן האחרון נשאר זמין אלא אם גם embed_state נכשל.

רשימת מאמרים

היקף הרשאות: read_all

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

פרמטרי שאילתה

פרמטר	תיאור
`limit` מספר שלם	פריטים לדף
`offset` מספר שלם	פריטים לדילוג
`types` מחרוזת	סינון לפי סוג: `Article`, `Paragraph`, `URL`
`tags` מחרוזת	סינון לפי תג
`url` מחרוזת	סינון לפי כתובת
`title` מחרוזת	סינון לפי כותרת
`query` מחרוזת	חיפוש בתוכן

Shell
Python

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

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()

תגובה 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
}

תגובת הרשימה אינה כוללת את content. השתמשו בקבלת מאמר לקבלת התוכן המלא של מאמר מסוים.

קבלת מאמר

היקף הרשאות: read_all

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

Shell
Python

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

import requests

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

תגובה 200 OK: מחזירה את אובייקט המאמר המלא (כמו סכימת תגובת יצירת מאמר), כולל content.

עדכון מאמר

היקף הרשאות: write_all

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

גוף הבקשה

פרמטר	תיאור
`content` מחרוזת	תוכן מעודכן
`title` מחרוזת	כותרת מעודכנת
`tags` מערך מחרוזות	תגיות מעודכנות
`save_mode` מחרוזת	`"draft"` (ברירת מחדל) או `"publish"`

האפשרות save_mode: "draft" רק מגדירה את deploy_state; היא אינה מונעת מה-AI להשתמש בתוכן. מאמר טיוטה מעובד ומשמש בדיוק כמו מאמר שפורסם. אל תסתמכו עליה להכנה מוקדמת; כתבו מאמר רק כשאתם מוכנים שיהיה זמין.

Shell
Python

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

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()

תגובה 200 OK: מחזירה את אובייקט המאמר המעודכן.

מחיקת מאמרים

מחיקת מאמר אחד או יותר לפי מזהה.

היקף הרשאות: write_all

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

גוף הבקשה: מערך JSON של מזהי מאמרים.

Shell
Python

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

import requests

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

תגובה 200 OK

חיפוש מאמרים

חיפוש בתוכן מאמרים לפי התאמת טקסט.

היקף הרשאות: read_all

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

פרמטרי שאילתה

פרמטר	תיאור
`query` מחרוזת, חובה	שאילתת החיפוש
`is_case_insensitive` בוליאני	חיפוש ללא הבחנה בין אותיות גדולות וקטנות (ברירת מחדל: `true`)
`with_title_url_and_tags` בוליאני	הכללת כותרת/כתובת/תגיות בחיפוש (ברירת מחדל: `true`)
`strict_search` בוליאני	דרישת התאמה מדויקת (ברירת מחדל: `false`)
`num_of_display_articles` מספר שלם	מספר המאמרים להצגה (ברירת מחדל: `5`)
`num_of_data_articles` מספר שלם	מספר המאמרים לחיפוש (ברירת מחדל: `15`)

Shell
Python

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

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()

תגובה 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
  }
}

רשימת פסקאות

הצגת כל המאמרים מסוג Paragraph. פסקאות הן טקסטים קצרים ועצמאיים ללא כותרת, לעומת מאמרים מלאים עם כותרת וגוף.

היקף הרשאות: read_all

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

פרמטרי שאילתה

פרמטר	תיאור
`limit` מספר שלם	פריטים לדף
`offset` מספר שלם	פריטים לדילוג
`query` מחרוזת	סינון לפי תוכן

Shell
Python

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

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()

תגובה 200 OK

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

מאמרים

בדיקות דוגמה אופציונליות

יצירת מאמר

רשימת מאמרים

קבלת מאמר

עדכון מאמר

מחיקת מאמרים

חיפוש מאמרים

רשימת פסקאות

צעדים ראשונים

סוכן AI

פעולות

שיחות

ערוצים

האתר שלכם

תמיכה ו-CRM

אפליקציות הודעות

חשבון וחיוב

צעדים ראשונים

הגדרות

מאגר הידע

שיחות