# APIONE AI

> APIONE 开发者文档：API 接入、模型调用、计费与客户端集成。 / API setup, models, billing, and integrations.

## 文档

### 开始使用

- [APIONE 开发者文档](https://apione.ai/docs/index.md): 从第一次请求到客户端集成，查找接入、模型与计费说明。
- [快速开始](https://apione.ai/docs/quickstart.md): 设置密钥与模型，查询权限并完成第一次对话请求。
- [创建与保护 API Key](https://apione.ai/docs/getting-started/api-keys.md): 创建调用凭证，隔离应用并安全轮换密钥。
- [选择接入协议](https://apione.ai/docs/getting-started/protocol-selection.md): 按现有 SDK、工具和模型能力选择 OpenAI、Anthropic 或 Gemini 协议。
- [查询与选择模型](https://apione.ai/docs/models/catalog.md): 查询当前密钥可用模型，确认 ID、能力和参数。
- [按场景选择模型](https://apione.ai/docs/models/selection.md): 根据任务、质量、速度、上下文和成本选择模型，而不是固定推荐单一型号。

### 账户与计费

- [用量、费用与限流](https://apione.ai/docs/account/usage.md): 了解分组定价与 Token 计费，查看用量并管理并发。
- [分组、价格与实际扣费](https://apione.ai/docs/account/pricing-groups.md): 理解模型标价、API Key 分组倍率、用量和最终费用的关系。
- [积分与邀请奖励](https://apione.ai/docs/account/rewards.md): 了解消费积分、邀请返利、首充奖励及兑换规则。

### 问题排查与支持

- [错误码与排查](https://apione.ai/docs/support/errors.md): 按状态码、错误类型与请求 ID 排查调用失败。
- [网络、代理与连接排查](https://apione.ai/docs/support/network-proxy.md): 按网络、地址、鉴权、模型和请求体的顺序定位连接失败。
- [常见问题](https://apione.ai/docs/support/faq.md): 解答接入地址、模型、客户端、数据与费用疑问。
- [联系支持与提交反馈](https://apione.ai/docs/support/contact.md): 准备脱敏诊断信息，通过官方渠道反馈接口与账户问题。

## API 参考

### 地址与鉴权

- [API 地址与鉴权](https://apione.ai/docs/api/overview.md): 按协议选择 SDK 基础地址、完整端点和鉴权头。
- [接口端点总览](https://apione.ai/docs/api/endpoints.md): 查看 APIONE 支持的协议地址、模型查询、图像和视频端点。
- [请求跟踪、超时与重试](https://apione.ai/docs/api/request-reliability.md): 使用请求 ID 定位问题，并为超时、限流和上游波动设置安全重试。

### 模型接口

- [Chat Completions 接口](https://apione.ai/docs/models/chat.md): 理解对话请求、返回正文、结束原因与用量。
- [Responses 接入](https://apione.ai/docs/api/responses.md): 使用 OpenAI Responses 格式发送文本请求。
- [Anthropic 兼容接入](https://apione.ai/docs/api/anthropic.md): 使用 Anthropic SDK 或 HTTP Messages 接口调用 APIONE。
- [Gemini 原生协议接入](https://apione.ai/docs/api/gemini.md): 使用 generateContent 请求格式调用 APIONE。
- [查询模型参数](https://apione.ai/docs/models/parameters.md): 使用参数接口确认模型能力、请求字段和计费维度。

### 输出与进阶用法

- [流式输出与中断处理](https://apione.ai/docs/models/streaming.md): 接收 SSE 增量，正确处理空分片和生成中断。
- [结构化输出与工具调用](https://apione.ai/docs/models/advanced.md): 按模型能力使用 JSON 输出和工具调用，并验证业务结果。
- [工具调用](https://apione.ai/docs/api/tool-calls.md): 定义工具、执行函数并将结果安全返回给模型。
- [结构化输出](https://apione.ai/docs/api/structured-output.md): 让模型返回可验证的 JSON，并处理不完整或不合格结果。
- [多模态输入](https://apione.ai/docs/api/multimodal-input.md): 在模型支持时发送图片等非文本输入，并控制大小、格式和隐私风险。

### 图像 API

- [图像生成](https://apione.ai/docs/api/images-generations.md): 通过统一图像端点提交提示词，并按模型参数读取生成结果。
- [图像编辑](https://apione.ai/docs/api/images-edits.md): 使用参考图和编辑提示词调用图像编辑端点。

### 视频 API

- [视频生成任务](https://apione.ai/docs/api/videos.md): 创建异步视频任务，轮询状态并读取生成结果。
- [图像与视频参数](https://apione.ai/docs/api/media-parameters.md): 通过模型参数接口确认尺寸、时长、画幅、分辨率和输出格式。

## 工具集成

### 接入指南

- [客户端与工具集成](https://apione.ai/docs/guides/clients.md): 选择你的客户端，按 APIONE 专用教程配置密钥、接口和模型。
- [Python 与 Node.js SDK 接入](https://apione.ai/docs/guides/sdks.md): 通过 OpenAI SDK 在服务端调用 APIONE。
- [迁移已有 OpenAI 兼容应用](https://apione.ai/docs/guides/migration.md): 更换地址、凭证和模型，分阶段验证兼容性。

### 编程助手与命令行

- [CC-Switch 接入 APIONE](https://apione.ai/docs/guides/cc-switch.md): 在图形界面中保存 APIONE 配置，按工具切换供应商。
- [Claude Code 接入 APIONE](https://apione.ai/docs/guides/claude-code.md): 设置 Anthropic 兼容地址，在终端与 VS Code 中使用 APIONE。
- [Claude Desktop 接入 APIONE](https://apione.ai/docs/guides/claude-desktop.md): 通过第三方推理 Gateway 配置 APIONE 的 Messages 接口。
- [Cline 接入 APIONE](https://apione.ai/docs/guides/cline.md): 在编辑器中配置 OpenAI Compatible 模型服务。
- [Codex CLI 与桌面端接入 APIONE](https://apione.ai/docs/guides/codex.md): 通过自定义 Responses Provider 配置 APIONE。
- [Cursor 接入 APIONE](https://apione.ai/docs/guides/cursor.md): 设置自定义 OpenAI 地址并验证聊天模型。
- [DeepSeek Harness 接入 APIONE](https://apione.ai/docs/guides/deepseek-harness.md): 以 API Key 和自定义基础地址配置 DSH。
- [Gemini CLI 接入 APIONE](https://apione.ai/docs/guides/gemini-cli.md): 使用 Gemini 兼容接口，在命令行中调用 APIONE 模型。
- [VS Code 与 GitHub Copilot 接入 APIONE](https://apione.ai/docs/guides/github-copilot.md): 通过 VS Code 的自定义模型端点配置 APIONE。
- [Hermes Agent 接入 APIONE](https://apione.ai/docs/guides/hermes-agent.md): 以自定义 OpenAI 兼容端点配置 Hermes Agent。
- [Neovate Code 接入 APIONE](https://apione.ai/docs/guides/neovate-code.md): 配置自定义提供商，在 Neovate Code 中使用 APIONE。
- [OpenCode 接入 APIONE](https://apione.ai/docs/guides/opencode.md): 使用 OpenAI 兼容提供商连接 APIONE。
- [Pi Coding Agent 接入 APIONE](https://apione.ai/docs/guides/pi-coding-agent.md): 使用自定义 Provider 和 API Key 配置 Pi。

### 聊天与工作流

- [Cherry Studio 接入 APIONE](https://apione.ai/docs/guides/cherry-studio.md): 添加 OpenAI 兼容服务，在桌面端选择 APIONE 模型聊天。
- [Dify 接入 APIONE](https://apione.ai/docs/guides/dify.md): 为工作区添加模型，在 Chatbot 与工作流中调用 APIONE。
- [Obsidian Copilot 接入 APIONE](https://apione.ai/docs/guides/obsidian.md): 在笔记工作区中配置 APIONE 聊天模型。
- [Open WebUI 接入 APIONE](https://apione.ai/docs/guides/open-webui.md): 通过管理员连接设置添加 APIONE 模型。
- [RikkaHub 接入 APIONE](https://apione.ai/docs/guides/rikkahub.md): 在 Android 聊天客户端中添加 APIONE 服务商。
- [Sider 接入 APIONE](https://apione.ai/docs/guides/sider.md): 在支持自定义 API 的 Sider 版本中使用 APIONE。

### Agent 部署

- [OpenClaw 接入 APIONE](https://apione.ai/docs/guides/openclaw.md): 为 OpenClaw 添加 APIONE 自定义模型提供商。
- [阿里云部署 OpenClaw 并接入 APIONE](https://apione.ai/docs/guides/openclaw-alibaba.md): 先验证服务器上的模型连接，再接入网关与消息渠道。

### 网络与认证

- [不同网络环境下连接 APIONE](https://apione.ai/docs/guides/network-environments.md): 排查本机、代理、容器和远程服务中的连接问题。
- [API Key 与 OAuth PKCE](https://apione.ai/docs/guides/oauth-pkce.md): 了解 APIONE 当前认证方式与 OAuth 集成的边界。

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

## Indexes

- [English (56 pages)](https://apione.ai/docs/_llms/en.txt): Documentation, API reference, Integrations.


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