API 文档浏览
功能概述
API 文档浏览器是无量AI开放平台控制台内置的接口文档查阅工具，提供完整的 API 参考信息。通过三栏布局，您可以高效地浏览和查阅所有 API 接口的详细文档，包括：
- 接口总览和分类浏览
- 完整的接口参数说明
- 请求体和响应体的数据结构
- 各接口的错误码定义
- 全局错误码参考
前提条件
- 已登录控制台
操作步骤
进入 API 文档浏览器
在左侧导航栏中，点击 资源 分组下的 API 文档 菜单。
进入 API 文档浏览器页面，页面采用三栏布局。
了解页面布局
API 文档浏览器采用三栏布局，各栏功能如下：
左栏 - 接口树
以树形结构展示所有 API 接口，按能力类型分组：
- 文本生成
- 图像生成
- 向量嵌入
- 语音合成
- 语音识别
- Web 搜索
点击分组节点可展开/收起该分组下的接口列表。
右上方栏 - 功能标签页
提供以下标签页：
| 标签页 | 说明 |
|---|---|
| 总览 | 展示所有 API 能力的概要摘要 |
| 错误码 | 展示全局错误码列表，按 HTTP 状态码分类 |
| 接口详情 | 展示选中接口的完整文档（选中接口后自动切换到此标签） |
右下方栏 - 文档内容
根据当前选中的标签页和接口，展示对应的文档内容。
浏览 API 总览
页面默认展示 总览 标签页，汇总展示所有 API 能力的概要信息。
总览页面以卡片形式展示各能力类型，包括接口数量、核心功能说明等。
查看全局错误码
点击 错误码 标签页。
错误码按 HTTP 状态码分类展示：
HTTP 状态码 含义 400 请求参数错误 401 认证失败（API Key 无效或缺失） 403 权限不足（Key 无对应能力或模型权限） 429 请求频率超限 500 服务端内部错误 
每个错误码条目包含以下信息：
- 错误码：具体的错误代码
- 错误信息：错误描述
- 说明：错误原因和可能的解决方案
查看接口详细文档
在左侧接口树中，展开目标分组，点击具体的接口名称。
右侧自动切换到 接口详情 标签，展示该接口的完整文档。
接口详情包含以下内容板块：
接口基本信息
- 接口名称和描述
- 请求方法（POST / GET）
- 请求路径（如
/v1/chat/completions）
请求参数
以表格形式列出所有请求参数，包含：
字段 说明 参数名 参数的路径和名称 类型 参数的数据类型（string, integer, boolean, array, object） 必填 是否为必填参数 默认值 参数的默认值（如有） 说明 参数的详细描述和取值范围 
请求体结构
展示请求体的 JSON 数据结构，包括嵌套对象的字段说明。
响应体结构
展示成功响应的 JSON 数据结构和字段说明。
接口错误码
展示该接口特有的错误码列表，包含错误代码、错误信息和解决建议。
注意事项
- API 文档浏览器中的内容与平台实际的 API 行为保持同步，如发现不一致请及时反馈。
- 接口文档中的示例数据仅作参考，实际响应内容取决于模型和参数配置。
- 部分接口可能处于 Beta 或预览状态，其参数和行为可能在未来版本中发生变化。
- 建议结合 Playground 工具进行实际测试，以更好地理解接口行为。
相关文档
- 发起 API 调用 - 使用代码调用 API 的完整指南
- 使用 Playground 测试 - 交互式测试 API 接口
- 模型列表与定价 - 浏览可用模型