# HaiRoute Doc

> HaiRoute API documentation for LLM models and services

## 快速开始

- [接入指南](https://docs.hairoute.ai/docs/zh/quickstart/integration-guide.md): 了解如何快速接入 HaiRoute 大模型网关，支持 OpenAI Chat Completions、OpenAI Responses 和 Claude 接口
- [获取 API Key](https://docs.hairoute.ai/docs/zh/quickstart/get-api-key.md): 了解如何获取 HaiRoute API Key

## API文档

### AI模型接口

#### 聊天

- [OpenAI 格式](https://docs.hairoute.ai/docs/zh/api-reference/chat/openai-format.md): 创建聊天补全请求，兼容 OpenAI Chat Completions 协议，支持流式和非流式响应
- [Claude 格式](https://docs.hairoute.ai/docs/zh/api-reference/chat/claude-format.md): 创建 Claude 消息，兼容 Anthropic Messages 协议，支持流式和非流式响应
- [Responses 格式](https://docs.hairoute.ai/docs/zh/api-reference/chat/responses-format.md): 创建聊天补全请求，兼容 OpenAI Responses 协议，支持流式和非流式响应

#### 模型

- [模型列表](https://docs.hairoute.ai/docs/zh/api-reference/models/list-models.md): 获取当前可用的模型列表，返回 OpenAI 兼容格式

#### 图片

- [OpenAI 图片生成接口](https://docs.hairoute.ai/docs/zh/api-reference/images/openai/generation.md): 创建图片生成请求，兼容 OpenAI Images 协议，支持多种尺寸、质量与输出格式
- [OpenAI 图片编辑接口](https://docs.hairoute.ai/docs/zh/api-reference/images/openai/edit.md): 编辑已有图片，兼容 OpenAI Images 协议，支持 Inpainting 局部重绘与 Outpainting 画面扩展
- [Seedream 图片生成接口](https://docs.hairoute.ai/docs/zh/api-reference/images/seedream/generation.md): 兼容 Seedream 官方协议的图片生成接口，支持文生图、图生图、组图与图层分解

#### 视频

- [通用视频生成接口](https://docs.hairoute.ai/docs/zh/api-reference/video/generation.md): 创建并查询视频生成任务，统一协议支持文生视频、图生视频、首尾帧与参考媒体输入
- [通用视频任务查询](https://docs.hairoute.ai/docs/zh/api-reference/video/generation-status.md): 查询通用视频生成任务的状态与生成结果
- [Seedance 视频生成接口](https://docs.hairoute.ai/docs/zh/api-reference/video/seedance.md): 兼容 Seedance 官方协议的视频生成接口，支持文生视频、图生视频、参考媒体与同步音频生成
- [Seedance 视频任务查询](https://docs.hairoute.ai/docs/zh/api-reference/video/seedance-status.md): 查询 Seedance 兼容视频任务的状态与生成结果
- [万相 2.7 视频生成接口](https://docs.hairoute.ai/docs/zh/api-reference/video/wan.md): 兼容阿里万相2.7协议的视频生成接口，支持文生视频、图生视频与视频编辑
- [万相 3.0 视频生成接口](https://docs.hairoute.ai/docs/zh/api-reference/video/wan3.md): 通过万相 3.0 All-in-One 模型生成、编辑和延长原生有声视频
- [万相查询视频任务](https://docs.hairoute.ai/docs/zh/api-reference/video/wan-status.md): 查询阿里万相兼容视频任务的状态与生成结果
- [HappyHorse 视频生成接口](https://docs.hairoute.ai/docs/zh/api-reference/video/happyHorse.md): 兼容 HappyHorse 1.1协议的视频生成接口，支持文生视频、图生视频与视频编辑
- [HappyHorse 视频任务查询](https://docs.hairoute.ai/docs/zh/api-reference/video/happy-horse-status.md): 查询 HappyHorse 兼容视频任务的状态与生成结果

## AI工具接入

- [Claude Code](https://docs.hairoute.ai/docs/zh/tools/claude-code.md): 通过 CC Switch 或直接配置 CLI 将 Claude Code 接入 HaiRoute
- [CodeX/ChatGPT](https://docs.hairoute.ai/docs/zh/tools/codex.md): 通过 CC Switch 将 Codex 桌面端接入 HaiRoute
- [Copilot](https://docs.hairoute.ai/docs/zh/tools/copilot.md): 通过 HaiRoute 接入 GitHub Copilot 相关工作流
- [Cursor](https://docs.hairoute.ai/docs/zh/tools/cursor.md): 通过 HaiRoute 网关接入 Cursor
- [DeepChat](https://docs.hairoute.ai/docs/zh/tools/deepchat.md): 通过 HaiRoute 网关接入 DeepChat
- [Open Code](https://docs.hairoute.ai/docs/zh/tools/open-code.md): 通过 HaiRoute 网关接入 Open Code
- [OpenClaw](https://docs.hairoute.ai/docs/zh/tools/openclaw.md): 通过 HaiRoute 网关接入 OpenClaw
- [Trae Work](https://docs.hairoute.ai/docs/zh/tools/trae-work.md): 通过 HaiRoute 网关接入 Trae Work
- [VS Code](https://docs.hairoute.ai/docs/zh/tools/vscode.md): 通过 BYOK 将 VS Code Copilot Chat 接入 HaiRoute
- [WorkBuddy](https://docs.hairoute.ai/docs/zh/tools/workbuddy.md): 通过 HaiRoute 网关接入 WorkBuddy
- [ZCode](https://docs.hairoute.ai/docs/zh/tools/zcode.md): 通过 HaiRoute 网关接入 ZCode

## 其它

- [速率限制](https://docs.hairoute.ai/docs/zh/others/rate-limits.md): 了解 HaiRoute API 的速率限制策略
- [VPN 与代理连接排障](https://docs.hairoute.ai/docs/zh/others/vpn-proxy.md): 排查使用 VPN、系统代理或 TUN 模式时无法连接 HaiRoute 的问题

## OpenAPI Specs

- [openapi](/docs/en/api-reference/chat/claude/openapi.json)
- [openapi](/docs/en/api-reference/chat/openai/openapi.json)
- [responses-openapi](/docs/en/api-reference/chat/responses/responses-openapi.json)
- [openapi](/docs/en/api-reference/images/openai/edit/openapi.json)
- [openapi](/docs/en/api-reference/images/openai/generation/openapi.json)
- [openapi](/docs/en/api-reference/images/seedream/generation/openapi.json)
- [openapi](/docs/en/api-reference/models/openapi.json)
- [openapi](/docs/en/api-reference/video/generation/openapi.json)
- [openapi](/docs/en/api-reference/video/happyHorse/openapi.json)
- [openapi](/docs/en/api-reference/video/seedance/openapi.json)
- [openapi](/docs/en/api-reference/video/wan/openapi.json)
- [openapi](/docs/en/api-reference/video/wan3/openapi.json)
- [openapi](/docs/zh/api-reference/chat/claude/openapi.json)
- [openapi](/docs/zh/api-reference/chat/openai/openapi.json)
- [responses-openapi](/docs/zh/api-reference/chat/responses/responses-openapi.json)
- [openapi](/docs/zh/api-reference/images/openai/edit/openapi.json)
- [openapi](/docs/zh/api-reference/images/openai/generation/openapi.json)
- [openapi](/docs/zh/api-reference/images/seedream/generation/openapi.json)
- [openapi](/docs/zh/api-reference/models/openapi.json)
- [openapi](/docs/zh/api-reference/video/generation/openapi.json)
- [openapi](/docs/zh/api-reference/video/happyHorse/openapi.json)
- [openapi](/docs/zh/api-reference/video/seedance/openapi.json)
- [openapi](/docs/zh/api-reference/video/wan/openapi.json)
- [openapi](/docs/zh/api-reference/video/wan3/openapi.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [English (31 pages)](https://docs.hairoute.ai/_llms/en.md): Documentation for English.