开发者接入指南

OpenAI兼容 API
从环境变量到第一条请求

下面用一个最小可运行的请求说明接入思路。具体 Base URL、模型名、计费和限额,请以云祥API控制台的最新说明为准。

一、接入前准备

开始之前,准备好登录控制台中的三项信息:API Base URL、访问凭证和可用模型名。不要把访问凭证写进浏览器端、公开仓库或会被提交到版本控制的配置文件。

确认账号已经可以使用目标服务
从官网复制当前的 Base URL 和模型名
在服务端设置 `API_BASE` 与 `API_KEY` 环境变量

二、发送第一条请求

以下示例使用常见的聊天补全格式。把占位符替换为登录控制台中的实际值后,再在服务端执行。

quick-start.sh
curl "$API_BASE/v1/chat/completions" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-model",
    "messages": [
      {"role": "user", "content": "你好,云祥API"}
    ]
  }'
server-side request先验证,再接入业务

如果接口返回成功,再把同样的配置放进你的 SDK 或后端服务中。模型字段、流式响应、图像输入等能力,可能需要参考对应模型的独立说明。

三、常见错误排查

现象先检查
401 / 403API Key 是否复制完整、是否已启用、请求是否从服务端发出
404Base URL 是否重复拼接 `/v1`,路径是否与官网文档一致
模型不存在模型名是否使用控制台实时列表中的完整名称
响应为空请求体 JSON、Content-Type、超时和流式参数是否匹配
调用变慢模型上下文、请求长度和当前上游服务状态是否变化

四、API Key 安全建议

API Key 应当只出现在服务端或受控的运行环境中。生产项目建议使用环境变量或密钥管理服务,并为不同项目设置不同凭证;发现泄露后及时在登录控制台撤销并重新创建。

重要:不要把 Key 放在前端 JavaScript、公开的代码仓库、截图、日志或错误追踪事件里。
需要查看实时配置?登录控制台会展示当前可用模型和最新接入说明。
登录官网