OpenAI 兼容协议
了解如何通过 OpenAI 标准协议（包括 /v1/chat/completions 与 /v1/responses）将第三方客户端、CLI、脚本及官方 SDK 接入 OpenRely。
协议概述
OpenRely API 原生完整兼容 OpenAI 官方 API 协议规范。90% 以上的桌面客户端（如 Chatbox、NextChat、Cherry Studio）、终端工具以及主流开发库（LangChain、LlamaIndex 等）均默认采用此协议。
通过 OpenAI 协议，您不仅可以调度 GPT 系列模型，还可以跨模型调用 Claude、Gemini 等全部主流模型，无需适配不同厂商的数据结构。
📌 核心连接规范
| 参数项 | 标准填写值 | 说明 |
|---|---|---|
| API 服务地址 (Base URL) | https://api.openrely.ai/v1 | 客户端若会自动追加 /v1，则填 https://api.openrely.ai |
| 鉴权请求头 (Headers) | Authorization: Bearer sk-•••• | 填入您的 OpenRely API Key |
| 数据格式 | Content-Type: application/json | 标准 JSON 请求与响应体 |
⚡ 核心端点与请求示例
1. 聊天补全 (Chat Completions)
最经典、支持最广泛的对话端点，兼容多轮对话、流式输出与函数调用（Tool Call）。
- 端点：
POST /v1/chat/completions - 完整 URL：
https://api.openrely.ai/v1/chat/completions
请求示例 (Request)
curl -X POST "https://api.openrely.ai/v1/chat/completions" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-••••" \
-d '{
"model": "gpt",
"messages": [
{ "role": "user", "content": "Hello OpenRely!" }
]
}'响应示例 (Response)
{
"id": "chatcmpl-9xyz...",
"object": "chat.completion",
"created": 1725890000,
"model": "gpt",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Hello! How can I help you today?"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 10,
"completion_tokens": 9,
"total_tokens": 19
}
}2. 新一代响应流 (Responses API)
OpenAI 推出的全新一代 Responses 端点（例如部分新型智能体或 Codex 体系所使用）。
- 端点：
POST /v1/responses - 完整 URL：
https://api.openrely.ai/v1/responses
请求示例 (Request)
curl -X POST "https://api.openrely.ai/v1/responses" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-••••" \
-d '{
"model": "gpt",
"input": "Analyze current system latency"
}'响应示例 (Response)
{
"id": "resp-01ab...",
"object": "response",
"created": 1725890100,
"model": "gpt",
"output": [
{
"type": "output_text",
"text": "Response workflow ready."
}
],
"usage": {
"input_tokens": 12,
"output_tokens": 19,
"total_tokens": 31
}
}🛠️ 客户端与 SDK 快速集成
from openai import OpenAI
client = OpenAI(
base_url="https://api.openrely.ai/v1",
api_key="sk-your-openrely-key",
)
response = client.chat.completions.create(
model="gpt",
messages=[{"role": "user", "content": "你好，OpenRely！"}],
)
print(response.choices[0].message.content)import OpenAI from 'openai';
const client = new OpenAI({
baseURL: 'https://api.openrely.ai/v1',
apiKey: 'sk-your-openrely-key',
});
const completion = await client.chat.completions.create({
model: 'gpt',
messages: [{ role: 'user', content: 'Hello!' }],
});
console.log(completion.choices[0].message.content);对于遵循标准 OpenAI 环境变量规范的 CLI 智能体与脚本，直接导出变量即可：
export OPENAI_BASE_URL="https://api.openrely.ai/v1"
export OPENAI_API_KEY="sk-your-openrely-key"这篇文档对您有帮助吗？