胜算云 胜算云 文档中心 ↗ 精益社区

API 参考总览

按调用目标和凭证类型选择企业管理接口或网关 AI 模型接口。

1. 先按调用目标选择接口

接口类型适用任务使用凭证开始位置
网关管理接口管理企业账号、项目角色、项目、统计和 BYOK按具体接口文档认证与签名
网关 AI 模型接口调用路由、文本向量化和聊天补全当前账号在当前项目中的项目 API Key聊天补全 / 文本向量化 / 路由调用
💡
需要注意

管理接口与模型接口的凭证作用域不同,不得混用。企业级网关注册接口不从目录分组推导凭证。

2. 网关管理接口

这 7 篇管理接口资料正在与当前后端契约核对,尚未完成真实联调;具体差异见各页顶部提示。需要手动操作时先使用对应控制台指南。

  • API 认证与签名方法 — 管理接口的公共请求头、签名算法、多语言实现、错误处理与安全建议。
  • RAM 用户管理 API — 创建、查询、编辑、重置密码和删除企业 RAM 用户。
  • 角色管理 API — 创建、查询、更新和删除项目角色及其权限与限额。
  • 项目管理 API — 项目、项目路由、项目模型和项目 API Key 的管理接口。
  • 统计查询 API — 总览、错误、请求、模型、费用、Token 和项目排名等统计接口。
  • BYOK 管理 API — 查询供应商,并创建、查看和编辑企业 BYOK 配置。
  • 企业级网关注册接口 — 注册企业网关实例的请求参数、响应结构和调用示例。

3. 网关 AI 模型接口

左侧“网关 AI 模型接口”目录包含以下现有文档:

  • 路由调用 — 使用路由策略 ID 调用模型,并理解三种调度模式和常见错误。
  • 文本向量化 — 将字符串或字符串数组转换为向量表示。
  • 聊天补全 — 使用项目模型或路由策略完成非流式、流式和工具调用。

4. 调用前检查

  • 确认选择的是企业管理任务还是项目内模型调用,并使用对应凭证。
  • 模型调用地址从当前项目复制;企业管理与统计接口使用对应接口文档指定的地址,不混用调用地址或重复追加版本路径。
  • 企业网关统一兼容包括 Chat Completions、Responses、Messages 在内的全部已开放大语言模型接口协议;当前左侧 API 参考页面只代表现有文档覆盖,不是网关能力边界。
  • 凭证写入安全环境变量或密钥管理服务,不提交到代码仓库和日志。
  • 保存请求标识,并在当前项目的调用日志或对应管理结果中核对调用结果。