{"openapi": "3.1.0", "info": {"title": "Asyntai", "version": "1.0.0", "description": "Run your website's Asyntai AI support agent: knowledge base, agent instructions, conversations, leads, live replies and plan usage. Every operation acts on the signed-in user's own account."}, "servers": [{"url": "https://asyntai.com"}], "paths": {"/api/gpt/tools/list_websites": {"post": {"operationId": "list_websites", "summary": "List websites", "description": "List the websites (AI agents) on this Asyntai account, with the id every other tool takes. Start here when the account may have more than one.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/get_account": {"post": {"operationId": "get_account", "summary": "Get account and usage", "description": "Get the signed-in account's email, plan, and how many chat messages it has used against its monthly allowance.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/list_plans": {"post": {"operationId": "list_plans", "summary": "Compare plans", "description": "List every Asyntai plan with its price, monthly message allowance and the features it includes, alongside the plan this account is on. Use it to explain which plan includes a feature the account asks about.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/search_asyntai_docs": {"post": {"operationId": "search_asyntai_docs", "summary": "Search the Asyntai documentation", "description": "Search Asyntai's own product documentation and get back the pages that match, with a short excerpt from each. Use this to find out how a feature works before changing anything, rather than guessing. This searches Asyntai's documentation, NOT the customer's own content: for that, use search_knowledg…", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"query": {"type": "string", "description": "What to look for."}, "limit": {"type": "integer", "description": "How many pages to return, 1 to 20. Default 8."}}, "required": ["query"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/get_asyntai_doc": {"post": {"operationId": "get_asyntai_doc", "summary": "Read one documentation page", "description": "Read one page of Asyntai's documentation in full, given the url or slug from search_asyntai_docs, for example /documentation/mcp/ or just mcp.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"page": {"type": "string", "description": "The url or slug of the page to read."}}, "required": ["page"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/get_website": {"post": {"operationId": "get_website", "summary": "Get one website", "description": "Get the full record for one website: its name, domain, platform, widget id and the embed code to paste into the site.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/get_widget_settings": {"post": {"operationId": "get_widget_settings", "summary": "Get the chat widget settings", "description": "Read all appearance and behaviour settings for one website's chat widget: colours, greeting, position, auto-trigger, data collection, bookings and the rest. Also returns which settings this account's plan cannot change, and the plan each of those needs. The greeting and auto-trigger are one general…", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/search_knowledge_base": {"post": {"operationId": "search_knowledge_base", "summary": "Search the knowledge base", "description": "Search one website's knowledge base and return the passages the chatbot would retrieve for this question, with a relevance score. Use this to check what the chatbot knows about a topic. It does not generate an answer and does not use the message allowance.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"query": {"type": "string", "description": "What to look for, in plain language."}, "website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "limit": {"type": "integer", "description": "How many passages to return (1-20, default 5).", "minimum": 1, "maximum": 20}}, "required": ["query"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/list_knowledge": {"post": {"operationId": "list_knowledge", "summary": "List knowledge base entries", "description": "List the sources in one website's knowledge base: uploaded text, documents, added pages and crawls.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "limit": {"type": "integer", "description": "How many entries to return (1-100, default 50).", "minimum": 1, "maximum": 100}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/get_knowledge_entry": {"post": {"operationId": "get_knowledge_entry", "summary": "Read one knowledge base entry", "description": "Read the stored text of one knowledge base entry. Works for the content you supplied: text, documents, spreadsheets, single pages and videos. A website crawl is listed but not exported, because the source is your own public site.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"entry_id": {"type": "string", "description": "The entry id from list_knowledge."}}, "required": ["entry_id"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/add_knowledge_text": {"post": {"operationId": "add_knowledge_text", "summary": "Add text to the knowledge base", "description": "Add a titled block of text to one website's knowledge base. The chatbot can use it in answers as soon as this returns. Adds a new entry; it never replaces an existing one.", "x-openai-isConsequential": true, "security": [{"asyntaiOAuth": ["asyntai:write"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"title": {"type": "string", "description": "Short name for this entry, shown in the dashboard."}, "content": {"type": "string", "description": "The text itself. At least 10 characters."}, "website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}}, "required": ["title", "content"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/add_knowledge_url": {"post": {"operationId": "add_knowledge_url", "summary": "Add a page to the knowledge base", "description": "Fetch one web page and add its text to the knowledge base. Use this for a single page. To take in a whole site, use start_crawl instead.", "x-openai-isConsequential": true, "security": [{"asyntaiOAuth": ["asyntai:write"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"url": {"type": "string", "description": "Full address of the page, including https://."}, "website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}}, "required": ["url"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/delete_knowledge_entry": {"post": {"operationId": "delete_knowledge_entry", "summary": "Delete a knowledge base entry", "description": "Permanently delete one knowledge base entry and every passage built from it. The chatbot stops using that content immediately. This cannot be undone.", "x-openai-isConsequential": true, "security": [{"asyntaiOAuth": ["asyntai:write"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"entry_id": {"type": "string", "description": "The entry id from list_knowledge."}}, "required": ["entry_id"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/start_crawl": {"post": {"operationId": "start_crawl", "summary": "Crawl a website into the knowledge base", "description": "Crawl a website and add its pages to the knowledge base. Runs in the background; check on it with list_crawls. Each plan caps the pages per crawl, and asking for more than the cap is refused.", "x-openai-isConsequential": true, "security": [{"asyntaiOAuth": ["asyntai:write"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "start_url": {"type": "string", "description": "Where to start. Defaults to the website's own domain."}, "max_pages": {"type": "integer", "description": "How many pages to take at most. Capped by the plan.", "minimum": 1}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/list_crawls": {"post": {"operationId": "list_crawls", "summary": "List crawl jobs", "description": "List recent crawl jobs for one website with their status, how many pages they took, and why each one stopped.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "limit": {"type": "integer", "description": "How many jobs to return (1-50, default 10).", "minimum": 1, "maximum": 50}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/get_ai_instructions": {"post": {"operationId": "get_ai_instructions", "summary": "Get the AI instructions", "description": "Get the instructions that shape how one website's chatbot answers: its role, tone and rules.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/update_ai_instructions": {"post": {"operationId": "update_ai_instructions", "summary": "Replace the AI instructions", "description": "Replace one website's AI instructions with new text. This overwrites the current instructions and changes how the live chatbot answers every visitor. Read them with get_ai_instructions first, and show the user what will change before calling this.", "x-openai-isConsequential": true, "security": [{"asyntaiOAuth": ["asyntai:write"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"instructions": {"type": "string", "description": "The full new instructions text."}, "website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}}, "required": ["instructions"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/list_conversations": {"post": {"operationId": "list_conversations", "summary": "List recent conversations", "description": "List recent visitor conversations for one website, newest first, with the session id, message count and any email or phone the visitor gave.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "days": {"type": "integer", "description": "How many days back to look (1-90, default 7).", "minimum": 1, "maximum": 90}, "limit": {"type": "integer", "description": "How many conversations to return (1-100, default 20).", "minimum": 1, "maximum": 100}, "with_leads_only": {"type": "boolean", "description": "Only return conversations where the visitor left an email or phone."}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/get_conversation": {"post": {"operationId": "get_conversation", "summary": "Read one conversation", "description": "Read the full message history of one conversation, in order, from its session id.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"session_id": {"type": "string", "description": "Session id from list_conversations."}, "limit": {"type": "integer", "description": "How many messages to return (1-200, default 100).", "minimum": 1, "maximum": 200}}, "required": ["session_id"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/list_knowledge_gaps": {"post": {"operationId": "list_knowledge_gaps", "summary": "List knowledge gaps", "description": "List the Knowledge Gaps Asyntai recorded: real visitor questions the chatbot could not answer. Use this to find what to fill in with add_knowledge_text. Needs the Standard plan or higher.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "days": {"type": "integer", "description": "How many days back to look (1-90, default 30).", "minimum": 1, "maximum": 90}, "limit": {"type": "integer", "description": "How many gaps to return (1-100, default 25).", "minimum": 1, "maximum": 100}, "include_resolved": {"type": "boolean", "description": "Include gaps already marked as resolved. Off by default."}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/list_leads": {"post": {"operationId": "list_leads", "summary": "List captured leads", "description": "List the email addresses and phone numbers visitors left in chat, newest first, with the page they were on.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "limit": {"type": "integer", "description": "How many leads to return (1-100, default 50).", "minimum": 1, "maximum": 100}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/get_analytics": {"post": {"operationId": "get_analytics", "summary": "Get chat analytics", "description": "Summarise one website's chat activity over a period: conversations, messages, leads captured, escalations, and the countries visitors came from.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "days": {"type": "integer", "description": "How many days back to measure (1-90, default 30).", "minimum": 1, "maximum": 90}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/list_tickets": {"post": {"operationId": "list_tickets", "summary": "List support tickets", "description": "List support tickets raised from chat, with status, priority and the visitor's details. Needs the Standard plan or higher.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "status": {"type": "string", "description": "Only tickets with this status, for example open or resolved."}, "limit": {"type": "integer", "description": "How many tickets to return (1-100, default 25).", "minimum": 1, "maximum": 100}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/list_active_sessions": {"post": {"operationId": "list_active_sessions", "summary": "List visitors chatting right now", "description": "List the visitors currently in a chat: which page they are on, their country, how long they have been there, and whether a human has taken the conversation over. Needs the Standard plan or higher.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "limit": {"type": "integer", "description": "How many sessions to return (1-100, default 25).", "minimum": 1, "maximum": 100}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/take_over_conversation": {"post": {"operationId": "take_over_conversation", "summary": "Take a conversation over from the AI", "description": "Stop the AI answering one conversation so a human can reply instead. The visitor is told a person has joined. Use send_agent_reply afterwards, and release_conversation when done. Needs the Standard plan or higher.", "x-openai-isConsequential": true, "security": [{"asyntaiOAuth": ["asyntai:write"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"session_id": {"type": "string", "description": "Session id from list_active_sessions."}}, "required": ["session_id"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/release_conversation": {"post": {"operationId": "release_conversation", "summary": "Give a conversation back to the AI", "description": "Hand a taken-over conversation back to the AI, which answers the visitor again from the next message.", "x-openai-isConsequential": true, "security": [{"asyntaiOAuth": ["asyntai:write"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"session_id": {"type": "string", "description": "Session id of the conversation."}}, "required": ["session_id"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/send_agent_reply": {"post": {"operationId": "send_agent_reply", "summary": "Send a message to a visitor", "description": "Send a message, as a human agent, to a real visitor who is chatting right now. Take the conversation over first. The visitor sees this immediately, so show the user the exact wording and get their agreement before calling this.", "x-openai-isConsequential": true, "security": [{"asyntaiOAuth": ["asyntai:write"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"session_id": {"type": "string", "description": "Session id of the conversation."}, "message": {"type": "string", "description": "The text to send to the visitor."}, "agent_name": {"type": "string", "description": "Name shown to the visitor. Defaults to the account's agent name."}}, "required": ["session_id", "message"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/list_products": {"post": {"operationId": "list_products", "summary": "List the product cards", "description": "List the products the chatbot can show as cards, with price and links. Product Cards needs the Standard plan or higher.", "x-openai-isConsequential": false, "security": [{"asyntaiOAuth": ["asyntai:read"]}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"type": "object", "properties": {"website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}}, "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/add_product": {"post": {"operationId": "add_product", "summary": "Add a product card", "description": "Add a product the chatbot can show as a card. Needs the Standard plan or higher.", "x-openai-isConsequential": true, "security": [{"asyntaiOAuth": ["asyntai:write"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"name": {"type": "string", "description": "Product name."}, "description": {"type": "string", "description": "Short description shown on the card."}, "price": {"type": "string", "description": "Price as text, for example 29 EUR."}, "product_link": {"type": "string", "description": "Address of the product page."}, "image_url": {"type": "string", "description": "Address of the product image."}, "website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}}, "required": ["name"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}, "/api/gpt/tools/ask_ai": {"post": {"operationId": "ask_ai", "summary": "Ask the chatbot a question", "description": "Ask one website's chatbot a question and get the answer a real visitor would receive. Use this to test the bot. It spends one message from the account's monthly allowance, and it calls an external model provider.", "x-openai-isConsequential": true, "security": [{"asyntaiOAuth": ["asyntai:write"]}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"message": {"type": "string", "description": "The question to ask, as a visitor would type it."}, "website_id": {"type": "integer", "description": "Numeric id of the website, from list_websites. Omit to use the account's primary website."}, "session_id": {"type": "string", "description": "Reuse the same value across calls to continue one test conversation. Omit to start a fresh one."}}, "required": ["message"], "additionalProperties": false}}}}, "responses": {"200": {"description": "The tool result.", "content": {"application/json": {"schema": {"type": "object", "properties": {}, "additionalProperties": true}}}}, "400": {"description": "The tool refused the request; the body says why."}, "401": {"description": "Sign in again."}}}}}, "components": {"schemas": {}, "securitySchemes": {"asyntaiOAuth": {"type": "oauth2", "flows": {"authorizationCode": {"authorizationUrl": "https://asyntai.com/mcp/oauth/authorize", "tokenUrl": "https://asyntai.com/mcp/oauth/token", "scopes": {"asyntai:read": "Read the account, knowledge and conversations", "asyntai:write": "Change knowledge, instructions and replies"}}}}}}}