利用ガイドAPIリファレンスAIアプリケーション

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": "Hello, 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 互換プロトコル | OpenRely Docs