דלגו לתוכן

ניהול פעולות ה-AI של הסוכן דרך ה-API.

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

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

  • בדיקת חיבור MCP לדוגמה. אתחלו חיבור והציגו כלים רק בנקודת הקצה של תיעוד Cloudflare או Microsoft Learn. לא מתבצעת כניסה או הרצת כלים.

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

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

מה פעולות AI עושות:

  • פעולות בקשת HTTP: קוראות ל-API חיצוני בעת הפעלה. למשל בדיקת מצב הזמנה בשרת, יצירת כרטיס תמיכה או חיפוש פרטי חשבון, במהלך השיחה.
  • פעולות MCP: מתחברות לשרתי Model Context Protocol לשילוב כלים מתקדם, כמו חיפוש מוצרי Shopify או שאילתות מסד נתונים מותאמות.

שימושים נפוצים:

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

לכל פעולה name, description (בבקשת HTTP התיאור אומר ל-AI מתי להפעיל) והגדרות לפי סוג. אפשר להפעיל ולכבות כל פעולה דרך ה-API. יצירה והגדרה מלאה נעשות בלוח הבקרה של Quickchat. ה-API מספק רשימה, עדכון הפעלה/כיבוי ומחיקה, וגם נקודות ייעודיות ליצירה והגדרה של פעולות MCP.

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

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

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

תגובה 200 OK

[
{
"id": 1,
"name": "Check Order Status",
"description": "Look up order status when customer asks about their order.",
"is_active": true,
"type": "http_request",
"icon": null,
"icon_color": null,
"is_valid": true
}
]
שדהתיאור
id
מספר שלם
מזהה פעולת AI
name
מחרוזת
שם לתצוגה
description
מחרוזת
מתי הפעולה מופעלת
is_active
בוליאני
האם מופעלת
type
מחרוזת
"http_request", "remote_mcp", "shopify_remote_mcp" או "knowledge_base"
icon
מחרוזת או null
מזהה סמל
icon_color
מחרוזת או null
צבע הסמל
is_valid
בוליאני
האם הוגדרה נכון
היקף הרשאות: write_all

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

גוף הבקשה

פרמטרתיאור
is_active
בוליאני
הפעלה/כיבוי של הפעולה
icon
מחרוזת
מזהה סמל (עד 200 תווים)
icon_color
מחרוזת
צבע סמל (עד 50 תווים)
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/1 \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{"is_active": false}'

תגובה 200 OK: מחזירה תמונת מצב מעודכנת של הפעולה.

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

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

Terminal window
curl -X DELETE https://app.quickchat.ai/v1/api/ai_actions/1 \
-H 'Authorization: Bearer <API_TOKEN>'

תגובה 200 OK (גוף ריק)

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

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

מחברת שרת MCP מרוחק לסוכן כפעולת MCP. נדרש אסימון API עם write_all (אסימוני API דורשים תוכנית Business ומעלה).

גוף הבקשה

פרמטרתיאור
remote_mcp_url
מחרוזת, חובה
כתובת שרת MCP. חייבת להשתמש ב-https://; כתובות שנפתרות לכתובות רשת פרטיות או פנימיות נדחות
headers
מערך, חובה
כותרות חיבור שנשלחות לשרת, למשל אסימון Authorization סטטי. כל פריט הוא {"id", "name", "value"}; בחרו מחרוזת ייחודית כ-id. שלחו [] אם אין צורך
allowed_tools
מערך, חובה
מתגים לכל כלי, כל אחד {"name", "is_active"}. שלחו [] כדי להשאיר את הזמינות ל-default_tool_is_active
name
מחרוזת
שם ברשימת הפעולות (עד 100 תווים). ברירת המחדל נגזרת משם המארח
description
מחרוזת
תיאור ברשימת הפעולות (עד 2,500 תווים)
icon
מחרוזת
מזהה סמל (עד 200 תווים)
icon_color
מחרוזת
צבע סמל (עד 50 תווים)

