接入地址与 Base URL
本平台对外只有一套接入域名。填客户端或 SDK 的 Base URL 时用下面这个值:
text
https://api.allyang.cn/v1
以控制台为准:如果控制台「API KEYS」页面上显示的 Base URL 与本文不一致,请先按控制台填写,并把差异反馈给文档维护人。
口径统一说明(重要)
整理源文档时,我们碰到两类域名问题,处理原则不同,不要混为一谈:
- 指本平台的地址:曾出现拼写错误,现已全站统一为
https://api.allyang.cn; - 第三方官方示例地址(源文档里以「官方 :」开头的那种):属于对照示例,语义上指向第三方,因此保留
https://api.openai.com/v1/chat/completions,不允许替换成本平台域名。
逐处对照清单随交付物归档,可回溯到每个文件的具体行号。
| 项目 | 结果 |
|---|---|
| 涉及范围 | 域名拼写错误的来源文档 1 篇,现已全站统一 |
| 修正总数 | 4 处(其中 3 处指向本平台,1 处为第三方官方示例) |
| 判定依据 | 平台实际域名为 api.allyang.cn;「官方」行语义为第三方示例(业务口径 2026-09-26 确认) |
正确写法对照
| 使用场景 | 应填写的值 |
|---|---|
| OpenAI SDK 的 base_url | https://api.allyang.cn/v1 |
| 拼接完整接口地址 | https://api.allyang.cn/v1/chat/completions |
| 只需要根地址 | https://api.allyang.cn |
| 第三方官方示例(对照用,保持原样) | https://api.openai.com/v1/chat/completions |
调用示例
bash
curl https://api.allyang.cn/v1/chat/completions \
--header "Authorization: Bearer <API-Key>" \
--header "Content-Type: application/json" \
--data '{"model":"<模型名>","messages":[{"role":"user","content":"你好"}]}'
密钥纪律:API Key 只在控制台生成与查看,务必只存放在服务端或密钥管理系统中,不要写进前端代码、不要提交进代码仓库、不要在文档或聊天里回显。
待确认事项
下面三条属于对外口径,需业务方确认后才能定稿,目前标记为待确认:
- 是否把
api.allyang.cn作为对外正式公布的 Base URL(域名拼写口径已于 2026-09-26 确认,公开口径尚待确认); - 统一路径前缀是否继续使用
/v1; - 源文档中出现的第三方示例地址,是保持原样还是加注说明(当前按「保持原样」处理)。