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"

OpenAI 相容協議

目錄