name ו-description הם תוויות למפעיל: הם מזהים את הפעולה בלוח הבקרה, וה-AI אינו קורא אותם. הוא משתמש בתיאורי הכלים ששרת MCP מפרסם.

Terminal window
curl -X POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"remote_mcp_url": "https://mcp.example.com/mcp",
"headers": [
{"id": "h-1", "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"}
],
"allowed_tools": [],
"name": "Example MCP"
}'

תגובה 201 Created

{
"id": 2,
"name": "Example MCP",
"description": "Connected MCP server",
"is_active": false,
"type": "remote_mcp",
"icon": "FaMixcloud",
"icon_color": "#EF4444",
"is_valid": true,
"validation_issues": [],
"remote_mcp_url": "https://mcp.example.com/mcp",
"remote_mcp_auth_token": "",
"default_tool_is_active": true,
"allowed_tools": [],
"headers": [
{"id": 10, "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"}
],
"oauth": null,
"recommended_tools": []
}
שדהתיאור
remote_mcp_url
מחרוזת
כתובת שרת MCP המחובר
default_tool_is_active
בוליאני
האם מותר להשתמש בכלים שאינם ב-allowed_tools
allowed_tools
מערך
מתגים לכל כלי, {"name", "is_active"}
headers
מערך
כותרות חיבור שמורות
remote_mcp_auth_token
מחרוזת או null
שדה אסימון סטטי ישן. אי אפשר להגדירו דרך API זה; העבירו פרטי גישה דרך headers
oauth
אובייקט או null
מצב הרשאה לשרתים המחוברים עם כניסת OAuth (אחרת null)
recommended_tools
מערך
שמות כלים ש-Quickchat ממליצה לשרתים עם פרופיל מובנה (קריאה בלבד)
validation_issues
מערך
שמות בדיקות ההגדרה שנכשלו; ריק כש-is_valid הוא true

יתר השדות תואמים לרשימת כל פעולות ה-AI.

הפעולה נוצרת עם is_active: false. לשרתים ללא פרופיל מובנה של Quickchat היא מתחילה גם עם default_tool_is_active: true, כך שכל כלי שמתגלה בזמן התשובה מותר עד שתגבילו אותו. להפעלה, השתמשו בעדכון פעולת AI: PATCH /v1/api/ai_actions/{action_id} עם {"is_active": true}.

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

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

Terminal window
curl https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>'

תגובה 200 OK: מחזירה הגדרות MCP במבנה של תגובת היצירה למעלה.

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

PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp

כל השדות אופציונליים; רק מה שתשלחו ישתנה.

גוף הבקשה

פרמטרתיאור
remote_mcp_url
מחרוזת
כתובת שרת חדשה (מאומתת כמו ביצירה). שינוי כתובת שרת עם OAuth מנקה את ההרשאה השמורה ומכבה את הפעולה
headers
מערך
החלפת כותרות החיבור
allowed_tools
מערך
החלפת המתגים לכל כלי, כל אחד {"name", "is_active"}
default_tool_is_active
בוליאני
האם מותר להשתמש בכלים שאינם ב-allowed_tools
name
מחרוזת
שם לתצוגה (עד 100 תווים)
description
מחרוזת
תיאור ברשימת הפעולות (עד 2,500 תווים)
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"allowed_tools": [
{"name": "search_docs", "is_active": true},
{"name": "delete_page", "is_active": false}
],
"default_tool_is_active": false
}'

תגובה 200 OK: מחזירה את הפעולה המעודכנת במבנה של תגובת היצירה.

בדיקת חיבור וגילוי כלים, בדיקת חיבור בלוח הבקרה, אינם זמינים ב-API הציבורי. לוח הבקרה מריץ בדיקה אוטומטית בחיבור או בחיבור מחדש, ושרתים עם OAuth חייבים להשלים הרשאה בלוח הבקרה. שדה oauth בתגובות למעלה מדווח על המצב.