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

# API 概览

> 选择协议、设置鉴权并使用原生网关响应。

## 生成入口

| 协议 | HTTP 入口 | 指南 |
| - | - | - |
| Responses | `POST /v1/responses` | [Responses](/zh/api/responses) |
| Chat Completions | `POST /v1/chat/completions` | [Chat Completions](/zh/api/chat-completions) |
| Anthropic Messages | `POST /v1/messages` | [Messages](/zh/api/anthropic-messages) |
| Gemini | `POST /v1beta/models/MODEL_ID:generateContent` | [Gemini](/zh/api/gemini) |
| TypeSafe System One | `POST /v1/systemone` | [TypeSafe](/zh/api/typesafe) |

网关返回对应协议的原生 JSON 或流式事件，不使用控制台 API 的 `{ data, requestId }` 包装。模型必须声明相应协议。鉴权头见 [API 密钥](/zh/authentication)。

## 请求与响应

使用 `Content-Type: application/json` 与平台模型 ID。为生成请求显式设置合理的输出上限；System One 不使用生成长度参数。`GET /v1/models` 使用 OpenAI 风格模型列表，结果受密钥权限影响。

## 流式与失败处理

生成入口的流式格式随协议变化。Responses 是带事件类型的 SSE；Chat Completions 是增量 chunk；Messages 与 Gemini 使用各自事件或候选格式。不要混用解析器。

连接失败或中断不代表请求未执行。保留响应 ID 和请求日志，确认终态与费用再决定下一步。参见[能力与限制](/zh/capabilities)和[故障排查](/zh/troubleshooting)。

<Note>本指南描述用户生成接口。后台执行、WebSocket、token 计数和 compact 取决于渠道能力；文档站不提供自动执行的 API Playground。</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.