Overview

Document Overview

Documentation of API endpoints of MaiAgent

API Categories and Endpoint List

AI Assistant

• POST api/chatbots: Create a new AI assistant

• GET api/chatbot-settings: List available settings for AI assistants

• GET api/embedding-models: List Embedding Models

• GET api/reranker-models: List Reranker Models

• GET api/chatbots: Get a list of AI assistants

• GET api/chatbots/{id}: Get a specific AI assistant

• PUT api/chatbots/{id}: Update an AI assistant

• PATCH api/chatbots/{id}: Partially update an AI assistant

• DELETE api/chatbots/{id}: Delete an AI assistant

Attachments and Files

• POST api/attachments-upload: Create a new attachment (integrated)

• POST api/upload-presigned-url: Get a presigned URL for file upload (create/get)

• POST api/attachments: Upload attachment via Presigned URL

• POST api/conversations/{conversationPk}/attachments: Create a conversation attachment

Knowledge Base (New)

• POST api/knowledge-bases: Create a knowledge base

• GET api/knowledge-bases: List all knowledge bases

• GET api/knowledge-bases/{id}: Get details of a specific knowledge base

• GET api/knowledge-bases/{id}/search: Search the content of a specific knowledge base

• PUT api/knowledge-bases/{id}: Update a knowledge base

• PATCH api/knowledge-bases/{id}: Partially update a knowledge base

• DELETE api/knowledge-bases/{id}: Delete a knowledge base

• POST api/knowledge-bases/{knowledgeBasePk}/labels: Create a new label

• GET api/knowledge-bases/{knowledgeBasePk}/labels: List labels in a knowledge base

• GET api/knowledge-bases/{knowledgeBasePk}/labels/{id}: Get details of a specific label

• PUT api/knowledge-bases/{knowledgeBasePk}/labels/{id}: Update a label

• PATCH api/knowledge-bases/{knowledgeBasePk}/labels/{id}: Partially update a label

• DELETE api/knowledge-bases/{knowledgeBasePk}/labels/{id}: Delete a label

• POST api/knowledge-bases/{knowledgeBasePk}/files: Upload a file to the knowledge base

• POST api/knowledge-bases/{knowledgeBasePk}/files/{id}/update-metadata: Update file metadata

• POST api/knowledge-bases/{knowledgeBasePk}/files/batch-delete: Batch delete files

• GET api/knowledge-bases/{knowledgeBasePk}/files: List files in the knowledge base

• GET api/knowledge-bases/{knowledgeBasePk}/files/{id}: Get details of a specific file

• GET api/knowledge-bases/{knowledgeBasePk}/text-nodes: List text nodes of a specific file in the knowledge base

• GET api/knowledge-bases/{knowledgeBasePk}/text-nodes/{id}: Get details of a specific text node

• PUT api/knowledge-bases/{knowledgeBasePk}/files/{id}: Update file information

• PATCH api/knowledge-bases/{knowledgeBasePk}/files/{id}: Partially update a file

• DELETE api/knowledge-bases/{knowledgeBasePk}/files/{id}: Delete a file

• POST api/knowledge-bases/{knowledgeBasePk}/faqs: Create a new FAQ

• POST api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/update-metadata: Update FAQ metadata

• POST api/knowledge-bases/{knowledgeBasePk}/faqs/batch-delete: Batch delete FAQs

• GET api/knowledge-bases/{knowledgeBasePk}/faqs: List all FAQs for a specific knowledge base

• GET api/knowledge-bases/{knowledgeBasePk}/faqs/{id}: Get details of a specific FAQ

• PUT api/knowledge-bases/{knowledgeBasePk}/faqs/{id}: Update an FAQ

• PATCH api/knowledge-bases/{knowledgeBasePk}/faqs/{id}: Partially update an FAQ

• DELETE api/knowledge-bases/{knowledgeBasePk}/faqs/{id}: Delete an FAQ

Knowledge Base (Legacy)

• POST api/chatbots/{chatbotPk}/files: Upload a new knowledge base file

• GET api/chatbots/{chatbotPk}/files: Get a list of knowledge base files

• GET api/chatbots/{chatbotPk}/files/{id}: Get a specific knowledge base file

• PUT api/chatbots/{chatbotPk}/files/{id}: Update a knowledge base file

• DELETE api/chatbots/{chatbotPk}/files/{id}: Delete a knowledge base file

• POST api/chatbots/{chatbotPk}/files/batch-delete: Batch delete knowledge base files

• POST api/chatbots/{chatbotPk}/faqs: Create a new FAQ

• GET api/chatbots/{chatbotPk}/faqs: Get a list of FAQs

