Skip to content

小雅开放平台开发文档 ​

本文档说明第三方智能体和企业应用如何通过 OAuth 2.0 接入小雅开放平台,读取 Personal 或 Team 上下文、调用可用模型,并使用小雅积分完成业务结算。

文档目录 ​

  • 快速开始:登记、授权码交换、模型目录查询和第一次模型调用。
  • OAuth 2.0:授权、Token 交换与撤销、Scope、生命周期和服务端安全。
  • 积分与计费:查询余额、扣积分、退积分、用量,以及 Personal/Team 的 curl 和 Node.js 示例。
  • 模型目录与调用:获取真实可用模型并调用统一模型网关。
  • XiaoyaHub 实时接口:按后台开放策略实时展示 TikHub 与 MiniMax H3 接口及积分费用。
  • Team 上下文:Team Token、成员配额、工作流 Header 和当前非流式限制。
  • 智能体开发规范:MCP/网页型智能体、工具 Schema、异步 callback、Artifact 和发布检查。
  • 完整 API 参考:所有外部开发者可调用接口的参数、请求体和响应 Schema。
  • 安装开发 Skill:下载供编码 AI 离线使用的模板、校验器和接口合同。
  • 让 AI 读取文档:llms.txt、完整上下文和 OpenAPI 入口。

接口边界 ​

公开合同覆盖 OAuth、Personal、Team、模型网关、运行时资产、执行授权、云沙箱和 MCP callback/introspection。运营后台、桌面内部接口与官网私有 BFF 不属于开发者 API。

OAuth Access Token、Client Secret、授权码和 Team 工作流上下文只能由可信服务端处理,不得进入浏览器存储、AI Prompt、URL 或日志。

OAuth credentials and model-provider secrets must remain on trusted servers.