API Documentation
API Reference
- POSTKnowledge Base Files
- GETGet Chatbots
- POSTCreate Chatbot
- PATCHUpdate Chatbot
- GETGet Chatbot Details
- DELDelete Chatbot
- PATCHChatbot Avatar
- PATCHVoice Agent
- PATCHChat Widget
- GETGet Knowledge Base List Of Chatbot
- DELDelete Knowledge Base Data
- PATCHUpdate Knowledge Base
- POSTQuery Knowledge
- POSTChat
- GETGet A Conversation
- GETGet Conversations
- GETGet Messages
API Reference
Query Knowledge
Query Knowledge
POST
/
api
/
external
/
chatbot
/
{chatbotId}
/
query-knowledge
Copy
curl --request POST \
--url https://v2.okchat.ai/api/external/chatbot/{chatbotId}/query-knowledge \
--header 'Content-Type: application/json' \
--data '{
"query": "What'\''s okchat ai?"
}'
Copy
{
"results": [
{
"content": "Title: What is OkChat.ai?\nChunk: 1\n\nQuestion: What is OkChat.ai?\n\nAnswer: OkChat.ai is an AI chatbot platform designed to help businesses improve operational efficiency and productivity. It allows you to create and deploy your own AI chatbot based on Large Language Models (LLMs).",
"similarity": 0.718238916187158
},
{
"content": "Title: Quickstart - OKCHAT AI V2 Docs\nChunk: 1\n\nContent:\n[OKCHAT AI V2 Docs home page](https://docs.okchat.ai/)\n\nSearch...\n\nCtrl K\n\nSearch...\n\nNavigation\n\nGet Started\n\nQuickstart\n\n[Documentation](https://docs.okchat.ai/introduction) [API Reference](https://docs.okchat.ai/api-reference/introduction)\n\n## [](https://docs.okchat.ai/quickstart\\#introduction) Introduction\n\nWelcome to OKCHAT.AI, an advanced platform designed to help you create and manage intelligent chatbots. With a wide range of features, including a robust knowledge base, seamless integrations, and comprehensive settings, OKCHAT.AI is your go-to solution for enhancing customer interactions.\n\n## [](https://docs.okchat.ai/quickstart\\#getting-started) Getting Started\n\n1. **Access Your Dashboard**: Log in to your OKCHAT.AI account and navigate to the dashboard to get an overview of your chatbot’s performance.\n\n2. **Create a New Chatbot**: If you haven’t already, start by creating a new chatbot. This can be done by selecting the “Create New” option on your dashboard.\n\n\n## [](https://docs.okchat.ai/quickstart\\#configuring-the-knowledge-base) Configuring the Knowledge Base\n\n1. **Add Essential Knowledge**:\n - Navigate to the “Knowledge Base” section.\n - Upload or input key information that your chatbot should know.\n - Organize content into categories for easier management.\n2. **Training Data**:\n - Use the “Training Data” section to teach your chatbot how to respond to specific queries.\n - Input sample questions and desired answers to improve accuracy.\n\n## [](https://docs.okchat.ai/quickstart\\#setting-up-integrations) Setting Up Integrations\n\nSummary:\nThis section, titled \"Quickstart\" from the OKCHAT AI V2 Docs, provides an introduction to the platform and guides users through the initial steps of creating and configuring a chatbot, including accessing the dashboard, creating a new chatbot, and setting up the knowledge base and integrations.",
"similarity": 0.999831
},
{
"content": "Title: Introduction - OKCHAT AI V2 Docs\nChunk: 1\n\nContent:\n[OKCHAT AI V2 Docs home page](https://docs.okchat.ai/)\n\nSearch...\n\nCtrl K\n\nSearch...\n\nNavigation\n\nGet Started\n\nIntroduction\n\n[Documentation](https://docs.okchat.ai/introduction) [API Reference](https://docs.okchat.ai/api-reference/introduction)\n\n# [](https://docs.okchat.ai/introduction\\#welcome-to-okchat-ai-documentation) Welcome to OKCHAT AI Documentation\n\nWelcome to the OKCHAT AI documentation, your comprehensive guide to mastering the OKCHAT AI platform. Whether you’re a developer, marketer, or support team member, this documentation is designed to help you unlock the full potential of OKCHAT AI, an advanced chatbot platform tailored to meet your needs.\n\n## [](https://docs.okchat.ai/introduction\\#about-okchat-ai) About OKCHAT AI\n\nOKCHAT AI is a powerful platform that enables you to create, customize, and deploy intelligent chatbots across various channels. With features like seamless social media integration, a wide range of plugins, and robust API access, OKCHAT AI offers a flexible solution for enhancing customer interactions and automating support processes.\n\n## [](https://docs.okchat.ai/introduction\\#documentation-structure) Documentation Structure\n\nThis documentation is organized into key sections to guide you through the journey of using OKCHAT AI:\n\n- **Get Started**: Begin here if you’re new to OKCHAT AI. Explore introductions, quickstart guides, and essential tutorials on knowledge bases, social media integration, chatbot widgets, and AI voice agents.\n\n- **Social Media**: Dive into detailed guides on integrating your chatbot with popular platforms like Facebook Messenger, Instagram, WhatsApp, Kakao, Line, and Naver Talk.\n\n- **Plugins**: Discover how to enhance your chatbot’s functionality with plugins for reservations, Discord, and Slack integrations.\n\nSummary:\nThis is the introduction section of the OKCHAT AI V2 Docs, providing an overview of the documentation structure and the OKCHAT AI platform. It introduces the platform's capabilities and guides users through key sections like 'Get Started', 'Social Media', and 'Plugins'.",
"similarity": 1
},
{
"content": "Title: Introduction - OKCHAT AI V2 Docs\nChunk: 1\n\nContent:\n[OKCHAT AI V2 Docs home page](https://docs.okchat.ai/)\n\nSearch...\n\nCtrl K\n\nSearch...\n\nNavigation\n\nGet Started\n\nIntroduction\n\n[Documentation](https://docs.okchat.ai/introduction) [API Reference](https://docs.okchat.ai/api-reference/introduction)\n\n# [](https://docs.okchat.ai/introduction\\#welcome-to-okchat-ai-documentation) Welcome to OKCHAT AI Documentation\n\nWelcome to the OKCHAT AI documentation, your comprehensive guide to mastering the OKCHAT AI platform. Whether you’re a developer, marketer, or support team member, this documentation is designed to help you unlock the full potential of OKCHAT AI, an advanced chatbot platform tailored to meet your needs.\n\n## [](https://docs.okchat.ai/introduction\\#about-okchat-ai) About OKCHAT AI\n\nOKCHAT AI is a powerful platform that enables you to create, customize, and deploy intelligent chatbots across various channels. With features like seamless social media integration, a wide range of plugins, and robust API access, OKCHAT AI offers a flexible solution for enhancing customer interactions and automating support processes.\n\n## [](https://docs.okchat.ai/introduction\\#documentation-structure) Documentation Structure\n\nThis documentation is organized into key sections to guide you through the journey of using OKCHAT AI:\n\n- **Get Started**: Begin here if you’re new to OKCHAT AI. Explore introductions, quickstart guides, and essential tutorials on knowledge bases, social media integration, chatbot widgets, and AI voice agents.\n\n- **Social Media**: Dive into detailed guides on integrating your chatbot with popular platforms like Facebook Messenger, Instagram, WhatsApp, Kakao, Line, and Naver Talk.\n\n- **Plugins**: Discover how to enhance your chatbot’s functionality with plugins for reservations, Discord, and Slack integrations.\n\nSummary:\nThis is the introduction section of the OKCHAT AI V2 Docs, providing an overview of the documentation structure and the OKCHAT AI platform. It introduces the platform's capabilities and guides users through key sections like 'Get Started', 'Social Media', and 'Plugins'.",
"similarity": 1
},
{
"content": "Title: What can OkChat.ai do?\nChunk: 1\n\nQuestion: What can OkChat.ai do?\n\nAnswer: OkChat.ai can automate tasks, provide customer support, streamline processes, and assist employees with information retrieval. It understands natural language and can take actions within integrated systems.",
"similarity": 0.641080556012444
},
{
"content": "Title: Who is OkChat.ai for?\nChunk: 1\n\nQuestion: Who is OkChat.ai for?\n\nAnswer: OkChat.ai primarily targets small and medium-sized enterprises (SMEs) and the public sector that are interested in utilizing AI.",
"similarity": 0.663983384368328
},
{
"content": "Title: What are the key features of OkChat.ai?\nChunk: 1\n\nQuestion: What are the key features of OkChat.ai?\n\nAnswer: Key features include the ability to train chatbots with text input, file uploads, and web crawling. It also offers multilingual customer support.",
"similarity": 0.642547290249264
}
],
"similarity_threshold_setting": 0.45,
"status": "OK",
"total_docs": 7
}
Headers
Example:
"ba1608691d44787a7a6e951024187a82e25e3c3956ebe0b4"
Path Parameters
Example:
"c95f17d4-e0bc-4a69-9aaa-9b7b5e6964bd"
Body
application/json
Response
200 - application/json
Example
The response is of type object
.
Copy
curl --request POST \
--url https://v2.okchat.ai/api/external/chatbot/{chatbotId}/query-knowledge \
--header 'Content-Type: application/json' \
--data '{
"query": "What'\''s okchat ai?"
}'
Copy
{
"results": [
{
"content": "Title: What is OkChat.ai?\nChunk: 1\n\nQuestion: What is OkChat.ai?\n\nAnswer: OkChat.ai is an AI chatbot platform designed to help businesses improve operational efficiency and productivity. It allows you to create and deploy your own AI chatbot based on Large Language Models (LLMs).",
"similarity": 0.718238916187158
},
{
"content": "Title: Quickstart - OKCHAT AI V2 Docs\nChunk: 1\n\nContent:\n[OKCHAT AI V2 Docs home page](https://docs.okchat.ai/)\n\nSearch...\n\nCtrl K\n\nSearch...\n\nNavigation\n\nGet Started\n\nQuickstart\n\n[Documentation](https://docs.okchat.ai/introduction) [API Reference](https://docs.okchat.ai/api-reference/introduction)\n\n## [](https://docs.okchat.ai/quickstart\\#introduction) Introduction\n\nWelcome to OKCHAT.AI, an advanced platform designed to help you create and manage intelligent chatbots. With a wide range of features, including a robust knowledge base, seamless integrations, and comprehensive settings, OKCHAT.AI is your go-to solution for enhancing customer interactions.\n\n## [](https://docs.okchat.ai/quickstart\\#getting-started) Getting Started\n\n1. **Access Your Dashboard**: Log in to your OKCHAT.AI account and navigate to the dashboard to get an overview of your chatbot’s performance.\n\n2. **Create a New Chatbot**: If you haven’t already, start by creating a new chatbot. This can be done by selecting the “Create New” option on your dashboard.\n\n\n## [](https://docs.okchat.ai/quickstart\\#configuring-the-knowledge-base) Configuring the Knowledge Base\n\n1. **Add Essential Knowledge**:\n - Navigate to the “Knowledge Base” section.\n - Upload or input key information that your chatbot should know.\n - Organize content into categories for easier management.\n2. **Training Data**:\n - Use the “Training Data” section to teach your chatbot how to respond to specific queries.\n - Input sample questions and desired answers to improve accuracy.\n\n## [](https://docs.okchat.ai/quickstart\\#setting-up-integrations) Setting Up Integrations\n\nSummary:\nThis section, titled \"Quickstart\" from the OKCHAT AI V2 Docs, provides an introduction to the platform and guides users through the initial steps of creating and configuring a chatbot, including accessing the dashboard, creating a new chatbot, and setting up the knowledge base and integrations.",
"similarity": 0.999831
},
{
"content": "Title: Introduction - OKCHAT AI V2 Docs\nChunk: 1\n\nContent:\n[OKCHAT AI V2 Docs home page](https://docs.okchat.ai/)\n\nSearch...\n\nCtrl K\n\nSearch...\n\nNavigation\n\nGet Started\n\nIntroduction\n\n[Documentation](https://docs.okchat.ai/introduction) [API Reference](https://docs.okchat.ai/api-reference/introduction)\n\n# [](https://docs.okchat.ai/introduction\\#welcome-to-okchat-ai-documentation) Welcome to OKCHAT AI Documentation\n\nWelcome to the OKCHAT AI documentation, your comprehensive guide to mastering the OKCHAT AI platform. Whether you’re a developer, marketer, or support team member, this documentation is designed to help you unlock the full potential of OKCHAT AI, an advanced chatbot platform tailored to meet your needs.\n\n## [](https://docs.okchat.ai/introduction\\#about-okchat-ai) About OKCHAT AI\n\nOKCHAT AI is a powerful platform that enables you to create, customize, and deploy intelligent chatbots across various channels. With features like seamless social media integration, a wide range of plugins, and robust API access, OKCHAT AI offers a flexible solution for enhancing customer interactions and automating support processes.\n\n## [](https://docs.okchat.ai/introduction\\#documentation-structure) Documentation Structure\n\nThis documentation is organized into key sections to guide you through the journey of using OKCHAT AI:\n\n- **Get Started**: Begin here if you’re new to OKCHAT AI. Explore introductions, quickstart guides, and essential tutorials on knowledge bases, social media integration, chatbot widgets, and AI voice agents.\n\n- **Social Media**: Dive into detailed guides on integrating your chatbot with popular platforms like Facebook Messenger, Instagram, WhatsApp, Kakao, Line, and Naver Talk.\n\n- **Plugins**: Discover how to enhance your chatbot’s functionality with plugins for reservations, Discord, and Slack integrations.\n\nSummary:\nThis is the introduction section of the OKCHAT AI V2 Docs, providing an overview of the documentation structure and the OKCHAT AI platform. It introduces the platform's capabilities and guides users through key sections like 'Get Started', 'Social Media', and 'Plugins'.",
"similarity": 1
},
{
"content": "Title: Introduction - OKCHAT AI V2 Docs\nChunk: 1\n\nContent:\n[OKCHAT AI V2 Docs home page](https://docs.okchat.ai/)\n\nSearch...\n\nCtrl K\n\nSearch...\n\nNavigation\n\nGet Started\n\nIntroduction\n\n[Documentation](https://docs.okchat.ai/introduction) [API Reference](https://docs.okchat.ai/api-reference/introduction)\n\n# [](https://docs.okchat.ai/introduction\\#welcome-to-okchat-ai-documentation) Welcome to OKCHAT AI Documentation\n\nWelcome to the OKCHAT AI documentation, your comprehensive guide to mastering the OKCHAT AI platform. Whether you’re a developer, marketer, or support team member, this documentation is designed to help you unlock the full potential of OKCHAT AI, an advanced chatbot platform tailored to meet your needs.\n\n## [](https://docs.okchat.ai/introduction\\#about-okchat-ai) About OKCHAT AI\n\nOKCHAT AI is a powerful platform that enables you to create, customize, and deploy intelligent chatbots across various channels. With features like seamless social media integration, a wide range of plugins, and robust API access, OKCHAT AI offers a flexible solution for enhancing customer interactions and automating support processes.\n\n## [](https://docs.okchat.ai/introduction\\#documentation-structure) Documentation Structure\n\nThis documentation is organized into key sections to guide you through the journey of using OKCHAT AI:\n\n- **Get Started**: Begin here if you’re new to OKCHAT AI. Explore introductions, quickstart guides, and essential tutorials on knowledge bases, social media integration, chatbot widgets, and AI voice agents.\n\n- **Social Media**: Dive into detailed guides on integrating your chatbot with popular platforms like Facebook Messenger, Instagram, WhatsApp, Kakao, Line, and Naver Talk.\n\n- **Plugins**: Discover how to enhance your chatbot’s functionality with plugins for reservations, Discord, and Slack integrations.\n\nSummary:\nThis is the introduction section of the OKCHAT AI V2 Docs, providing an overview of the documentation structure and the OKCHAT AI platform. It introduces the platform's capabilities and guides users through key sections like 'Get Started', 'Social Media', and 'Plugins'.",
"similarity": 1
},
{
"content": "Title: What can OkChat.ai do?\nChunk: 1\n\nQuestion: What can OkChat.ai do?\n\nAnswer: OkChat.ai can automate tasks, provide customer support, streamline processes, and assist employees with information retrieval. It understands natural language and can take actions within integrated systems.",
"similarity": 0.641080556012444
},
{
"content": "Title: Who is OkChat.ai for?\nChunk: 1\n\nQuestion: Who is OkChat.ai for?\n\nAnswer: OkChat.ai primarily targets small and medium-sized enterprises (SMEs) and the public sector that are interested in utilizing AI.",
"similarity": 0.663983384368328
},
{
"content": "Title: What are the key features of OkChat.ai?\nChunk: 1\n\nQuestion: What are the key features of OkChat.ai?\n\nAnswer: Key features include the ability to train chatbots with text input, file uploads, and web crawling. It also offers multilingual customer support.",
"similarity": 0.642547290249264
}
],
"similarity_threshold_setting": 0.45,
"status": "OK",
"total_docs": 7
}
Assistant
Responses are generated using AI and may contain mistakes.