Skip to content

docs: Update custom model BYOK support scope #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HynLcc merged 1 commit into from
May 9, 2026
+32 −4
Merged

docs: Update custom model BYOK support scope #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions en/basic/ai/custom-model.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ description: Enable AI capabilities in a space and add model providers for AI Fi
<Note>
Custom model configuration applies to all Teable AI features, including **AI Chat**, **AI Fields**, **App Builder**, and **Automations**.

Starting April 9, 2026, Teable's agent engine has been upgraded to enhance AI capabilities across **AI Chat Agent** mode and **App Builder**. As part of this upgrade, these features currently only support Anthropic-compatible API endpoints. **Using incompatible endpoints may result in errors.**
Starting April 9, 2026, Teable's agent engine has been upgraded for **AI Chat** and **App Builder**. These agent-based features currently require Anthropic-compatible API endpoints. **Using an incompatible endpoint may cause errors.**

- **Cloud users with BYOK:** If your custom model provider does not support the Anthropic Messages API format, AI Chat Agent and App Builder will not function with your BYOK configuration. Please switch to an Anthropic-compatible provider (e.g. Anthropic API, OpenRouter) or use the default Teable model.
- **Cloud users with BYOK:** Use one of the supported provider and model pairs listed in [**Agent Support Scope**](#agent-support-scope) below.
- **Self-hosted users:** Please ensure your configured LLM endpoint is Anthropic-compatible. Alternatively, you can wait for our upcoming OpenAI-compatible endpoint support and pull the latest image once it's available.
- **OpenAI-compatible endpoint support** is on our roadmap and will be added in a future release.

Expand Down Expand Up @@ -42,6 +42,20 @@ Click **Add LLM provider** and fill in the following:
- **API Key**: Enter the API key from the provider.
- **Models**: Enter the model names you want to connect. Separate multiple models with English commas.

#### Agent Support Scope

To use **AI Chat** and **App Builder** reliably, configure one of the supported models below. Models outside this list may still work for **AI Fields** or **Automations**, but they are not recommended for agent-based features. In **AI Chat** and **App Builder**, unsupported endpoints, providers, or models may produce weaker results, miss tool-use capabilities, or cause runtime errors. Teable does not provide troubleshooting or performance support for configurations outside this scope.

<Note>
The providers below refer to the model service source. When adding an LLM provider in Teable, select an Anthropic-compatible endpoint, then enter the corresponding Base URL, API key, and model name.
</Note>

| Model provider | Supported model |
|----------------|-----------------|
| [Anthropic](https://platform.claude.com) / [OpenRouter](https://openrouter.ai) | Claude series |
| [Moonshot AI](https://platform.moonshot.ai) / [OpenRouter](https://openrouter.ai) | Kimi K2.6 |
| [MiniMax](https://platform.minimax.io) / [OpenRouter](https://openrouter.ai) | MiniMax M2.7 |

### Test Model Capabilities

There are currently three ways to test:
Expand Down
18 changes: 16 additions & 2 deletions zh/basic/ai/custom-model.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ description: 在空间中开启 AI 能力并添加模型提供商，用于 AI
<Note>
自定义模型配置适用于所有 Teable AI 功能，包括 **AI Chat**、**AI 字段**、**App Builder** 和**自动化**。

自 2026 年 4 月 9 日起，Teable 的 Agent 引擎已完成升级，以提升 **AI Chat Agent** 模式和 **App Builder** 的 AI 能力。本次升级后，这些功能当前仅支持 Anthropic 兼容的 API 端点，**使用不兼容的端点可能会导致报错。**
自 2026 年 4 月 9 日起，Teable 的 Agent 引擎已完成升级，以提升 **AI Chat** 和 **App Builder** 的 AI Agent 能力。本次升级后，这些功能当前仅支持 Anthropic 兼容的 API 端点，**使用不兼容的端点可能会导致报错。**

- **Cloud 用户（BYOK）：** 如果您的自定义模型提供商不支持 Anthropic Messages API 格式，AI Chat Agent 和 App Builder 将无法使用您的 BYOK 配置。请切换至 Anthropic 兼容的提供商（如 Anthropic API、OpenRouter），或使用 Teable 默认模型。
- **Cloud 用户（BYOK）：** 请使用下方 [**Agent 支持范围**](#agent-支持范围) 中列出的提供商和模型组合。
- **私有化部署用户：** 请确保您配置的 LLM 端点兼容 Anthropic 格式。您也可以等待我们后续适配 OpenAI 兼容端点后，拉取最新镜像即可。
- **OpenAI 兼容端点支持**已在规划中，将在后续版本中推出。

Expand Down Expand Up @@ -42,6 +42,20 @@ description: 在空间中开启 AI 能力并添加模型提供商，用于 AI
- **API 密钥**：填写服务商提供的 API 密钥。
- **模型**：填写要接入的模型名称，多个模型之间使用英文逗号分隔。

#### Agent 支持范围

为保证体验，请在 **AI Chat** 和 **App Builder** 中使用下方支持的模型。列表外模型可能在 **AI 字段** 或**自动化**等部分 AI 功能中可用。对于 **AI Chat** 和 **App Builder**，不支持的模型更容易出现 Agent 效果不稳定、工具能力缺失或运行时报错。如您使用范围外的端点、提供商或模型，Teable 不提供故障排查或效果支持。

<Note>
下表中的提供商指模型服务来源。您在 Teable 中添加模型提供商时，需要选择 Anthropic 兼容端点，并填写对应服务商的基础 URL、API 密钥和模型名称。
</Note>

| 模型提供商 | 支持的模型 |
|------------|------------|
| [Anthropic](https://platform.claude.com) / [OpenRouter](https://openrouter.ai) | Claude 系列 |
| [Moonshot AI](https://platform.moonshot.ai) / [OpenRouter](https://openrouter.ai) | Kimi K2.6 |
| [MiniMax](https://platform.minimax.io) / [OpenRouter](https://openrouter.ai) | MiniMax M2.7 |

### 测试模型能力

当前支持三种测试方式：
Expand Down