> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bytespike.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Endpoint 类型

> ByteSpike 在同一把 key 下暴露 5 种真实的 endpoint 形状 —— 3 个文本协议（Anthropic Messages、OpenAI Chat Completions、OpenAI Responses、Gemini Native），加上 2 个多模态形状（Image、Async Tasks）。挑你客户端本来就会讲的那种协议。

ByteSpike 在一把 API key 后面暴露一组数量少、定义清晰的 endpoint。每一个都对应
不同的客户端形态 —— 已有的 SDK、Agent 框架、多模态流水线。网关在各协议之间
做翻译，让你不用再写各家厂商的胶水代码。

**原则：** 挑你客户端本来就会讲的那种协议；剩下的交给网关。

## Endpoint 全貌

| # | Endpoint                | 路径                                                               | 适用客户端                                          |
| - | ----------------------- | ---------------------------------------------------------------- | ---------------------------------------------- |
| 1 | Anthropic Messages      | `POST /v1/messages`                                              | Agent 框架 · Claude SDK · DOSIA · Claude Code    |
| 2 | OpenAI Responses        | `POST /v1/responses`                                             | OpenAI Codex CLI · OpenAI Agents SDK · 重推理的客户端 |
| 3 | OpenAI Chat Completions | `POST /v1/chat/completions`                                      | 最普及的 chat 形状 · openai SDK · 大多数编辑器集成           |
| 4 | Gemini Native           | `POST /v1beta/models/{model}:generateContent`                    | Google 的 CLI / SDK · Vertex 兼容客户端              |
| 5 | Image Generation（同步）    | `POST /v1/images/generations` · `/v1/images/edits`               | OpenAI 形状的图像 SDK · 单次调用图像生成                    |
| 6 | 异步多模态任务                 | `POST /v1/tasks/submit` · `/v1/tasks/query` · `/v1/tasks/cancel` | 视频生成（Veo）· 批量图像渲染                              |

就这些。没有 `/v1/embeddings`、没有 `/v1/audio/*`、没有 `/v1/rerank`、没有
`/v1/assistants` —— ByteSpike 当前不暴露这些。

### 1. Anthropic Messages —— `/v1/messages`

ByteSpike 的看家 agent 协议。`tool_use`、`cache_control`、`thinking`、`web_search`
四种 block 全程保留。适合：

* 你在做 agent，需要显式的 tool-call / tool-result block
* 你想在 Opus / Sonnet 4.x 上用 extended thinking
* 客户端是官方 `anthropic` SDK（Python / Node）或其衍生

原生支持 Claude 模型；DeepSeek、Gemini、GPT 模型经透明翻译也可用 —— 在 `model`
字段里传任意目录模型即可。

详见 [`/v1/messages` 参考](/zh/api-reference/text/claude-messages)。

### 2. OpenAI Responses —— `/v1/responses`

OpenAI 较新的 agent 风格协议（Codex CLI + Agents SDK）。适合：

* 客户端是 OpenAI Codex CLI
* 你想把 structured-outputs 和 reasoning 一起用
* 你在用 OpenAI Agents SDK

原生支持 GPT 模型；Claude、Gemini 模型经透明翻译也可用。

详见 [`/v1/responses` 参考](/zh/api-reference/text/openai-responses)。

### 3. OpenAI Chat Completions —— `/v1/chat/completions`

生态里最普及的 chat 形状。几乎所有 SDK 都会讲。适合：

* 你已有 `openai` SDK 代码，想用最省事的路径
* 你不是在写 agent —— 一来一回的 chat
* 你要调非 OpenAI 模型但想继续用 OpenAI SDK

支持 GPT、Gemini、DeepSeek、Kimi（Moonshot）、GLM（Zhipu）、MiniMax、
Doubao（字节跳动）模型 —— 在 `model` 字段里传任意目录模型即可。

详见 [`/v1/chat/completions` 参考](/zh/api-reference/text/openai-chat-completions)。

### 4. Gemini Native —— `/v1beta/models/{model}:generateContent`

Google 的原生协议原样透传。适合：

* 你在用 Google 官方 CLI 或 SDK
* 你想用原生形式的 grounding（`googleSearch` 工具）
* 下游工具链需要 Gemini 准确的响应形状

流式走 `:streamGenerateContent?alt=sse`。该协议只服务 Gemini 家族。

详见 [`/v1beta/...` 参考](/zh/api-reference/text/gemini-generate-content)。

### 5. 图像生成（同步）—— `/v1/images/generations` + `/v1/images/edits`

各家 provider 都用 OpenAI 形状的请求体；`model` 字段决定路由。用于：

