> 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/tech/en/readme.md).

# Welcome to MaiAgent

The MaiAgent technical manual entry point for IT teams, developers, and systems integration partners. Explore platform deployment, identity integration (SSO/SCIM/OAuth), API integration, and Agent tec

MaiAgent is an enterprise AI Agent platform that gives businesses their own AI core, built on company assets and governed by security controls. Deploy it as SaaS, in the cloud, on premises, or in a hybrid cloud—with the same platform and API.

This technical manual is for IT teams, developers, and systems integration partners. It covers platform deployment, identity integration, API integration, and the technology behind Agents. For feature instructions, see the [User Manual](https://docs.maiagent.ai/).

***

## Find Integration Options by Product Line <a href="#integrate-by-product-line" id="integrate-by-product-line"></a>

MaiAgent has three product lines, each with a different integration focus:

| Product Line                            | What You Want to Do                                                                                        | Start Here                                                                                                                                                                                                                                              |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **MaiAgent Work｜Employee Productivity** | Let organization members use MaiGPT within your own systems                                                | [Add MaiGPT to Your System](/tech/en/work/maigpt-system-integration-guide.md)                                                                                                                                                                           |
| **MaiAgent Serve｜Customer Service**     | Embed Agents in your website or product for customers and integrate with existing customer service systems | [Software Vendor Integration Guide](/tech/en/serve/vendor-integration-guide.md), [Web Chat Embedding and SDK](/tech/en/serve/web-chat-sdk.md), [Third-Party Customer Service System Integration](/tech/en/serve/customer-service-system-integration.md) |
| **MaiAgent Build｜Agent Development**    | Build and call Agents through APIs, and integrate models and enterprise systems                            | [API Quickstart](/tech/en/api-integration/quickstart.md), [MCP and External Services](/tech/en/mcp/mcp-model-context-protocol.md), [AI Gateway: OpenAI-Compatible API Integration](/tech/en/ai-gateway/ai-gateway-openai-compatible.md)                 |

Shared foundations across all three product lines:

* [Getting Started with Generative AI](/tech/en/quickstart/llm.md): Core concepts such as LLMs, RAG, Embedding, and Reranker
* [Technical Principles](/tech/en/advanced-genai-tech/system-prompt.md): How role instructions, Text to SQL, Function Calling, skills, and safeguards work
* [Identity and Permissions](/tech/en/identity-and-access/member-provisioning.md): Member provisioning (SCIM/invitations/SSO), SAML SSO, and knowledge access permissions
* [Platform Setup and Deployment](/tech/en/platform-development/gai-lan.md): SaaS/private cloud/on-premises environments, deployment architecture, and GPU compute planning

***

## MaiAgent Resources and Services

| Resource                                              | Contents                                                                                                                                                               |
| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [User Manual](https://docs.maiagent.ai/)              | Instructions for the admin console and features across products                                                                                                        |
| Technical Manual (this manual)                        | Deployment, identity integration, API integration, and technical principles                                                                                            |
| [API Documentation](https://docs.maiagent.ai/api)     | Complete API endpoint reference                                                                                                                                        |
| [Release Note](https://docs.maiagent.ai/release-note) | Weekly product updates                                                                                                                                                 |
| Training and AI Adoption Consulting                   | Administrator and user courses, requirements assessment, use case development, and knowledge base tuning. Contact <mark style="color:blue;"><sales@maiagent.ai></mark> |

***

## Get Started with MaiAgent

Register with MaiAgent and contact <mark style="color:blue;"><sales@maiagent.ai></mark>. A dedicated specialist will discuss your requirements and activate your trial.

{% embed url="<https://admin.maiagent.ai/>" %}

***

## About Us

思邁智能股份有限公司 | MaiAgent Co., Ltd.

Business Registration Number: 60688078

Address: 11F, No. 438, Guangfu S. Rd., Da’an Dist., Taipei City 106, Taiwan

Email: <sales@maiagent.ai>

Website: <https://maiagent.ai/>


---

# 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/tech/en/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.