DOCUMENTATION / 接入
从获取凭证到第一次请求
接口形态与错误码口径保持稳定,切换模型只改一个字段。文档中的地址、密钥与模型标识均为占位示例。
静态示例 · 不提供在线调试
01 / QUICKSTART
快速开始
三步完成第一次调用:拿凭证、选模型、发请求。每一步都可以在本地环境完成,不需要在文档页申请任何权限。
- 01
获取凭证
在控制台创建应用并生成密钥。示例中的密钥为占位,正式密钥在商务开通后签发。
shellexport ZYY_API_KEY="your_api_key_placeholder" - 02
选择模型
按业务方向选择模型类别,请求体中的 model 字段填写对应标识,同一套请求结构保持一致。
json{ "model": "text-general"} - 03
发起请求
使用统一的基础地址调用,返回结构与错误码口径一致;切换模型时不需要改写业务侧代码。
httpPOST https://{your-endpoint}/v1/chat/completions
02 / API
接口与鉴权
所有请求走同一套 Bearer 鉴权,应用与模型类别的开通关系决定可用范围;错误码在整个平台上保持一致,便于统一重试与降级。
| 状态码 | 含义与处理 |
|---|---|
| 401 | 鉴权失败,检查密钥与应用绑定关系 |
| 403 | 当前应用未开通该模型类别 |
| 429 | 触发限流,按响应头建议退避重试 |
| 503 | 上游模型暂不可用,可切换同类模型重试 |
- 基础地址与密钥由商务开通后提供,文档不包含可用凭证。
- 模型路由与降级顺序在聚合层配置,业务侧不需要按供应商分别重试。
- 返回结构与错误码在切换模型时保持一致,字段差异以响应说明为准。
03 / SAMPLES
示例代码
同一段请求用三种语言表达,仅用于说明调用形态。地址与密钥为占位,替换后即可在你自己的环境运行。
sample / curl
curl https://{your-endpoint}/v1/chat/completions \ -H "Authorization: Bearer $ZYY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "text-general", "messages": [ { "role": "user", "content": "把这段合同条款提炼成三条要点" } ] }'示例代码,非在线调试;地址与密钥为占位
04 / FAQ