API Reference

ממשק ה-API של הפלטפורמה

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

openapi.json מדריך התחלה

בסיס ואימות

כתובת בסיס

https://api.slatech.ai

הנתיבים עצמם כוללים את /v1.

אימות

מפתח בכותרת ייעודית, לא Bearer:

X-Api-Key: <API_KEY>

שליחת Authorization: Bearer מוחזרת ב-401. המפתח נפתר ללקוח ולאתר, ואלה קובעים מה הבקשה רואה.

גרסה

OpenAPI 3.0.3, גרסת API 1.0.0. הקובץ נכתב ביד, ולכן כל נתיב בו נבדק מול השרת החי לפני הפרסום: נתיב שהחזיר 404 לא מופיע כאן.

נקודות קצה

פעולהנתיבמה זה עושה
POST/v1/queryשאלה אחת, תשובה מלאה. question חובה, עד 2,000 תווים.
POST/v1/query/streamאותו גוף בקשה, התשובה מגיעה בזרימה.
PATCH/v1/query/{id}/feedbackסימון אם התשובה הועילה.
GET/v1/widget-configהגדרות הווידג'ט עבור המפתח שנשלח.
GET/v1/suggested-questionsשאלות פתיחה להצעה למבקר.
GET/v1/visitor-historyתורות קודמים של מבקר חוזר.
POST/v1/handoffהעברה לנציג אנושי. email חובה.
POST/v1/ingest/urlאינדוקס התוכן שבכתובת.
POST/v1/ingest/sitemapאינדוקס כל הכתובות שבמפת האתר.
POST/v1/ingest/textאינדוקס טקסט שנשלח ישירות.
DELETE/v1/documents/{documentId}הסרת מסמך מהאינדקס.
GET/healthמצב הפלטפורמה. פתוח, בלי מפתח.

בקשה ראשונה

שליחת הודעה וקבלת תשובה, בלי SDK:

curl -X POST https://api.slatech.ai/v1/query \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"What are your opening hours?","topK":5}'

בלי מפתח תקף הבקשה חוזרת עם 401, ועם גוף לא תקין עם 400. topK בין 1 ל-20, ברירת המחדל 5.

מה לא נמצא במפרט

המפרט הפומבי מכסה שאילתות, הגדרות ווידג'ט, העברה לנציג ואינדוקס. Webhooks ופעולות מותאמות אינם חלק ממנו: הם נבנים לכל אינטגרציה בנפרד, לפי המערכות שאליהן מתחברים. אם אתם צריכים אותם, זה חלק מהאפיון. לא נציג כאן נקודת קצה שלא נבדקה מול השרת החי.

למה אנחנו מתחברים דברו איתנו