גישה תכנותית לחשבון Async: REST תחת /v1 ושרת MCP תחת /mcp, על אותו מפתח ואותן פעולות. העמוד הזה מרכז את ההגדרה, רשימת הפעולות, המגבלות והקישורים לתיעוד.
api:read לפעולות קריאה, api:write לפעולות כתיבה. send_whatsapp_template דורש בנוסף triggers:send.ak_ ומוצג פעם אחת בלבד.<<המפתח-שלכם>> מציין את מקום המפתח.claude mcp add --transport http async https://api.async.co.il/mcp \
--header "Authorization: Bearer <<המפתח-שלכם>>"/mcp בתוך claude מציג את מצב השרת async.
ב-claude_desktop_config.json (Settings ← Developer ← Edit Config):
{
"mcpServers": {
"async": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://api.async.co.il/mcp",
"--header", "Authorization:Bearer <<המפתח-שלכם>>"]
}
}
}נדרשת הפעלה מחדש של Claude Desktop.
Transport: Streamable HTTP. כתובת: https://api.async.co.il/mcp עם הכותרת Authorization: Bearer <<המפתח-שלכם>>.
ל-MCP אין מסמך תיעוד מקביל ל-OpenAPI; הפרוטוקול מתאר את עצמו. הלקוח שולח server/discover ומקבל את הגרסאות והיכולות, ואז tools/list, resources/list ו-prompts/list . כל כלי מוחזר עם תיאור וסכמת JSON של הפרמטרים; הטבלה למטה מציגה את אותו מידע. דפדפן אינו לקוח MCP: בקשת GET ל-/mcp מחזירה 405 עם קישור לעמוד הזה.
בנוסף לכלים, השרת מפרסם שלושה משאבים — async://agent/config, async://documents, async://insights/latest — ושני prompts: weekly_lead_review ו-stale_leads.
גרסת פרוטוקול: 2026-07-28. לקוחות שפותחים ב-initialize (גרסאות 2025-03-26 עד 2025-11-25, למשל mcp-remote) נתמכים באותה נקודת קצה.
134 פעולות, 76 מהן כותבות. כל פעולה היא כלי MCP ונקודת קצה ב-REST באותו שם ובאותם שדות. פעולת כתיבה מסומנת; tools/list מחזיר למפתח רק את הפעולות שההרשאות שלו מאפשרות.
לקרוא, לבנות ולערוך את האוטומציות של העסק — אותם תהליכים שבונים על הקנבס בדשבורד.
| כלי / נתיב REST | מה הוא עושה |
|---|---|
| list_workflows GET /v1/workflows | רשימת האוטומציות List this business's automations, without their step definitions. |
| get_workflow GET /v1/workflows/{workflow_id} | אוטומציה אחת במלואה, כולל השלבים Read one automation in full, including its ``spec``. |
| get_workflow_options GET /v1/workflows/options | סוגי השלבים, הטריגרים והערוצים הזמינים לעסק. נקרא לפני בניית אוטומציה READ THIS BEFORE AUTHORING A ``spec`` — the vocabulary a workflow may use. |
| create_workflow כתיבה POST /v1/workflows | בניית אוטומציה חדשה Create an automation for this business. |
| update_workflow כתיבה POST /v1/workflows/{workflow_id} | עריכת אוטומציה קיימת (החלפה מלאה) Replace an automation WHOLESALE — key, name, enabled and spec together. |
| set_workflow_enabled כתיבה POST /v1/workflows/{workflow_id}/enabled | הפעלה או השהיה Switch one automation on or off, leaving its definition untouched. |
| delete_workflow כתיבה POST /v1/workflows/{workflow_id}/delete | מחיקה. סופית, בלי ארכיון Delete an automation permanently. There is no undo and no archive. |
מה הסוכן יודע ואיך הוא מתנהג. כל שינוי עובר את אותה בדיקה ורישום כמו עריכה בדשבורד.
| כלי / נתיב REST | מה הוא עושה |
|---|---|
| get_agent_config GET /v1/agent | איך הסוכן מוגדר: שם, שפה, הנחיות, שאלות נפוצות, זיכרון, שעות שירות How this business's AI agent is configured. |
| update_agent_config כתיבה POST /v1/agent | שינוי ההנחיות, השאלות הנפוצות, הזיכרון, רמת ההסלמה ושעות השירות Change what this business's agent says to its customers. |
| list_documents GET /v1/documents | מקורות הידע שהסוכן עונה מהם, עם מצב האינדוקס List the knowledge sources the business's agent answers from. |
| search_knowledge GET /v1/documents/search | חיפוש לפי משמעות בתוך מקורות הידע Search the business's knowledge sources by MEANING. |
| add_document_url כתיבה POST /v1/documents/link | הוספת עמוד אינטרנט למקורות הידע Add a web page to what the business's agent can answer from. |
| add_document_text כתיבה POST /v1/documents/text | הוספת טקסט חופשי כמקור ידע Add plain text to what the business's agent can answer from. |
| set_document_mode כתיבה POST /v1/documents/{document_id}/mode | מעבר בין "נחפש לפי צורך" ל"תמיד בהנחיות" Switch a web source between searched-on-demand and always-in-prompt. |
| rename_document כתיבה POST /v1/documents/{document_id}/title | שינוי שם למקור Rename a knowledge source, permanently. |
| delete_document כתיבה POST /v1/documents/{document_id}/delete | הסרת מקור. סופי Remove a knowledge source. Permanent. |
כל שיחה מציינת מי מטפל בה — הסוכן או אדם — ואם היא עדיין פעילה.
| כלי / נתיב REST | מה הוא עושה |
|---|---|
| list_conversations GET /v1/conversations | השיחות בכל הערוצים, עם owner (agent / human) ו-active; סינון לפעילות או לפי מי מטפל List conversation threads, newest activity first. |
| get_conversation_messages GET /v1/conversations/{conversation_id}/messages | התכתובת המלאה של שיחה אחת Read a conversation's transcript — the LAST ``limit`` messages. |
| search_messages GET /v1/conversations/search | חיפוש טקסט בתוך כל השיחות Full-text search across this business's message content. |
| pause_agent כתיבה POST /v1/conversations/{conversation_id}/agent/pause | השהיית הסוכן בשיחה אחת (אדם לוקח אותה) Stop the AI agent from answering in one conversation. |
| resume_agent כתיבה POST /v1/conversations/{conversation_id}/agent/resume | החזרת הסוכן לשיחה Let the AI agent answer in this conversation again. |
הסיכום שהדשבורד מציג: נושאים מובילים, איפה לקוחות נתקעים, שאלות שלא נענו, המלצות.
| כלי / נתיב REST | מה הוא עושה |
|---|---|
| get_insights GET /v1/insights | הסיכום היומי (range=1), השבועי (7) או החודשי (30). זמין גם כמשאב MCP: async://insights/latest Read what this business's customer conversations said — the AI digest. |
| get_metrics GET /v1/metrics | מדדי הביצועים לתקופה The business's performance numbers for a window. |
בדיקת הסוכן בשפה חופשית, בארגז חול שלא נספר בסטטיסטיקה ולא שולח התראות.
| כלי / נתיב REST | מה הוא עושה |
|---|---|
| qa_chat כתיבה POST /v1/qa/chat | הודעה אחת לסוכן, בדיוק כמו מבקר באתר, והתשובה חוזרת. reset מתחיל שיחה נקייה, session מאפשר כמה שיחות במקביל Send one message to this business's own customer-facing agent and read its answer. |
הנתונים שהדשבורד מציג בלקוחות, במשימות, בהזמנות ובקטלוג.
| כלי / נתיב REST | מה הוא עושה |
|---|---|
| list_customers GET /v1/customers | רשימת הלקוחות List the business's customers, newest conversation first. |
| get_customer GET /v1/customers/{user_id} | כרטיס לקוח, עם השיחות האחרונות One customer, with their recent conversations. |
| list_customer_purchases GET /v1/customers/{user_id}/purchases | היסטוריית הרכישות של לקוח This customer's store orders, newest first. |
| add_customer_note כתיבה POST /v1/customers/{user_id}/notes | הערה פרטית לכרטיס הלקוח Append a private note to a customer's file. |
| set_customer_status כתיבה POST /v1/customers/{user_id}/status | סטטוס בפייפליין Move a customer to a pipeline status, or clear their status. |
| list_inbox GET /v1/inbox | המשימות, הלידים והפניות הפתוחות List the business's open work: tasks, escalated questions, callbacks, |
| get_inbox_item GET /v1/inbox/{source}/{item_id} | פריט אחד מהתיבה Read one inbox row by its ``source`` and ``id``. |
| create_task כתיבה POST /v1/inbox/tasks | פתיחת משימה Open a to-do on the business's inbox board. |
| run_inbox_action כתיבה POST /v1/inbox/{source}/{item_id}/actions/{action_key} | סגירה, עדכון או מענה על פריט Act on an inbox row: close it, edit it, or reply to the customer. |
| list_bookings GET /v1/bookings | ההזמנות והתורים List activity bookings, newest first. |
| get_booking GET /v1/bookings/{booking_id} | הזמנה אחת במלואה One booking in full, by its id. |
| list_activities GET /v1/activities | הפעילויות שהעסק מציע List the activities this business sells, newest first. |
| get_availability GET /v1/activities/{activity_id}/availability | המועדים הפנויים לפעילות Bookable slots for one activity — the same availability the agent offers. |
| list_orders GET /v1/orders | הזמנות מהחנות Page through the business's store orders, newest first. |
| get_order GET /v1/orders/{order_id} | הזמנה אחת מהחנות One store order, by OUR id for it. |
| list_products GET /v1/catalog/products | המוצרים בקטלוג Page through the business's product catalog. |
| search_catalog GET /v1/catalog/search | חיפוש מוצר לפי משמעות Find products by MEANING — the same search the business's own agent uses. |
| send_whatsapp_template כתיבה POST /v1/messaging/whatsapp/template | שליחת תבנית וואטסאפ מאושרת ללקוח (דורש triggers:send) Send an approved WhatsApp template message to a customer. |
פעולות שנוספו ל-API ועדיין לא קיבלו מקום בעמוד הזה.
| כלי / נתיב REST | מה הוא עושה |
|---|---|
| list_contacts GET /v1/contacts | Page through the business's outbound contact book. |
| create_contact כתיבה POST /v1/contacts | Add someone to the outbound contact book. Sends nothing. |
| list_contact_groups GET /v1/contacts/groups | List the contact groups, with how many people are in each. |
| create_contact_group כתיבה POST /v1/contacts/groups | Create a contact group — the unit a campaign's audience is named in. |
| delete_contact_group כתיבה POST /v1/contacts/groups/{group_id}/delete | Delete a group. The CONTACTS in it are not deleted — only the grouping. |
| update_contact כתיבה POST /v1/contacts/{contact_id} | Edit a contact. Omitted fields are left alone. |
| delete_contact כתיבה POST /v1/contacts/{contact_id}/delete | Remove someone from the contact book. Permanent. |
| list_campaigns GET /v1/campaigns | List the business's outbound campaigns and how each one is doing. |
| create_campaign כתיבה POST /v1/campaigns | Create a campaign DRAFT. Nothing is sent and nobody is messaged. |
| preview_campaign כתיבה POST /v1/campaigns/preview | Ask what a campaign WOULD do, before it does it. Sends nothing. |
| quick_send_campaign כתיבה POST /v1/campaigns/quick-send | Send an approved template to a named list of people. THIS SPENDS MONEY. |
| get_campaign GET /v1/campaigns/{campaign_id} | Read one campaign — its status and its funnel. |
| list_campaign_recipients GET /v1/campaigns/{campaign_id}/recipients | Page through one campaign's recipients, person by person. |
| launch_campaign כתיבה POST /v1/campaigns/{campaign_id}/launch | Start sending a draft campaign. THIS SPENDS MONEY AND CANNOT BE UNDONE. |
| pause_campaign כתיבה POST /v1/campaigns/{campaign_id}/pause | Stop a running campaign. Resumable, and safe to call at any time. |
| resume_campaign כתיבה POST /v1/campaigns/{campaign_id}/resume | Continue a paused campaign from where it stopped. This resumes SPENDING. |
| cancel_campaign כתיבה POST /v1/campaigns/{campaign_id}/cancel | Stop a campaign for good. Terminal — it cannot be resumed. |
| sync_catalog כתיבה POST /v1/catalog/sync | Re-read the WHOLE catalog from the business's connected store(s). |
| refresh_product כתיבה POST /v1/catalog/products/{product_id}/refresh | Re-read ONE product from the store — price, stock and variants. |
| start_conversation כתיבה POST /v1/conversations | Message a customer first, as the business, over WhatsApp or email. |
| send_message כתיבה POST /v1/conversations/{conversation_id}/messages | Reply to a customer in an open conversation, as the business. |
| send_email כתיבה POST /v1/conversations/{conversation_id}/send-email | Email the customer of a conversation, as the business — from any channel's thread. |
| list_email_mailboxes GET /v1/email/mailboxes | The business's connected email mailboxes, default first. |
| update_email_mailbox כתיבה POST /v1/email/mailboxes/{mailbox} | Change one mailbox's signature and/or the department its new tickets are routed to. |
| hide_conversation כתיבה POST /v1/conversations/{conversation_id}/hide | Delete a conversation from the business's dashboard — spam, tests, junk. |
| unhide_conversation כתיבה POST /v1/conversations/{conversation_id}/unhide | Bring back a conversation deleted with ``hide_conversation``: it returns to |
| list_couriers GET /v1/couriers | List the delivery companies this business ships with, and the agent's rules for each. |
| update_courier כתיבה POST /v1/couriers/{courier_id} | Change what the agent tells customers about one delivery company. |
| post_custom_channel_message כתיבה POST /v1/custom-channel/messages | Run one customer message through the business's agent and return its reply. |
| post_custom_channel_outbound כתיבה POST /v1/custom-channel/outbound | Record a message the business sent the customer itself; Async sends nothing. |
| create_customer כתיבה POST /v1/customers | Add a customer to the business's customer book by phone — someone who |
| list_customer_automations GET /v1/customer-automations | The automated messages that have reached this business's customers — a |
| list_customer_hotel_reservations GET /v1/customers/{user_id}/hotel-reservations | This customer's hotel reservations from the hotel's own system (PMS), |
| delete_customer כתיבה POST /v1/customers/{user_id}/delete | Delete a customer from the business's dashboard — spam, tests, junk. |
| restore_customer כתיבה POST /v1/customers/{user_id}/restore | Bring back a customer deleted with ``delete_customer`` (or from the dashboard). |
| set_customer_owner כתיבה POST /v1/customers/{user_id}/owner | Set a customer's point of contact at the business: a person, a |
| list_customer_interest_options GET /v1/customer-interests | The business's own list of customer INTERESTS — the topics its AI agent |
| set_customer_interests כתיבה POST /v1/customers/{user_id}/interests | Add and/or remove a customer's interests. |
| list_customer_fields GET /v1/customer-fields | The business's own custom CUSTOMER FIELDS ("membership number", "renewal date"), |
| set_customer_field_value כתיבה POST /v1/customers/{user_id}/fields/{field_key} | Set one custom field on one customer, replacing any previous value. |
| reindex_document כתיבה POST /v1/documents/{document_id}/reindex | Read a knowledge source again, from scratch. |
| reindex_documents כתיבה POST /v1/documents/reindex | Read every WEB source again — the business's whole knowledge refresh. |
| list_sign_templates GET /v1/esign/templates | List the business's saved documents for e-signature (newest first); use an id with ``send_sign_request``. |
| list_sign_requests GET /v1/esign/requests | List the e-signature requests sent to one customer (``customer_id`` from ``list_customers``), newest first. |
| send_sign_request כתיבה POST /v1/esign/requests | Send a customer a link to sign the given ready templates, over WhatsApp and/or email; returns the new request. |
| get_sign_request GET /v1/esign/requests/{request_id} | Get one e-signature request's status; once signed, ``signed_pdf_url`` downloads the signed PDF for 15 minutes. |
| cancel_sign_request כתיבה POST /v1/esign/requests/{request_id}/cancel | Cancel an unsigned e-signature request so its link stops working; a signed or closed one is 409 ``not_open``. |
| get_inbox_ticket GET /v1/inbox/ticket/{ticket_id} | Read the inbox row a hand-off ticket opens, by the row's ``ticket_id``. |
| end_take_over כתיבה POST /v1/inbox/take-over/end | End take-over: complete closes and keeps the agent paused; done closes and resumes; cancel releases attached work. Optional item='source:id' refuses a changed holder with 409; malformed items return 422. |
| run_inbox_bulk כתיבה POST /v1/inbox/bulk | Close, reopen, park or unpark many inbox rows in one call (at most 100). |
| list_attributed_orders GET /v1/metrics/orders | The orders the agent is credited with for a window, newest first. |
| get_readiness GET /v1/readiness | Read how ready this business's AI agent is for customers — the readiness exam. |
| get_reply_rules GET /v1/agent/reply-rules | The business's reply rules (כללי מענה) on WhatsApp, Messenger and Instagram. |
| set_reply_rules כתיבה POST /v1/agent/reply-rules | Replace the business's reply rules — the WHOLE object: a channel you leave out is turned off. |
| list_saved_replies GET /v1/saved-replies | List the business's saved replies, in the order they are kept. |
| create_saved_reply כתיבה POST /v1/saved-replies | Add a saved reply: a short title to find it by, and the text to send. |
| update_saved_reply כתיבה POST /v1/saved-replies/{reply_id} | Change a saved reply's title, text, category, or any of them. |
| delete_saved_reply כתיבה POST /v1/saved-replies/{reply_id}/delete | Delete a saved reply. Messages already sent with it are not affected. |
| list_segments GET /v1/segments | List the saved segments (dynamic audiences), newest first. |
| create_segment כתיבה POST /v1/segments | Create a segment: a named, saved rule tree over the business's people. Sends nothing. |
| count_segment כתיבה POST /v1/segments/{segment_id}/count | Count how many people a segment matches right now. |
| get_service_report GET /v1/service/reports | The CS report: cases opened (``opened_rep``: by a rep) / resolved (``resolved_rep`` + ``resolved_ai``, by the agent) / |
| get_service_sla_policy GET /v1/service/sla | The business's first-response SLA: target, warning point, holidays, who is alerted. |
| update_service_sla_policy כתיבה POST /v1/service/sla | Replace the business's first-response SLA policy (every field; omitted ones reset). |
| list_service_topics GET /v1/service/topics | The business's service topics (what a closed case was about) and the repeat window. |
| update_service_topics כתיבה POST /v1/service/topics | Replace the topic list, the auto-filing switch and the repeat window (every field). |
| set_inbox_item_topic כתיבה POST /v1/service/topics/item | Set the topic of an inbox item's case, open or closed (409 ``case_not_closed``: no case). |
| list_sites GET /v1/sites | List the websites this business runs, and the chat widget on each. |
| get_site GET /v1/sites/{site_id} | One website of this business, with its widget settings. |
| update_site כתיבה POST /v1/sites/{site_id} | Rename a website, switch it on or off, or change the chat widget on it. |
| list_team GET /v1/team | The people on this business's team — who a customer can be assigned to. |
| list_departments GET /v1/departments | The business's departments (e.g. sales, shipping), active and inactive. |
| update_department_assignment כתיבה POST /v1/departments/{department_id}/assignment | Change how ONE department hands out new cases to its reps. |
| get_service_team GET /v1/service/team | The live team board: each department's waiting customers and each rep's status, open |
| move_rep_customers כתיבה POST /v1/service/team/move | Move customers from one rep to another rep (or back to the pool), e.g. when someone is out. |
| place_call כתיבה POST /v1/customers/{user_id}/call | Call a customer through the business's connected phone system: the teammate's |
| get_widget_page_rules GET /v1/web-widget/page-rules | Which pages of the business's website the chat widget hides on, or goes quiet on. |
| set_widget_page_rules כתיבה POST /v1/web-widget/page-rules | Change where the chat widget hides or goes quiet. Each list you send REPLACES the stored one. |
| list_whatsapp_templates GET /v1/messaging/whatsapp/templates | List the business's WhatsApp templates and where each one stands. |
| create_whatsapp_template כתיבה POST /v1/messaging/whatsapp/templates | Write a new WhatsApp template. It is created as a DRAFT and sends nothing. |
| sync_whatsapp_templates כתיבה POST /v1/messaging/whatsapp/templates/sync | Import the templates that already exist in the business's WhatsApp Manager. |
| get_whatsapp_template_sync GET /v1/messaging/whatsapp/templates/sync | Where the WhatsApp Manager import stands — poll after ``sync_whatsapp_templates``. |
| get_whatsapp_template GET /v1/messaging/whatsapp/templates/{template_id} | Read one template — its body, its variables and its approval state. |
| update_whatsapp_template כתיבה POST /v1/messaging/whatsapp/templates/{template_id} | Edit a template that has not been approved. Omitted fields are left alone. |
| set_whatsapp_template_header_image כתיבה POST /v1/messaging/whatsapp/templates/{template_id}/header-image | Attach the picture that rides above a template's text. |
| set_whatsapp_template_header_video כתיבה POST /v1/messaging/whatsapp/templates/{template_id}/header-video | Attach the video that rides above a template's text. |
| submit_whatsapp_template כתיבה POST /v1/messaging/whatsapp/templates/{template_id}/submit | Send a template to Meta for review. |
| refresh_whatsapp_template כתיבה POST /v1/messaging/whatsapp/templates/{template_id}/refresh | Ask Meta where a template stands, right now. |
| set_whatsapp_template_scenario כתיבה POST /v1/messaging/whatsapp/templates/{template_id}/scenario | Bind a template to the scenario name ``send_whatsapp_template`` calls it by. |
| delete_whatsapp_template כתיבה POST /v1/messaging/whatsapp/templates/{template_id}/delete | Remove a template the business no longer uses. |
| get_whatsapp_sender GET /v1/messaging/whatsapp/sender | Read the health of the number the business sends WhatsApp from. |
| get_account_health GET /v1/account-health | Read operational issues and repair links; unverified checks do not establish channel health. |
api:read מספיק לקריאה; api:write נדרש רק לפעולות כתיבה.untrusted_text, כך שמודל יתייחס אליו כנתונים ולא כהוראות.qa_chat מפעיל תור מודל אמיתי על חשבון העסק, ולכן מוגבל בנפרד ובחומרה.כל פעולה זמינה כנקודת קצה תחת https://api.async.co.il/v1. סכמות מלאות ב-OpenAPI.
curl "https://api.async.co.il/v1/conversations?active_only=true" \
-H "Authorization: Bearer <<המפתח-שלכם>>"פעולות כתיבה שאינן חוזרות על עצמן (למשל create_workflow) דורשות כותרת Idempotency-Key. שגיאות חוזרות כ-{"detail", "code"}; חריגה ממכסה מחזירה 429 עם Retry-After.