# Nusabase API Docs

> Nusabase backend API, relay API, and deployment documentation.

## 指南

### 快速开始

- [模型与价格](https://evo-0136956d.mintlify.app/zh/getting-started/pricing.md): 人民币计价的模型价格速查：文本、图像、视频、全模态、语音和第三方开源模型。
- [计费规则](https://evo-0136956d.mintlify.app/zh/getting-started/billing-rules.md): API 聚合平台的五类计费规则：按量、按次、按时长、清晰度和阶梯。
- [错误码](https://evo-0136956d.mintlify.app/zh/getting-started/error-codes.md): API 调用失败时的响应格式、HTTP 状态码、平台错误码和处理建议。

### Agent 接入指南

- [Agent 接入总览](https://evo-0136956d.mintlify.app/zh/guides/agent-integrations.md): Claude Code、GitHub Copilot、OpenCode、OpenClaw 等 Agent 工具的 Nusabase API 接入入口页。
- [接入 Claude Code](https://evo-0136956d.mintlify.app/zh/guides/agent-integrations-claude-code.md): 通过 Nusabase Anthropic Messages 兼容接口配置 Claude Code。
- [接入 GitHub Copilot](https://evo-0136956d.mintlify.app/zh/guides/agent-integrations-github-copilot.md): 在 VS Code 的 GitHub Copilot 工作流中接入 Nusabase API 的可行方式、限制和验证步骤。
- [接入 GitHub Copilot CLI](https://evo-0136956d.mintlify.app/zh/guides/agent-integrations-github-copilot-cli.md): 通过 Copilot CLI BYOK 环境变量接入 Nusabase OpenAI 兼容接口。
- [接入 Kilo Code](https://evo-0136956d.mintlify.app/zh/guides/agent-integrations-kilo-code.md): 通过 Kilo Code 的 OpenAI 兼容或自定义 Provider 接入 Nusabase API。
- [接入 WorkBuddy/CodeBuddy](https://evo-0136956d.mintlify.app/zh/guides/agent-integrations-workbuddy-codebuddy.md): 通过本地 models.json 配置 WorkBuddy/CodeBuddy 的 Nusabase OpenAI 兼容模型。
- [接入 OpenCode](https://evo-0136956d.mintlify.app/zh/guides/agent-integrations-opencode.md): 使用 OpenCode 自定义 provider 接入 Nusabase OpenAI 兼容接口。
- [接入 OpenClaw](https://evo-0136956d.mintlify.app/zh/guides/agent-integrations-openclaw.md): 使用 OpenClaw 自定义模型 Provider 接入 Nusabase API。
- [接入 Hermes](https://evo-0136956d.mintlify.app/zh/guides/agent-integrations-hermes.md): 通过 Hermes Agent 的模型配置接入 Nusabase API。
- [接入 CC Switch](https://evo-0136956d.mintlify.app/zh/guides/agent-integrations-ccswitch.md): 通过 CC Switch 图形界面为 Claude Code、Codex、OpenCode 等 AI 编程工具配置 Nusabase API。

## API 参考

### 入口说明

- [快速开始](https://evo-0136956d.mintlify.app/zh/getting-started/overview.md): 从准备 API Key 到完成第一条模型调用的推荐接入顺序。
- [认证](https://evo-0136956d.mintlify.app/zh/getting-started/authentication.md): 对外 API 的认证方式、兼容请求头和常见认证失败原因。
- [首个请求示例](https://evo-0136956d.mintlify.app/zh/getting-started/first-request.md): 从模型列表到第一条 Chat Completions 请求，按真实接口完成一次最小可用调用。
- [兼容格式](https://evo-0136956d.mintlify.app/zh/getting-started/compatibility.md): 基于真实接口说明 Claude、Gemini 与其他兼容调用方式。

### AI 调用接口

#### Models

- [获取模型列表](https://evo-0136956d.mintlify.app/api-reference/models/获取模型列表.md): 获取当前可用的模型列表。
- [Gemini 格式获取](https://evo-0136956d.mintlify.app/api-reference/models/gemini-格式获取.md): 以 Gemini API 格式返回可用模型列表
- [Get model detail](https://evo-0136956d.mintlify.app/api-reference/models/get-model-detail.md): Get model details by model ID in OpenAI-compatible format.
- [List models (OpenAI-compatible in v1beta)](https://evo-0136956d.mintlify.app/api-reference/models/list-models-openai-compatible-in-v1beta.md): Return model list in OpenAI-compatible format under the v1beta prefix.

#### Chat

- [创建聊天对话](https://evo-0136956d.mintlify.app/api-reference/chat/创建聊天对话.md): 根据对话历史创建模型响应。支持流式和非流式响应。
- [创建文本补全](https://evo-0136956d.mintlify.app/api-reference/chat/创建文本补全.md): 基于给定提示创建文本补全

#### Responses

- [创建响应 (OpenAI Responses API)](https://evo-0136956d.mintlify.app/api-reference/responses/创建响应-openai-responses-api.md): OpenAI Responses API，用于创建模型响应。 支持多轮对话、工具调用、推理等功能。
- [压缩对话 (OpenAI Responses API)](https://evo-0136956d.mintlify.app/api-reference/responses/压缩对话-openai-responses-api.md): OpenAI Responses API，用于对长对话进行 compaction。

#### Images

- [创建图片生成任务](https://evo-0136956d.mintlify.app/api-reference/images/创建图片生成任务.md): 提交异步图片生成任务。支持 OpenAI 兼容格式（DALL-E）以及各厂商原生格式。
- [编辑图像(qwen-image-edit)](https://evo-0136956d.mintlify.app/api-reference/images/编辑图像qwen-image-edit.md): 百炼qwen-image系列图片生成
- [Get image generation task status](https://evo-0136956d.mintlify.app/api-reference/images/get-image-generation-task-status.md): Query the status of an asynchronous image generation task.
- [Edit image (compat endpoint)](https://evo-0136956d.mintlify.app/api-reference/images/edit-image-compat-endpoint.md): Compatibility endpoint for image editing. Behavior is the same as /v1/images/edits.
- [创建 Genbo 图片生成任务](https://evo-0136956d.mintlify.app/api-reference/images/创建-genbo-图片生成任务.md): 提交 Genbo 异步图片生成任务。
- [获取 Genbo 图片生成任务状态](https://evo-0136956d.mintlify.app/api-reference/images/获取-genbo-图片生成任务状态.md): 查询 Genbo 异步图片生成任务的状态。

#### Video

- [创建视频 ](https://evo-0136956d.mintlify.app/api-reference/video/创建视频.md): OpenAI Sora 兼容的视频生成接口。
- [获取视频任务状态 ](https://evo-0136956d.mintlify.app/api-reference/video/获取视频任务状态.md): OpenAI 兼容的视频任务状态查询接口。
- [获取视频内容](https://evo-0136956d.mintlify.app/api-reference/video/获取视频内容.md): 获取已完成视频任务的视频文件内容。
- [创建视频生成任务](https://evo-0136956d.mintlify.app/api-reference/video/创建视频生成任务.md): 提交视频生成任务（通用格式）。
- [获取视频生成任务状态](https://evo-0136956d.mintlify.app/api-reference/video/获取视频生成任务状态.md): 查询视频生成任务的状态和结果。
- [Remix video](https://evo-0136956d.mintlify.app/api-reference/video/remix-video.md): Create a remix task based on an existing video task.

#### Video / Kling

- [Kling 文生视频](https://evo-0136956d.mintlify.app/api-reference/video-kling/kling-文生视频.md): 使用 Kling 模型从文本描述生成视频。
- [获取 Kling 文生视频任务状态](https://evo-0136956d.mintlify.app/api-reference/video-kling/获取-kling-文生视频任务状态.md): 查询 Kling 文生视频任务的状态和结果。
- [Kling 图生视频](https://evo-0136956d.mintlify.app/api-reference/video-kling/kling-图生视频.md): 使用 Kling 模型从图片生成视频。
- [获取 Kling 图生视频任务状态](https://evo-0136956d.mintlify.app/api-reference/video-kling/获取-kling-图生视频任务状态.md): 查询 Kling 图生视频任务的状态和结果。

#### Video / Jimeng

- [即梦视频生成](https://evo-0136956d.mintlify.app/api-reference/video-jimeng/即梦视频生成.md): 即梦官方 API 格式的视频生成接口。

#### Claude

- [Claude 聊天](https://evo-0136956d.mintlify.app/api-reference/claude/claude-聊天.md): Anthropic Claude Messages API 格式的请求。 需要在请求头中包含 `anthropic-version`。

#### Gemini

- [Gemini 嵌入(Embeddings)](https://evo-0136956d.mintlify.app/api-reference/gemini/gemini-嵌入embeddings.md): 使用指定引擎/模型创建嵌入
- [Gemini 原生 API（/v1 前缀）](https://evo-0136956d.mintlify.app/api-reference/gemini/gemini-原生-api（v1-前缀）.md): Gemini 原生 API 接口（通过 /v1 前缀访问）。/v1/models/ 之后的路径直接透传（如 gemini-2.0-flash:generateContent）。
- [Gemini 原生 API（通配路径）](https://evo-0136956d.mintlify.app/api-reference/gemini/gemini-原生-api（通配路径）.md): Gemini 原生 API 接口。/v1beta/models/ 之后的路径直接透传（如 gemini-2.0-flash:generateContent、gemini-2.0-flash:streamGenerateContent）。

#### Embeddings

- [创建文本嵌入](https://evo-0136956d.mintlify.app/api-reference/embeddings/创建文本嵌入.md): 将文本转换为向量嵌入

#### Audio

- [音频转录](https://evo-0136956d.mintlify.app/api-reference/audio/音频转录.md): 将音频转换为文本
- [音频翻译](https://evo-0136956d.mintlify.app/api-reference/audio/音频翻译.md): 将音频翻译为英文文本
- [文本转语音](https://evo-0136956d.mintlify.app/api-reference/audio/文本转语音.md): 将文本转换为音频

#### Rerank

- [文档重排序](https://evo-0136956d.mintlify.app/api-reference/rerank/文档重排序.md): 根据查询对文档列表进行相关性重排序

#### Moderations

- [内容审核](https://evo-0136956d.mintlify.app/api-reference/moderations/内容审核.md): 检查文本内容是否违反使用政策

#### Realtime

- [实时 WebSocket 连接](https://evo-0136956d.mintlify.app/api-reference/realtime/实时-websocket-连接.md): 建立 WebSocket 连接用于实时对话。

#### Not Implemented

- [列出微调任务 (未实现)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/列出微调任务-未实现.md): 此接口尚未实现
- [创建微调任务 (未实现)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/创建微调任务-未实现.md): 此接口尚未实现
- [获取微调任务详情 (未实现)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/获取微调任务详情-未实现.md): 此接口尚未实现
- [取消微调任务 (未实现)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/取消微调任务-未实现.md): 此接口尚未实现
- [获取微调任务事件 (未实现)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/获取微调任务事件-未实现.md): 此接口尚未实现
- [列出文件 (未实现)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/列出文件-未实现.md): 此接口尚未实现
- [上传文件 (未实现)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/上传文件-未实现.md): 此接口尚未实现
- [获取文件信息 (未实现)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/获取文件信息-未实现.md): 此接口尚未实现
- [删除文件 (未实现)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/删除文件-未实现.md): 此接口尚未实现
- [获取文件内容 (未实现)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/获取文件内容-未实现.md): 此接口尚未实现
- [删除模型（未实现）](https://evo-0136956d.mintlify.app/api-reference/not-implemented/删除模型（未实现）.md): 此接口暂未实现。
- [Image variations (not implemented)](https://evo-0136956d.mintlify.app/api-reference/not-implemented/image-variations-not-implemented.md): This endpoint is currently not implemented.

## OpenAPI Specs

- [relay-api.mintlify](/zh/openapi/relay-api.mintlify.json)

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

## Indexes

- [English (52 pages)](https://evo-0136956d.mintlify.app/_llms/en.txt): Documentation for English.


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