文档概览
UniAll Docs 是从当前 Apifox 文档范围中选定 API 和模型页面后整理出的开发者参考。来源菜单只作为内容清单使用,新站点会统一名称、路由、示例和页面结构,让文档呈现为一个完整的 UniAll 产品文档体系。
当前公开文档会保持收敛,只覆盖已确认范围内的余额、模型列表、图像、视频、语音音乐和数字人页面。独立的快速开始、认证说明、完整计费政策、错误码全集、更新日志和自动生成 API Reference 不属于本阶段。
当前包含的文档
| 范围 | 当前页面 | 主要用途 |
|---|---|---|
| 账户 | 查询余额 | 在提交任务前确认账户和 API Key 额度。 |
| 模型索引 | 模型列表 | 按能力组织模型文档,并说明模型列表接口。 |
| 图像生成 | 通用异步图像生成、Seedream、GPT-Image-2、Nano 系列 | 按模型页面选择异步任务或同步图像接口。 |
| 视频生成 | Happy-Horse、Seedance 2.0、Grok Imagine、Veo 3.1、Vidu、Kling、Wan 2.6、Sora 2 | 提交视频任务、查询状态并获取完成后的视频。 |
| 语音与音乐 | 音乐生成、语音合成 | 使用模型专属字段生成音乐或语音。 |
| 数字人 | 数字人口播 | 生成数字人口播视频。 |
API 风格
大多数模型页面使用任务流程:
- 使用
Authorization: Bearer sk-***提交任务。 - 保存返回的任务 ID。
- 每 2 到 5 秒轮询任务状态。
- 当任务进入
succeeded、completed或failed等终态时停止轮询。 - 使用返回的结果 URL 或内容接口下载最终资产。
余额和模型列表属于同步 API 概念页,会立即返回结果,不需要轮询。
通用约定
| 约定 | 规则 |
|---|---|
| Base URL | 示例使用 {BASE_URL} 作为占位符。 |
| 认证 | 除非页面说明兼容格式专属 Header,否则使用 Authorization: Bearer sk-***。 |
| 请求示例 | 优先使用 curl。 |
| 模型 ID | JSON 中使用精确模型 ID,例如 grok-imagine 和 gpt-image-2。 |
| 结果 URL | 返回的 URL 视为生成资产,除非产品协议另有说明,不应默认永久有效。 |
| 计费 | 页面内说明影响费用的维度,精确价格以当前产品价格页为准。 |
语言和 AI 可读文档
英文是默认语言,路径为 /。中文路径为 /zh-CN/。代码示例、JSON key、接口路径和模型 ID 在两种语言中保持一致。
站点同时发布 AI 可读索引:
当 agent 或外部 AI 工具需要快速理解当前文档范围时,可以使用这两个文件。