* 单提示词图像生成（GPT-Image-2 形状）
* 配合 mask 或指令的图像编辑

服务 GPT Image 2（OpenAI）与 Nano Banana（Google）图像模型 —— 全都走同一套
OpenAI 形状请求体。

### 6. 异步多模态任务 —— `/v1/tasks/{submit, query, cancel, stream}`

视频与长耗时图像生成走异步任务模型：submit 立刻返回 `task_id`，可以轮询
`/tasks/query`，也可以在 `/tasks/stream/{task_id}` 上通过 SSE 流式获取状态变化。
用于：

* 视频生成（Veo 3.1）—— 需要 10-60s 以上
* 想"提交即走"的批量图像生成
* 高并发生产者，不希望让 HTTP 连接长期挂着

详见 [`/tasks/submit` 参考](/zh/api-reference/utility/tasks-submit)。

## 各模型家族可走哪些协议

每个模型家族在 ByteSpike 上能通过哪些协议调用。✅ = 支持；— = 该协议不可用。

| 模型家族                  | Anthropic Messages | OpenAI Responses | OpenAI Chat | Gemini Native | Image（同步） | Async tasks |
| --------------------- | ------------------ | ---------------- | ----------- | ------------- | --------- | ----------- |
| **Claude**（Anthropic） | ✅                  | translated       | translated  | —             | —         | —           |
| **GPT**（OpenAI）       | translated         | ✅                | ✅           | —             | ✅         | —           |
| **Gemini**（Google）    | translated         | translated       | ✅（shim）     | ✅             | —         | ✅（Veo）      |
| **DeepSeek**          | ✅（V4）              | —                | ✅           | —             | —         | —           |
| **Kimi**（Moonshot）    | ✅                  | —                | ✅           | —             | —         | —           |
| **GLM**（Zhipu）        | —                  | —                | ✅           | —             | —         | —           |
| **MiniMax**           | —                  | —                | ✅           | —             | —         | —           |
| **Doubao**（字节跳动）      | —                  | —                | ✅           | —             | —         | —           |

实时、对应你账号的清单，请调
[`GET /api/v1/me/available-models`](/zh/api-reference/account/me-account)，
或者在 console 任一模型旁点 [Test](https://console.bytespike.ai/dosia/models)。

## 按客户端挑

| 你的客户端                           | 用这个 endpoint                                 |
| ------------------------------- | -------------------------------------------- |
| Claude Code                     | Anthropic Messages                           |
| Claude Desktop                  | Anthropic Messages                           |
| Anthropic SDK（Python / Node）    | Anthropic Messages                           |
| Cursor / Continue / Cline / Zed | OpenAI Chat Completions                      |
| OpenAI Python / Node SDK        | OpenAI Chat Completions                      |
| OpenAI Codex CLI                | OpenAI Responses                             |
| OpenAI Agents SDK               | OpenAI Responses                             |
| Google Gemini CLI / SDK         | Gemini Native（或 OpenAI shim）                 |
| Aider                           | OpenAI Chat Completions（或通过 SDK base URL 覆盖） |

## 场景

| 你想要                                    | Endpoint                                                                           |
| -------------------------------------- | ---------------------------------------------------------------------------------- |
| 带 tool\_use + thinking 的 agent         | **Anthropic Messages**                                                             |
| 现有 openai SDK 代码、零改写                   | **Chat Completions**                                                               |
| Codex CLI / OpenAI Agents SDK          | **OpenAI Responses**                                                               |
| 不改 SDK 代码就在 Claude / GPT / Gemini 之间切换 | 大多数场景用 **Chat Completions**；需要 cache\_control 或 thinking 时用 **Anthropic Messages** |
| 生成图像                                   | **Image（同步）**                                                                      |
| 生成视频                                   | **Async tasks**                                                                    |

## 一个 key、多 endpoint

ByteSpike 的 API key 目前绑定到 **一个** 路由分组（`group_id`）。分组决定 key
能触达哪些模型家族。在同一个分组内，这些模型支持的所有 endpoint 形状都可用
—— 例如，绑在 `claude-default` 上的 key 可以对 Claude 模型调
`/v1/messages`、`/v1/chat/completions`（经翻译）、`/v1/responses`（经翻译）。

要触达不同分组里的模型家族，就建多把 key（每个分组一把），按请求选用。详见
[鉴权](/zh/authentication)。

## 下一步

* [模型](/zh/models) —— 完整目录，含价格与协议
* [多模态概念](/zh/concepts/multimodal) —— 同步图像与异步视频的计费差异
* [错误处理](/zh/concepts/error-handling) —— 重试、幂等性、流式错误
