> For the complete documentation index, see [llms.txt](https://docs.maiagent.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.maiagent.ai/api/en/preparation/readme.md).

# Overview

This document lists the MaiAgent platform's API endpoints for integration. Each endpoint includes descriptions of request and response fields, along with examples in Shell, JavaScript, Python, and PHP. For your first integration, complete the four steps below, then find the endpoint you need in the [endpoint list](#api-reference).

## Getting Started <a href="#getting-started" id="getting-started"></a>

### 1. Get an API Key <a href="#step-api-key" id="step-api-key"></a>

Organization members can create their own keys in the admin console by selecting the avatar in the upper-right corner → <mark style="color:blue;">Account</mark> → <mark style="color:blue;">API Keys</mark>. Administrators with “API Key management permissions” can also issue keys for specific members under <mark style="color:blue;">Organization Settings</mark> → <mark style="color:blue;">API Key Management</mark>. The full key is displayed only once, when it is created. See [API Authentication](/api/en/preparation/authentication.md) for how to obtain the two types of keys and their permission scopes.

### 2. Base URL and Authentication Header <a href="#step-base-url" id="step-base-url"></a>

The SaaS API URL is `https://api.maiagent.ai/api/v1/`. For on-premises and private cloud deployments, replace it with your company's platform domain. Endpoint paths end with `/`. Include the key in the `Authorization` header of every request, using the `Api-Key` prefix (not `Bearer`):

```
Authorization: Api-Key <Your API key>
```

See [URLs and Version Prefixes](/api/en/preparation/conventions.md#base-url) for URL rules, and [Common Conventions: Authentication](/api/en/preparation/conventions.md#authentication) for how keys are tied to members and permissions.

### 3. Make Your First Call <a href="#step-first-call" id="step-first-call"></a>

For example, [list Agents](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-list) (`GET /api/v1/chatbots/`):

```bash
curl https://api.maiagent.ai/api/v1/chatbots/ \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

The response is paginated (`count`, `next`, `previous`, `results`), and all field names use camelCase. See [Pagination](/api/en/preparation/conventions.md#pagination) and [Field Format](/api/en/preparation/conventions.md#field-format). If you receive `401`, check the key's status and the header format. See [Status Codes](/api/en/preparation/status-code.md) for the meaning of each status code.

### 4. Next Steps <a href="#step-next" id="step-next"></a>

* Rules shared across endpoints, such as rate limits, error response formats, and upload size limits: [Common API Conventions](/api/en/preparation/conventions.md)
* Response status codes and error examples: [Status Codes](/api/en/preparation/status-code.md)
* Receive events after a handoff to a human agent: [Human Handoff Webhook Events](/api/en/preparation/handoff-webhook.md)
* The complete flow from creating a conversation to receiving a reply: [Quick Start](https://docs.maiagent.ai/tech/api-integration/quickstart) in the technical manual
* Fields and examples for each endpoint: the [endpoint list](#api-reference) below, or the category pages under “API Endpoint Documentation” in the left sidebar

## Integration Code Examples <a href="#examples" id="examples"></a>

For complete API use cases and code examples, visit the following GitHub repository:

* C# examples
* Python examples

{% embed url="<https://github.com/Playma-Co-Ltd/maiagent-api-examples>" %}

## API Categories and Endpoint List <a href="#api-reference" id="api-reference"></a>

The category pages provide request and response fields and examples in each language for every endpoint. Refer to [Status Codes](/api/en/preparation/status-code.md) for the meaning of response status codes.

### AI Assistants

* `POST` [api/v1/chatbots](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-create): Create a new AI assistant
* `GET` [api/v1/embedding-models](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#embedding-models-list): List Embedding Models
* `GET` [api/v1/reranker-models](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#reranker-models-list): List Reranker Models
* `GET` [api/v1/large-language-models](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#large-language-models-list): List large language models
* `GET` [api/v1/chatbots](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-list): Get the AI assistant list
* `GET` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-retrieve): Get a specific AI assistant
* `PUT` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-update): Update an AI assistant
* `PATCH` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-partial-update): Partially update an AI assistant
* `DELETE` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-destroy): Delete an AI assistant
* `POST` [api/v1/chatbots/{id}/duplicate](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-duplicate-create): Duplicate an AI assistant
* `PATCH` [api/v1/chatbots/{id}/enable-evaluation](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-enable-evaluation-partial-update): Enable or disable evaluation
* `GET` [api/v1/hooks](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#hooks-list): List the organization's Hooks
* `POST` [api/v1/hooks](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#hooks-create): Create a Hook from a template
* `GET` [api/v1/hooks/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#hooks-retrieve): Get a specific Hook
* `PATCH` [api/v1/hooks/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#hooks-partial-update): Partially update a Hook
* `DELETE` [api/v1/hooks/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#hooks-destroy): Delete a Hook
* `GET` [api/v1/chatbots/{chatbotId}/hooks](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-hooks-retrieve): List Hooks attached to an AI assistant
* `PUT` [api/v1/chatbots/{chatbotId}/hooks](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-hooks-update): Replace all Hooks attached to an AI assistant
* `GET` [api/v1/schedules](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-list): List schedules
* `POST` [api/v1/schedules](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-create): Create a schedule
* `GET` [api/v1/schedules/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-retrieve): Get a specific schedule
* `PATCH` [api/v1/schedules/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-partial-update): Partially update a schedule
* `DELETE` [api/v1/schedules/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-destroy): Delete a schedule
* `POST` [api/v1/schedules/{id}/run-now](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-run-now-create): Run a schedule now
* `POST` [api/v1/schedules/{id}/toggle](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-toggle-create): Enable or disable a schedule

### Attachments and Files

* `POST` [api/v1/attachments-upload](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#attachments-upload-create): Create a new attachment (integrated)
* `POST` [api/v1/upload-presigned-url](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#upload-presigned-url-create): Get a presigned URL for file uploads
* `POST` [api/v1/attachments](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#attachments-create): Upload an attachment using a presigned URL
* `GET` [api/v1/attachments/{id}](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#attachments-retrieve): Get a specific attachment
* `POST` [api/v1/conversations/{conversationPk}/attachments](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#conversations-attachments-create): Create a conversation attachment
* `GET` [api/v1/allowed-file-specs](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#allowed-file-specs-retrieve): Get allowed file specifications
* `GET` [api/v1/file-library/conversation-attachments](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#file-library-conversation-attachments-list): List conversation attachments
* `DELETE` [api/v1/file-library/conversation-attachments/{id}](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#file-library-conversation-attachments-destroy): Delete a conversation attachment

### Knowledge Bases (New Version)

* `POST` [api/v1/knowledge-bases](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-create): Create a knowledge base
* `GET` [api/v1/knowledge-bases](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-list): List all knowledge bases
* `GET` [api/v1/knowledge-bases/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-retrieve): Get details of a specific knowledge base
* `POST` [api/v1/knowledge-bases/{id}/search](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-search-create): Search the contents of a specific knowledge base
* `PUT` [api/v1/knowledge-bases/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-update): Update a knowledge base
* `PATCH` [api/v1/knowledge-bases/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-partial-update): Partially update a knowledge base
* `DELETE` [api/v1/knowledge-bases/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-destroy): Delete a knowledge base
* `GET` [api/v1/knowledge-bases/{id}/check-rrf-availability](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-check-rrf-availability-retrieve): Check RRF availability
* `GET` [api/v1/knowledge-bases/{id}/export-labels-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-export-labels-excel-retrieve): Export labels to Excel
* `POST` [api/v1/knowledge-bases/{id}/import-labels-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-import-labels-excel-create): Import labels from Excel
* `GET` [api/v1/knowledge-bases/{id}/export-metadata-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-export-metadata-excel-retrieve): Export metadata to Excel
* `POST` [api/v1/knowledge-bases/{id}/import-metadata-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-import-metadata-excel-create): Import metadata from Excel
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/labels](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-create): Create a new label
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/labels](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-list): List labels in a knowledge base
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-retrieve): Get details of a specific label
* `PUT` [api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-update): Update a label
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-partial-update): Partially update a label
* `DELETE` [api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-destroy): Delete a label
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-metadata-keys-create): Create a metadata field
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-metadata-keys-list): List metadata fields
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-metadata-keys-retrieve): Get a specific metadata field
* `PUT` [api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-metadata-keys-update): Update a metadata field
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/files](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-create): Upload a file to a knowledge base
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/update-metadata](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-update-metadata-partial-update): Update file metadata
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/files/batch-delete](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-batch-delete-create): Delete files in bulk
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/files/batch-reparse](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-batch-reparse-partial-update): Reparse files in bulk
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-list): List files in a knowledge base
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-retrieve): Get details of a specific file
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/latest-failed-reason](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-latest-failed-reason-retrieve): Get the latest reason for a file failure
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/transcription](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-transcription-retrieve): Get a file's transcription
* `PUT` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-update): Update file information
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-partial-update): Partially update a file
* `DELETE` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-destroy): Delete a file
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-translations-create): Create a file translation
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-translations-list): List file translations
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-translations-retrieve): Get a specific translation
* `DELETE` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-translations-destroy): Delete a translation
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/download](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-translations-download-retrieve): Download a translated file
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/documents](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-documents-list): List knowledge base documents
* `PUT` [api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-documents-update): Update a document
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-documents-partial-update): Partially update a document
* `DELETE` [api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-documents-destroy): Delete a document
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-create): Create a new FAQ
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/update-metadata](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-update-metadata-partial-update): Update FAQ metadata
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/batch-delete](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-batch-delete-create): Delete FAQs in bulk
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-list): List all FAQs in a specific knowledge base
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-retrieve): Get details of a specific FAQ
* `PUT` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-update): Update an FAQ
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-partial-update): Partially update an FAQ
* `DELETE` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-destroy): Delete an FAQ
* `GET` [api/v1/knowledge-bases/{id}/export-faq-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-export-faq-excel-retrieve): Export FAQs to Excel (or a blank template)
* `POST` [api/v1/knowledge-bases/{id}/import-faq-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-import-faq-excel-create): Import FAQs from Excel (asynchronously)
* `GET` [api/v1/knowledge-bases/{id}/faq-import-jobs](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faq-import-jobs-list): List FAQ import jobs
* `GET` [api/v1/knowledge-bases/{id}/faq-import-jobs/{jobId}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faq-import-jobs-retrieve): Get a specific FAQ import job
* `GET` [api/v1/parsers](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#parsers-list): List parsers
* `GET` [api/v1/parsers/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#parsers-retrieve): Get a specific parser

### Knowledge Bases (Legacy Version)

* `GET` [api/v1/chatbots/{id}/knowledge-bases-files](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#chatbots-knowledge-bases-files-list): Get the list of an AI assistant's knowledge base files
* `GET` [api/v1/chatbots/{id}/knowledge-bases-faqs](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#chatbots-knowledge-bases-faqs-list): Get the list of an AI assistant's knowledge base FAQs
* `GET` [api/v1/chatbot-text-nodes](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#chatbot-text-nodes-list): Get text nodes from all files of an AI assistant
* `GET` [api/v1/chatbot-text-nodes/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#chatbot-text-nodes-retrieve): Get text nodes from a specific file of an AI assistant
* `POST` [api/v1/chatbots/{id}/search](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#chatbots-search-create): Test search
* `GET` [api/v1/parsers/supported-file-types](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#parsers-supported-file-types-list): List parsers that support each file type

### Conversations and Messages

* `POST` [api/v1/chatbots/{chatbotId}/completions](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#chatbots-completions-create): Send a message (streaming)
* `POST` [api/v1/messages](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-create): Send a message (create)
* `POST` [api/v1/messages/outgoing](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-outgoing-create): Send a proactive message
* `POST` [api/v1/conversations](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-create): Create a new conversation
* `GET` [api/v1/messages](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-list): Get the message list
* `GET` [api/v1/messages/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-retrieve): Get a specific message
* `GET` [api/v1/conversations](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-list): Get the conversation list
* `GET` [api/v1/conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-retrieve): Get a specific conversation
* `PATCH` [api/v1/conversations/{id}/rename](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-rename-partial-update): Rename a conversation
* `DELETE` [api/v1/conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-destroy): Delete a conversation
* `POST` [api/v1/conversations/{id}/stop-response](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-stop-response-create): Stop an AI response
* `POST` [api/v1/conversations/{id}/satisfaction](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-satisfaction-create): Submit conversation satisfaction
* `GET` [api/v1/conversations/{id}/events](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-events-retrieve): List conversation events
* `PATCH` [api/v1/conversations/{id}/assign](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-assign-partial-update): Assign a conversation to a member
* `PATCH` [api/v1/conversations/{id}/claim](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-claim-partial-update): Claim a conversation
* `PATCH` [api/v1/conversations/{id}/transfer](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-transfer-partial-update): Transfer a conversation to another member
* `PATCH` [api/v1/conversations/{id}/return-to-ai](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-return-to-ai-partial-update): Return to AI responses
* `GET` [api/v1/conversations/{conversationId}/outputs](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-outputs-retrieve): List conversation output files
* `POST` [api/v1/conversations/{conversationPk}/share](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-share-create): Share a conversation
* `POST` [api/v1/conversations/{conversationPk}/share/quick](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-share-quick-create): Quickly share a conversation
* `GET` [api/v1/shared-conversations](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-list): List shared conversations
* `GET` [api/v1/shared-conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-retrieve): Get a specific shared conversation
* `PATCH` [api/v1/shared-conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-partial-update): Update a shared conversation
* `DELETE` [api/v1/shared-conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-destroy): Delete a shared conversation
* `POST` [api/v1/shared-conversations/{id}/fork](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-fork-create): Duplicate a shared conversation
* `GET` [api/v1/shared-conversations/my-shares](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-my-shares-retrieve): Get my share list
* `POST` [api/v1/messages/{messagePk}/feedback](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-feedback-create): Create message feedback
* `PUT` [api/v1/messages/{messagePk}/feedback/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-feedback-update): Update message feedback
* `DELETE` [api/v1/messages/{messagePk}/feedback/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-feedback-destroy): Delete message feedback
* `GET` [api/v1/records](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#records-list): Get the conversation record list
* `GET` [api/v1/records/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#records-retrieve): Get a specific conversation record
* `POST` [api/v1/records/export-excel-requests](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#records-export-excel-requests-create): Create a conversation record export request
* `GET` [api/v1/records/export-excel-requests/{exportId}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#records-export-excel-requests-retrieve2): Get the conversation record export status

### Chat Widget

* `POST` [api/v1/web-chats](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-create): Create a Web Chat
* `GET` [api/v1/web-chats](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-list): List Web Chats
* `GET` [api/v1/web-chats/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-retrieve): Get a specific Web Chat
* `PUT` [api/v1/web-chats/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-update): Update a Web Chat
* `PATCH` [api/v1/web-chats/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-partial-update): Partially update a Web Chat
* `POST` [api/v1/web-chats/{id}/setup-contact-credentials](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-setup-contact-credentials-create): Set up contact credentials
* `POST` [api/v1/web-chats/{id}/voice-agent/token](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-voice-agent-token-create): Get a voice assistant token
* `POST` [api/v1/web-chats/{webchatPk}/batch-qas](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-batch-qas-create): Upload a batch QA file
* `GET` [api/v1/web-chats/{webchatPk}/batch-qas/{id}/export-excel](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-batch-qas-export-excel-retrieve): Export batch QA as Excel
* `GET` [api/v1/chatbots/{chatbotPk}/llm-usage-statistics](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#chatbots-llm-usage-statistics-list): Get LLM usage statistics
* `GET` [api/v1/chatbots/{chatbotPk}/statistics](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#chatbots-statistics-list): Get AI assistant statistics

### Chat Platforms

* `GET` [api/v1/inboxes](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-list): List chat platforms
* `POST` [api/v1/inboxes](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-create): Create a chat platform
* `GET` [api/v1/inboxes/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-retrieve): Get a specific chat platform
* `PUT` [api/v1/inboxes/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-update): Update a chat platform
* `PATCH` [api/v1/inboxes/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-partial-update): Partially update a chat platform
* `DELETE` [api/v1/inboxes/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-destroy): Delete a chat platform
* `GET` [api/v1/inboxes/{inboxPk}/webhooks](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-list): List Webhooks of a chat platform
* `POST` [api/v1/inboxes/{inboxPk}/webhooks](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-create): Create a Webhook
* `GET` [api/v1/inboxes/{inboxPk}/webhooks/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-retrieve): Get a specific Webhook
* `PUT` [api/v1/inboxes/{inboxPk}/webhooks/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-update): Update a Webhook
* `PATCH` [api/v1/inboxes/{inboxPk}/webhooks/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-partial-update): Partially update a Webhook
* `DELETE` [api/v1/inboxes/{inboxPk}/webhooks/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-destroy): Delete a Webhook

### Organizations and Members

* `POST` [api/v1/auth/registration](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#auth-registration-create): Register an account
* `POST` [api/v1/auth/password/change](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#auth-password-change-create): Change password
* `POST` [api/v1/organizations](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-create): Create a new organization
* `POST` [api/v1/organizations/{organizationPk}/members](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-create): Add a member to a specific organization
* `GET` [api/v1/organizations](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-list): Get the organization list
* `GET` [api/v1/organizations/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-retrieve): Get specific organization information
* `GET` [api/v1/users/current](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#users-current-retrieve): Get current user details
* `GET` [api/v1/permissions](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#permissions-list): Get current user permissions
* `GET` [api/v1/organizations/{organizationPk}/members](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-list): Get the member list of a specific organization
* `GET` [api/v1/organizations/{organizationPk}/members/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-retrieve): Get specific member details
* `PUT` [api/v1/organizations/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-update): Update organization information
* `PUT` [api/v1/users/current](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#users-current-update): Update current user details
* `POST` [api/v1/organizations/{organizationPk}/members/{id}/update-groups](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-update-groups-create): Update a member's roles
* `GET` [api/v1/organizations/{organizationPk}/api-keys](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-api-keys-list): List organization API Keys
* `POST` [api/v1/organizations/{organizationPk}/api-keys](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-api-keys-create): Issue an API Key for a member
* `GET` [api/v1/organizations/{organizationPk}/api-keys/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-api-keys-retrieve): Get a specific API Key
* `PATCH` [api/v1/organizations/{organizationPk}/api-keys/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-api-keys-partial-update): Update API Key settings
* `DELETE` [api/v1/organizations/{organizationPk}/api-keys/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-api-keys-destroy): Revoke an API Key
* `GET` [api/v1/users/api-key-context](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#users-api-key-context-retrieve): Look up the organization an API Key belongs to
* `POST` [api/v1/members/embed-tokens](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#members-embed-tokens-create): Reissue a member embed token
* `GET` [api/v1/oauth/applications](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-list): List OAuth applications
* `POST` [api/v1/oauth/applications](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-create): Register an OAuth application
* `GET` [api/v1/oauth/applications/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-retrieve): Get a specific OAuth application
* `PATCH` [api/v1/oauth/applications/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-partial-update): Update an OAuth application
* `DELETE` [api/v1/oauth/applications/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-destroy): Delete an OAuth application and revoke its tokens
* `POST` [api/v1/oauth/applications/{id}/regenerate-secret](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-regenerate-secret-create): Regenerate the client secret
* `GET` [api/v1/oauth/authorized-applications](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-authorized-applications-list): List OAuth applications I have authorized
* `DELETE` [api/v1/oauth/authorized-applications/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-authorized-applications-destroy): Revoke my authorization for an application
* `DELETE` [api/v1/organizations/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-destroy): Delete an organization
* `DELETE` [api/v1/organizations/{organizationPk}/members/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-destroy): Delete a specific member
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/members](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-usage-statistics-members-list): Get member usage statistics
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/members/summary](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-usage-statistics-members-summary-retrieve): Get the member usage statistics summary
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/chatbots](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-usage-statistics-chatbots-list): Get AI assistant usage statistics
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/chatbots/summary](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-usage-statistics-chatbots-summary-retrieve): Get the AI assistant usage statistics summary
* `GET` [api/v1/me/memories](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#me-memories-list): List my memories
* `POST` [api/v1/me/memories](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#me-memories-create): Create or update my memory
* `PATCH` [api/v1/me/memories/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#me-memories-partial-update): Modify or re-enable my memory
* `DELETE` [api/v1/me/memories/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#me-memories-destroy): Delete my memory

### Roles and Permissions

* `POST` [api/v1/organizations/{organizationPk}/groups](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-create): Create a role
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-members/bulk-create](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-members-bulk-create-create): Bulk add role members
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-chatbots/bulk-create](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-chatbots-bulk-create-create): Bulk assign AI assistants to a role
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-inboxes/bulk-create](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-inboxes-bulk-create-create): Bulk assign inboxes to a role
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-knowledge-bases/bulk-create](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-knowledge-bases-bulk-create-create): Bulk assign knowledge bases to a role
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-databases/bulk-create](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-databases-bulk-create-create): Bulk assign databases to a role
* `GET` [api/v1/permissions](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#permissions-list): List permissions
* `GET` [api/v1/organizations/{organizationPk}/groups](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-list): Get the role list
* `GET` [api/v1/organizations/{organizationPk}/groups/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-retrieve): Get role details
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-members](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-members-list): Get the role member list
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-members/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-members-retrieve): View a specific role member
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-chatbots](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-chatbots-list): Get the AI assistant list of a role
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-inboxes](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-inboxes-list): Get the inbox list of a role
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-knowledge-bases](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-knowledge-bases-list): Get the knowledge base list of a role
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-databases](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-databases-list): Get the database list of a role
* `PUT` [api/v1/organizations/{organizationPk}/groups/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-update): Update role permissions
* `PATCH` [api/v1/organizations/{organizationPk}/groups/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-partial-update): Partially update role permissions
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-destroy): Delete a role
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-members/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-members-destroy): Remove a role member
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-chatbots/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-chatbots-destroy): Remove an AI assistant from a role
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-inboxes/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-inboxes-destroy): Remove an inbox from a role
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-knowledge-bases/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-knowledge-bases-destroy): Remove a knowledge base from a role
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-databases/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-databases-destroy): Remove a database from a role

### Contacts

* `GET` [api/v1/contacts](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-list): List contacts
* `POST` [api/v1/contacts](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-create): Create a contact
* `GET` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-retrieve): Get contact details
* `PUT` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-update): Update a contact
* `PATCH` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-partial-update): Partially update a contact
* `DELETE` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-destroy): Delete a contact
* `GET` [api/v1/contacts/{id}/conversations](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-conversations-list): Get a contact's conversation list
* `GET` [api/v1/contacts/{id}/conversations/latest](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-conversations-latest-retrieve): Get a contact's latest conversation
* `POST` [api/v1/contacts/broadcast-message](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-broadcast-message-create): Broadcast a message
* `POST` [api/v1/contacts/{id}/api-credentials](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-api-credentials-create): Create an API credential for a contact
* `PATCH` [api/v1/contacts/{id}/api-credentials/{credentialId}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-api-credentials-partial-update): Update a contact's API credential
* `DELETE` [api/v1/contacts/{id}/api-credentials/{credentialId}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-api-credentials-destroy): Delete a contact's API credential
* `POST` [api/v1/contacts/{id}/mcp-credentials](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-mcp-credentials-create): Create an MCP credential for a contact
* `PATCH` [api/v1/contacts/{id}/mcp-credentials/{credentialId}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-mcp-credentials-partial-update): Update a contact's MCP credential
* `DELETE` [api/v1/contacts/{id}/mcp-credentials/{credentialId}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-mcp-credentials-destroy): Delete a contact's MCP credential
* `GET` [api/v1/contacts/bulk-import-template](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-bulk-import-template-retrieve): Download the contact bulk import template
* `POST` [api/v1/contacts/bulk-import](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-bulk-import-create): Bulk import contacts

### Tools and Connectors

* `POST` [api/v1/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-create): Create a tool
* `GET` [api/v1/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-list): List tools
* `GET` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-retrieve): Get a specific tool
* `PUT` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-update): Update a tool
* `PATCH` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-partial-update): Partially update a tool
* `DELETE` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-destroy): Delete a tool
* `GET` [api/v1/tools/available-tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-available-tools-retrieve): List available tools
* `POST` [api/v1/connectors](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-create): Create a connector
* `GET` [api/v1/connectors](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-list): List connectors
* `GET` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-retrieve): Get a specific connector
* `PUT` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-update): Update a connector
* `PATCH` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-partial-update): Partially update a connector
* `DELETE` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-destroy): Delete a connector
* `GET` [api/v1/connectors/{id}/authorized-members](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-authorized-members-retrieve): List connector authorized members
* `DELETE` [api/v1/connectors/{id}/authorized-members/{memberId}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-authorized-members-destroy): Remove a connector authorized member
* `GET` [api/v1/mcp/registry](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-registry-list): List MCP tool registry entries
* `GET` [api/v1/mcp/registry/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-registry-retrieve): Get a specific MCP tool registry entry
* `GET` [api/v1/mcp/private-registry](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-list): List the organization's self-hosted MCP Servers
* `POST` [api/v1/mcp/private-registry](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-create): Add a self-hosted MCP Server
* `GET` [api/v1/mcp/private-registry/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-retrieve): Get a specific self-hosted MCP Server
* `PATCH` [api/v1/mcp/private-registry/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-partial-update): Partially update a self-hosted MCP Server
* `DELETE` [api/v1/mcp/private-registry/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-destroy): Delete a self-hosted MCP Server
* `POST` [api/v1/mcp/private-registry/test-connection](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-test-connection-create): Test an MCP Server connection
* `GET` [api/v1/tool-execution-records](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tool-execution-records-list): Get the tool execution record list
* `GET` [api/v1/tool-execution-records/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tool-execution-records-retrieve): Get a specific tool execution record
* `GET` [api/v1/tool-execution-records/chatbots](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tool-execution-records-chatbots-list): Get AI assistant filter options for execution records
* `GET` [api/v1/tool-execution-records/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tool-execution-records-tools-list): Get tool filter options for execution records
* `GET` [api/v1/tools/{toolPk}/tool-execution-records](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-tool-execution-records-list): Get the execution record list of a specific tool
* `GET` [api/v1/tools/{toolPk}/tool-execution-records/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-tool-execution-records-retrieve): Get a specific execution record of a specific tool
* `GET` [api/v1/tools/{toolPk}/tool-execution-records/chatbots](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-tool-execution-records-chatbots-list): Get AI assistant filter options for a specific tool's execution records
* `GET` [api/v1/tools/{toolPk}/tool-execution-records/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-tool-execution-records-tools-list): Get tool filter options for a specific tool's execution records

### Skills

* `POST` [api/v1/skills/upload](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-upload-create): Upload a skill
* `POST` [api/v1/skills](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-create): Create a skill
* `GET` [api/v1/skills](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-list): List skills
* `GET` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-retrieve): Retrieve a specific skill
* `PUT` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-update): Update a skill
* `PATCH` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-partial-update): Partially update a skill
* `DELETE` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-destroy): Delete a skill
* `GET` [api/v1/skills/{id}/export](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-export-retrieve): Export a skill
* `GET` [api/v1/skills/{id}/package-structure](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-package-structure-retrieve): Browse the skill package directory structure
* `POST` [api/v1/skills/{id}/reupload](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-reupload-create): Reupload a skill
* `GET` [api/v1/skills/{skillPk}/resources](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-resources-list): List skill resources
* `POST` [api/v1/skills/{skillPk}/resources](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-resources-create): Upload a skill resource
* `DELETE` [api/v1/skills/{skillPk}/resources/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-resources-destroy): Delete a skill resource
* `GET` [api/v1/skills/{skillPk}/resources/{id}/download](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-resources-download-retrieve): Download a skill resource

### Databases

* `POST` [api/v1/sql-databases](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-create): Create a SQL database connection
* `GET` [api/v1/sql-databases](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-list): List SQL databases
* `GET` [api/v1/sql-databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-retrieve): Retrieve a specific SQL database
* `PUT` [api/v1/sql-databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-update): Update a SQL database
* `PATCH` [api/v1/sql-databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-partial-update): Partially update a SQL database
* `DELETE` [api/v1/sql-databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-destroy): Delete a SQL database
* `POST` [api/v1/sql-databases/{id}/test-connection](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-test-connection-create): Test a database connection
* `POST` [api/v1/sql-databases/{id}/upload-files](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-upload-files-create): Upload files to a database
* `POST` [api/v1/sql-databases/batch-delete](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-batch-delete-create): Batch delete SQL databases
* `GET` [api/v1/sql-databases/{sqlDatabasePk}/tables](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-list): List tables
* `POST` [api/v1/sql-databases/{sqlDatabasePk}/tables](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-create): Create a table
* `GET` [api/v1/sql-databases/{sqlDatabasePk}/tables/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-retrieve): Retrieve a specific table
* `PUT` [api/v1/sql-databases/{sqlDatabasePk}/tables/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-update): Update a table
* `PATCH` [api/v1/sql-databases/{sqlDatabasePk}/tables/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-partial-update): Partially update a table
* `DELETE` [api/v1/sql-databases/{sqlDatabasePk}/tables/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-destroy): Delete a table
* `POST` [api/v1/sql-databases/{sqlDatabasePk}/tables/batch-delete](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-batch-delete-create): Batch delete tables
* `GET` [api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-columns-list): List columns
* `GET` [api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-columns-retrieve): Retrieve a specific column
* `PUT` [api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-columns-update): Update a column
* `PATCH` [api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-columns-partial-update): Partially update a column
* `POST` [api/v1/database-connection/test](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#database-connection-test-create): Test a database connection (general)
* `GET` [api/v1/database-examples](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#database-examples-list): List example database connection strings
* `GET` [api/v1/database-examples/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#database-examples-retrieve): Retrieve a specific example connection string
* `GET` [api/v1/chatbots/{chatbotPk}/databases](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-list): List database configurations for an AI assistant
* `POST` [api/v1/chatbots/{chatbotPk}/databases](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-create): Add a database configuration for an AI assistant
* `GET` [api/v1/chatbots/{chatbotPk}/databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-retrieve): Retrieve a specific database configuration
* `PUT` [api/v1/chatbots/{chatbotPk}/databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-update): Update a database configuration
* `PATCH` [api/v1/chatbots/{chatbotPk}/databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-partial-update): Partially update a database configuration
* `DELETE` [api/v1/chatbots/{chatbotPk}/databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-destroy): Delete a database configuration

### Evaluations and Test Datasets

* `GET` [api/v1/dataset](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-list): List test datasets
* `POST` [api/v1/dataset](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-create): Create an empty test dataset
* `POST` [api/v1/dataset/upload](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-upload-create): Upload a CSV or Excel file to create a test dataset
* `POST` [api/v1/dataset/generate-from-file](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-generate-from-file-create): Generate a test dataset from a knowledge base file
* `GET` [api/v1/dataset/knowledge-base-files](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-knowledge-base-files-retrieve): List knowledge base files available for generating test cases
* `GET` [api/v1/dataset/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-retrieve): Retrieve a specific test dataset
* `GET` [api/v1/dataset/{id}/details](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-details-retrieve): Retrieve a test dataset and its single-turn test cases
* `PUT` [api/v1/dataset/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-update): Update a test dataset
* `PATCH` [api/v1/dataset/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-partial-update): Partially update a test dataset
* `DELETE` [api/v1/dataset/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-destroy): Delete a test dataset
* `GET` [api/v1/test-case](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-list): List single-turn test cases
* `POST` [api/v1/test-case](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-create): Create a single-turn test case
* `POST` [api/v1/test-case/upload](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-upload-create): Upload a CSV or Excel file to add test cases
* `POST` [api/v1/test-case/generate-from-file](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-generate-from-file-create): Generate single-turn test cases from a knowledge base file
* `GET` [api/v1/test-case/generation-jobs](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-generation-jobs-list): List test case generation jobs
* `GET` [api/v1/test-case/generation-jobs/{jobId}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-generation-jobs-retrieve): Check the progress of a test case generation job
* `PUT` [api/v1/test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-update): Update a single-turn test case
* `PATCH` [api/v1/test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-partial-update): Partially update a single-turn test case
* `DELETE` [api/v1/test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-destroy): Delete a single-turn test case
* `POST` [api/v1/test-case/bulk-delete](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-bulk-delete-create): Batch delete single-turn test cases
* `GET` [api/v1/multi-turn-test-case](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-list): List multi-turn test cases
* `POST` [api/v1/multi-turn-test-case](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-create): Create a multi-turn test case
* `POST` [api/v1/multi-turn-test-case/generate-from-file](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-generate-from-file-create): Generate multi-turn test cases from a knowledge base file
* `GET` [api/v1/multi-turn-test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-retrieve): Retrieve a specific multi-turn test case
* `PUT` [api/v1/multi-turn-test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-update): Update a multi-turn test case
* `PATCH` [api/v1/multi-turn-test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-partial-update): Partially update a multi-turn test case
* `DELETE` [api/v1/multi-turn-test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-destroy): Delete a multi-turn test case
* `GET` [api/v1/evaluations/evaluation-llms](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-evaluation-llms-list): List available evaluation models
* `POST` [api/v1/evaluations/evaluate](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-evaluate-create): Run a single-turn evaluation
* `POST` [api/v1/evaluations/multi-turn-evaluate](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-multi-turn-evaluate-create): Run a multi-turn evaluation
* `GET` [api/v1/evaluations](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-list): List evaluations
* `GET` [api/v1/evaluations/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-retrieve): Retrieve evaluation results
* `GET` [api/v1/evaluations/{id}/details](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-details-list): Retrieve per-question results for a single-turn evaluation
* `GET` [api/v1/evaluations/{id}/multi-turn-results](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-multi-turn-results-list): Retrieve per-conversation results for a multi-turn evaluation
* `POST` [api/v1/evaluations/{id}/cancel](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-cancel-create): Cancel a running evaluation
* `POST` [api/v1/evaluations/{id}/resume](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-resume-create): Resume an unfinished evaluation
* `POST` [api/v1/evaluations/{id}/export](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-export-create): Export an evaluation report
* `GET` [api/v1/evaluations/{id}/export-status](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-export-status-retrieve): Check the latest export status
* `GET` [api/v1/evaluations/{id}/exports](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-exports-list): List export records
* `PATCH` [api/v1/evaluations/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-partial-update): Edit an evaluation's name and description
* `DELETE` [api/v1/evaluations/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-destroy): Delete an evaluation

### Credit

* `GET` [api/v1/credit/wallets](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-list): Check the Credit balance
* `GET` [api/v1/credit/wallets/{id}](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-retrieve): Retrieve wallet details
* `GET` [api/v1/credit/wallets/{id}/balance](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-balance-retrieve): Retrieve the wallet balance
* `GET` [api/v1/credit/wallets/{id}/expiring-credits](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-expiring-credits-retrieve): Check credits that are about to expire
* `GET` [api/v1/credit/wallets/{id}/topup-history](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-topup-history-retrieve): Check top-up records
* `GET` [api/v1/credit/transactions](https://docs.maiagent.ai/api/api-reference/credit#credit-transactions-list): List usage details
* `GET` [api/v1/credit/transactions/{id}](https://docs.maiagent.ai/api/api-reference/credit#credit-transactions-retrieve): Retrieve a single usage entry
* `GET` [api/v1/credit/transactions/history](https://docs.maiagent.ai/api/api-reference/credit#credit-transactions-history-retrieve): Check usage history
* `GET` [api/v1/credit/transactions/history-summary](https://docs.maiagent.ai/api/api-reference/credit#credit-transactions-history-summary-retrieve): Check total usage
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories](https://docs.maiagent.ai/api/api-reference/credit#organizations-usage-statistics-credit-categories-list): Check Credit usage by category
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-usage-statistics-credit-categories-retrieve): Check Credit usage for a specific category
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{itemPk}/members](https://docs.maiagent.ai/api/api-reference/credit#organizations-usage-statistics-credit-categories-members-list): Check members' usage for a billable item
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{itemPk}/members/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-usage-statistics-credit-categories-members-retrieve): Check a specific member's usage for a billable item
* `GET` [api/v1/organizations/{organizationPk}/credit-quota-members](https://docs.maiagent.ai/api/api-reference/credit#organizations-credit-quota-members-list): List current member quotas
* `GET` [api/v1/organizations/{organizationPk}/credit-quota-groups](https://docs.maiagent.ai/api/api-reference/credit#organizations-credit-quota-groups-list): List current role quotas
* `GET` [api/v1/organizations/{organizationPk}/credit-quota-inboxes](https://docs.maiagent.ai/api/api-reference/credit#organizations-credit-quota-inboxes-list): List current conversation platform quotas
* `GET` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#organizations-members-credit-quotas-list): List a member's quota settings
* `GET` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-members-credit-quotas-retrieve): Retrieve a specific quota setting for a member
* `POST` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#organizations-members-credit-quotas-create): Set a quota for a member
* `PATCH` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-members-credit-quotas-partial-update): Update a member's quota settings
* `DELETE` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-members-credit-quotas-destroy): Deactivate a member's quota settings
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quotas-list): List a role's quota settings
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quotas-retrieve): Retrieve a specific quota setting for a role
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quotas-create): Set a quota for a role
* `PATCH` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quotas-partial-update): Update a role's quota settings
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quotas-destroy): Deactivate a role's quota settings
* `PATCH` [api/v1/organizations/{organizationPk}/credit-quota-groups/{id}/credit-quota-required](https://docs.maiagent.ai/api/api-reference/credit#organizations-credit-quota-groups-credit-quota-required-partial-update): Set whether a role requires a quota
* `GET` [api/v1/organizations/{organizationPk}/groups/{id}/credit-quota-stats](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quota-stats-retrieve): Check quota statistics for role members
* `POST` [api/v1/organizations/{organizationPk}/groups/{id}/batch-distribute-credit-quota](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-batch-distribute-credit-quota-create): Batch distribute quotas by role
* `POST` [api/v1/organizations/{organizationPk}/groups/{id}/batch-deactivate-credit-quota](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-batch-deactivate-credit-quota-create): Batch deactivate quotas by role
* `GET` [api/v1/inboxes/{inboxPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#inboxes-credit-quotas-list): List a conversation platform's quota settings
* `GET` [api/v1/inboxes/{inboxPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#inboxes-credit-quotas-retrieve): Retrieve a specific quota setting for a conversation platform
* `POST` [api/v1/inboxes/{inboxPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#inboxes-credit-quotas-create): Set a quota for a conversation platform
* `PATCH` [api/v1/inboxes/{inboxPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#inboxes-credit-quotas-partial-update): Update a conversation platform's quota settings
* `DELETE` [api/v1/inboxes/{inboxPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#inboxes-credit-quotas-destroy): Deactivate a conversation platform's quota settings
* `PATCH` [api/v1/organizations/{organizationPk}/credit-quota-inboxes/{id}/credit-quota-required](https://docs.maiagent.ai/api/api-reference/credit#organizations-credit-quota-inboxes-credit-quota-required-partial-update): Set whether a conversation platform requires a quota
* `GET` [api/v1/organizations/{organizationPk}/me/credit-quota](https://docs.maiagent.ai/api/api-reference/credit#organizations-me-credit-quota-retrieve): Check your own quota
* `GET` [api/v1/organizations/{organizationPk}/me/group-credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#organizations-me-group-credit-quotas-retrieve): Check quotas for your roles
* `GET` [api/v1/credit/pricing-rules](https://docs.maiagent.ai/api/api-reference/credit#credit-pricing-rules-list): List pricing rules
* `GET` [api/v1/credit/pricing-rules/{id}](https://docs.maiagent.ai/api/api-reference/credit#credit-pricing-rules-retrieve): Retrieve a specific pricing rule
* `GET` [api/v1/credit/items](https://docs.maiagent.ai/api/api-reference/credit#credit-items-list): List billable items
* `GET` [api/v1/credit/items/{id}](https://docs.maiagent.ai/api/api-reference/credit#credit-items-retrieve): Retrieve a specific billable item

### AI Gateway

* `GET` [api/v1/models](https://docs.maiagent.ai/api/api-reference/ai-gateway#models-retrieve): List available models
* `POST` [api/v1/chat/completions](https://docs.maiagent.ai/api/api-reference/ai-gateway#chat-completions-create): Chat completions (supports streaming and tool calls)
* `POST` [api/v1/embeddings](https://docs.maiagent.ai/api/api-reference/ai-gateway#embeddings-create): Generate text embeddings

### SCIM

* `GET` [api/v1/scim/{orgUuid}/ServiceProviderConfig](https://docs.maiagent.ai/api/api-reference/scim#scim-service-provider-config-retrieve): Retrieve service provider configuration (for IdP discovery)
* `GET` [api/v1/scim/{orgUuid}/Users](https://docs.maiagent.ai/api/api-reference/scim#scim-users-retrieve): List or query members (supports `filter`, `startIndex`, and `count`)
* `POST` [api/v1/scim/{orgUuid}/Users](https://docs.maiagent.ai/api/api-reference/scim#scim-users-create): Create a member
* `GET` [api/v1/scim/{orgUuid}/Users/{userId}](https://docs.maiagent.ai/api/api-reference/scim#scim-users-retrieve2): Retrieve a specific member
* `PUT` [api/v1/scim/{orgUuid}/Users/{userId}](https://docs.maiagent.ai/api/api-reference/scim#scim-users-update): Replace an entire member record
* `PATCH` [api/v1/scim/{orgUuid}/Users/{userId}](https://docs.maiagent.ai/api/api-reference/scim#scim-users-partial-update): Partially update a member (deactivate, rename, or change externalId)
* `DELETE` [api/v1/scim/{orgUuid}/Users/{userId}](https://docs.maiagent.ai/api/api-reference/scim#scim-users-destroy): Deactivate a member
* `GET` [api/v1/scim/{orgUuid}/Groups](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-retrieve): List groups (corresponding to MaiAgent roles)
* `POST` [api/v1/scim/{orgUuid}/Groups](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-create): Create a group
* `GET` [api/v1/scim/{orgUuid}/Groups/{groupId}](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-retrieve2): Retrieve a specific group
* `PUT` [api/v1/scim/{orgUuid}/Groups/{groupId}](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-update): Replace an entire group record
* `PATCH` [api/v1/scim/{orgUuid}/Groups/{groupId}](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-partial-update): Partially update a group (rename, add or remove members)
* `DELETE` [api/v1/scim/{orgUuid}/Groups/{groupId}](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-destroy): Delete a group

### Meeting Records

* `GET` [api/v1/meeting-records](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-list): List meeting records
* `POST` [api/v1/meeting-records](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-create): Create a meeting record
* `GET` [api/v1/meeting-records/{id}](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-retrieve): Retrieve a specific meeting record
* `PATCH` [api/v1/meeting-records/{id}](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-partial-update): Partially update a meeting record
* `DELETE` [api/v1/meeting-records/{id}](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-destroy): Delete a meeting record
* `POST` [api/v1/meeting-records/import-audio](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-import-audio-create): Import an audio file and start transcription
* `GET` [api/v1/meeting-records/{id}/transcript](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-transcript-retrieve): Retrieve the meeting transcript (JSON)
* `GET` [api/v1/meeting-records/{meetingRecordPk}/summaries](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-summaries-list): List meeting summaries
* `POST` [api/v1/meeting-records/{meetingRecordPk}/summaries/generate](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-summaries-generate-create): Generate a meeting summary
* `GET` [api/v1/meeting-records/{meetingRecordPk}/summaries/{id}](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-summaries-retrieve): Retrieve a specific meeting summary
* `POST` [api/v1/meeting-records/{id}/upload-transcript](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-upload-transcript-create): Upload the transcript to a knowledge base
* `GET` [api/v1/meeting-records/{id}/download-srt](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-download-srt-retrieve): Download the SRT subtitle file
* `GET` [api/v1/meeting-records/{id}/download-mp3](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-download-mp3-retrieve): Download the MP3 audio file


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.maiagent.ai/api/en/preparation/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.