> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.beatapi.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.beatapi.io/_mcp/server.

# 集成

> 把现有的编程助手、桌面对话客户端或大模型平台指向 BeatAPI，只需改一个地址和一把密钥。

# 集成

绝大多数已经在调用厂商接口的工具，都可以改调 BeatAPI。不用重写代码 —— 换一个地址、粘一把 BeatAPI 密钥、选一个模型编号即可。

BeatAPI 同时支持四种请求格式，工具用哪种就保持哪种。

| 格式                      | 端点                                     | 使用它的工具                                                    |
| ----------------------- | -------------------------------------- | --------------------------------------------------------- |
| OpenAI Chat Completions | `POST /v1/chat/completions`            | Cherry Studio、ChatBox、Cline、Cursor、AnythingLLM、Dify、沉浸式翻译 |
| OpenAI Responses        | `POST /v1/responses`                   | Codex CLI                                                 |
| Anthropic Messages      | `POST /v1/messages`                    | Claude Code                                               |
| Gemini 兼容               | `POST /v1beta/models/{model}:{action}` | 基于 Gemini SDK 的集成                                         |

## 编程工具

#### [Claude Code](/integrations/claude-code)

终端编程助手，通过 `ANTHROPIC_BASE_URL` 配置。

#### [Codex CLI](/integrations/codex-cli)

在 `config.toml` 中把 BeatAPI 添加为自定义模型提供方。

#### [Gemini CLI](/integrations/gemini-cli)

两个环境变量即可指向原生 Gemini 端点。

#### [Cline](/integrations/cline)

VS Code 插件，使用它的 OpenAI Compatible 选项。

#### [Cursor](/integrations/cursor)

在编辑器的模型设置里覆盖 OpenAI 地址。

#### [CC-Switch](/integrations/cc-switch)

用一个桌面程序统一管理 Claude Code 与 Codex CLI 的配置。

## 对话客户端

#### [Cherry Studio](/integrations/cherry-studio)

添加为 OpenAI 类型的服务商并加载模型列表。

#### [ChatBox](/integrations/chatbox)

OpenAI、Claude、Gemini 三种类型都可用。

#### [AnythingLLM](/integrations/anythingllm)

作为本地知识库背后的对话模型。

## 平台

#### [n8n](/integrations/n8n)

使用内置模型与 HTTP 节点，并按具体任务导入工作流。

#### [Dify](/integrations/dify)

配置文本模型；动作由单独发布的工具插件提供。

#### [Zapier](/integrations/zapier)

使用已公开的模型、社媒数据、能力和媒体动作。

#### [Make](/integrations/make)

使用可分享的媒体模板，或自建 HTTP 场景。

#### [沉浸式翻译](/integrations/immersive-translate)

在浏览器插件中添加为自定义翻译服务。

## 所有教程共用的三个值

下面三项到处都一样。如果你用的工具不在上面的列表里，找到它的 OpenAI 兼容选项，填这三个值通常就能跑通。

| 配置项  | 值                                                                                 |
| ---- | --------------------------------------------------------------------------------- |
| 接口地址 | OpenAI 兼容工具填 `https://api.beatapi.io/v1`，Anthropic 原生工具填 `https://api.beatapi.io` |
| 密钥   | 在[控制台 → API 密钥](https://beatapi.io/dashboard/apikeys)创建                           |
| 模型编号 | 取自 [`GET /v1/models`](/text-api) 或[价目页](https://beatapi.io/pricing)               |

> **Note**
>
> 唯一容易搞混的就是地址末尾要不要带 `/v1`。遵循 OpenAI SDK 惯例的工具要 `https://api.beatapi.io/v1`；基于 Anthropic SDK 的工具要 `https://api.beatapi.io`，它会自己拼上 `/v1/messages`。每篇教程都会写明该用哪一个。

## 怎么选模型

所有集成用同一把密钥访问同一份模型目录。下表是起步建议，完整清单见[文本 API](/text-api) 各页。

| 需求      | 模型编号                                                           |
| ------- | -------------------------------------------------------------- |
| 智能体编程   | `claude-fable-5-1`、`gpt-5.6-sol`                               |
| 高难推理    | `claude-opus-5`、`gpt-6-astra`、`deepseek-v4-pro-0813`           |
| 日常对话    | `claude-sonnet-5`、`gpt-5.6-terra`、`glm-5.3`                    |
| 大批量、低成本 | `claude-haiku-4-5-20251001`、`gemini-3.7-flash`、`glm-5.3-flash` |
| 超长上下文   | `minimax-m3`、`grok-4.7`                                        |

## 密钥怎么放才安全

* 每个工具单独发一把密钥，这样吊销其中一把不会影响其他。
* 优先用环境变量，而不是写进可能被提交的配置文件。
* 把存有密钥的配置文件加进 `.gitignore`。
* 在 [`GET /v1/usage`](/quick-guide) 的 `by_api_key` 或控制台里，按密钥查看各自的消耗。