切换深色模式
接入参数与 cURL
本页使用 OpenAI 兼容的 Chat Completions 接口,演示一次非流式文本请求。使用前,请确认选定模型支持该接口。
三项必填信息
| 参数 | 示例 | 从哪里获取 |
|---|---|---|
| Base URL | https://api.example.com/v1 | 本站控制台或站点公告 |
| API Key | your-api-key | 令牌管理页面 |
| 模型 ID | your-model-id | 本站模型列表或价格页面 |
示例中的值都是占位内容,请替换后再执行。调用可能产生费用,以本站价格和实际消耗为准。
准备终端环境
以下命令适用于 macOS、Linux 的 Bash 或 Zsh。先在当前终端设置两个变量:
bash
export NEW_API_BASE_URL='https://api.example.com/v1'
export NEW_API_KEY='your-api-key'上面的写法用于说明变量名称。日常使用请通过自己可信的密钥管理方式注入令牌,避免将完整令牌写入共享脚本或提交到仓库。
查询模型列表
bash
curl --fail-with-body --silent --show-error \
"$NEW_API_BASE_URL/models" \
-H "Authorization: Bearer $NEW_API_KEY"成功响应通常包含 data 数组,其中每项的 id 为模型 ID。选择前仍需确认该模型支持接下来使用的聊天接口。
发送第一次聊天请求
请求示例
将 JSON 中的 your-model-id 替换为真实模型 ID:
bash
curl --fail-with-body --silent --show-error \
"$NEW_API_BASE_URL/chat/completions" \
-H "Authorization: Bearer $NEW_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"model": "your-model-id",
"messages": [
{ "role": "user", "content": "你好,请用一句话介绍自己。" }
],
"stream": false
}'参数说明
| 参数 | 含义 |
|---|---|
model | 本次调用使用的模型 ID |
messages | 传给模型的消息列表 |
role: user | 表示这是一条用户消息 |
content | 用户发送的文本 |
stream: false | 等待本次响应完成后返回 JSON |
如何读取响应
普通文本回复通常可以从 choices[0].message.content 读取。下面是简化后的响应结构,具体字段取决于模型和接口实现:
json
{
"choices": [
{
"message": {
"role": "assistant",
"content": "你好,我可以帮助你回答问题和整理信息。"
},
"finish_reason": "stop"
}
]
}如果没有文本内容,检查模型是否返回工具调用或其他类型的数据,不要仅凭空字符串判断接口故障。
尝试流式输出
将 stream 改为 true,并给 cURL 加上 -N 以关闭输出缓冲:
bash
curl -N --fail-with-body --silent --show-error \
"$NEW_API_BASE_URL/chat/completions" \
-H "Authorization: Bearer $NEW_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"model": "your-model-id",
"messages": [
{ "role": "user", "content": "请写一句简短的问候。" }
],
"stream": true
}'流式响应通常是 SSE 数据片段,不是单个 JSON 对象。支持该格式的客户端会将片段组合显示。
请求失败时
先查看 HTTP 状态码和返回的错误内容,再检查地址、令牌、模型和余额。状态码不能独立说明全部原因,详细处理见错误排查。
需要在程序中接入时,可继续阅读 Python 示例或 Node.js 示例。