• GET api/chatbots/{chatbotPk}/faqs/{id}: Get a specific FAQ

• PUT api/chatbots/{chatbotPk}/faqs/{id}: Update an FAQ

• DELETE api/chatbots/{chatbotPk}/faqs/{id}: Delete an FAQ

• POST api/chatbots/{chatbotPk}/faqs/batch-delete: Batch delete FAQs

• GET api/chatbot-text-nodes: Get text nodes for all files of an AI assistant

• GET api/chatbot-text-nodes/{id}: Get text nodes for a specific file of an AI assistant

• POST api/chatbots/{id}/search: Search test

• GET api/parsers/supported-file-types: List supported parsers for file types

Conversations and Messages

• POST api/chatbots/{chatbotId}/completions: Send a message (stream)

• POST api/messages: Send a message (create)

• POST api/conversations: Create a new conversation

• GET api/messages: Get a list of messages

• GET api/messages/{id}: Get a specific message

• GET api/conversations: Get a list of conversations

• GET api/conversations/{id}: Get a specific conversation

• GET api/chatbots/{chatbotPk}/records: Get AI assistant conversation records

• GET api/chatbots/{chatbotPk}/records/export-excel: Export conversation records as an Excel file

Conversation Widget

• GET api/web-chats/{id}: Get a specific Web Chat

• GET api/chatbots/{chatbotPk}/llm-usage-statistics: Get LLM usage statistics

• GET api/chatbots/{chatbotPk}/statistics: Get AI assistant statistics

• PATCH api/chatbots/{chatbot_id}/enable-evaluation: Enable or disable the evaluation feature for a specific AI assistant

Organizations and Members

• POST api/auth/registration: Account registration

• POST api/auth/password/change: Change password

• POST api/organizations: Create a new organization

• POST api/organizations/{organizationPk}/members: Add a member to a specified organization

• GET api/organizations: Get a list of organizations

• GET api/organizations/{id}: Get information for a specific organization

• GET api/users/current: Get current user details

• GET api/permissions: Get current user permissions

• GET api/organizations/{organizationPk}/members: Get the member list of a specified organization

• GET api/organizations/{organizationPk}/members/{id}: Get details of a specific member

• PUT api/organizations/{id}: Update organization information

• PUT api/users/current: Update current user details

• PUT api/organizations/{organizationPk}/members/{id}: Update member information in a specified organization

• DELETE api/organizations/{id}: Delete an organization

• DELETE api/organizations/{organizationPk}/members/{id}: Delete a specified member

Roles and Permissions

• POST api/organizations/{organizationPk}/groups: Create a role

• POST api/organizations/{organizationPk}/groups/{groupPk}/group-members/bulk-create: Bulk add role members

• POST api/organizations/{organizationPk}/groups/{groupPk}/group-chatbots/bulk-create: Bulk assign AI assistants to a role

• GET api/permissions: List permissions

• GET api/organizations/{organizationPk}/groups: Get a list of roles

• GET api/organizations/{organizationPk}/groups/{id}: Get details of a role

• GET api/organizations/{organizationPk}/groups/{groupPk}/group-members: Get a list of role members

• GET api/organizations/{organizationPk}/groups/{groupPk}/group-members/{id}: View a specific role member

• GET api/organizations/{organizationPk}/groups/{groupPk}/group-chatbots: Get the list of AI assistants for a role

• PUT api/organizations/{organizationPk}/groups/{id}: Update role permissions

• PATCH api/organizations/{organizationPk}/groups/{id}: Partially update role permissions

• DELETE api/organizations/{organizationPk}/groups/{id}: Delete a role

• DELETE api/organizations/{organizationPk}/groups/{groupPk}/group-members/{id}: Remove a role member

• DELETE api/organizations/{organizationPk}/groups/{groupPk}/group-chatbots/{id}: Remove an AI assistant from a role

Contacts

• GET api/contacts: List contacts

• POST api/contacts: Create a contact

• GET api/contacts/{id}: Get contact details

• PUT api/contacts/{id}: Update a contact

• PATCH api/contacts/{id}: Update a contact

• DELETE api/contacts/{id}: Delete a contact

Authentication Requirements

All API requests must include an API Key in the HTTP Header, in the following format:

Authorization: Api-Key YOUR_API_KEY

Usage Instructions

• Please read the detailed documentation for each endpoint carefully

• Detailed request and response formats can be found on each category page

• All example code is provided in multiple programming languages

Status Code Descriptions

Status Code	Description
200	Request successful
201	Resource created successfully
400	Bad request format
401	Authentication failed
403	Insufficient permissions
404	Resource not found
500	Server error