メインコンテンツまでスキップ

OpenAI 互換 API

プラットフォームのモデル推論 API は OpenAI API と互換性があります。これは次のことを意味します:

  • 既存コードの変更はほぼゼロ:base_urlapi_key を置き換えるだけで、OpenAI を呼び出していたアプリケーションをプラットフォームのエンドポイントに切り替えられます。
  • OpenAI 公式 SDK をそのまま使用可能:Python、JavaScript エコシステムの既存ツールチェーンをそのまま利用でき、専用 SDK のインストールは不要です。
  • 公開エンドポイントとプライベートエンドポイントの呼び出し方法は同一:どちらも同じ API 規約に従い、違いは Base URL とモデル名だけです。

接続情報を取得する

公開エンドポイント:Hub > Models Hub(モデルハブ) でモデルカードをクリックし、API Endpoint を選択します。パネルに Python / JavaScript / cURL のコードサンプルと API パスが表示されます。

プライベートエンドポイント:Gen AI Studio > My Endpoints でエンドポイントを選択します。Details(詳細情報)の Private API Information(プライベート API 情報)に Base URL、モデル名、エンドポイントタイプ、API パスが含まれます。Show Code をクリックすると完全なサンプルを取得できます。

呼び出し例

チャットモデルの例です(Base URL とモデル名はコンソールのパネルに表示される値を使用してください):

from openai import OpenAI

client = OpenAI(
base_url="<コンソールに表示される API パス>",
api_key="your-api-key-here", # ご自身の API キーに置き換えてください
)

response = client.chat.completions.create(
model="<コンソールに表示されるモデル名>",
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "GPU とは何ですか?"},
],
temperature=0.7,
)
print(response.choices[0].message.content)
curl <コンソールに表示される API パス> \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your-api-key-here" \
-d '{
"model": "<コンソールに表示されるモデル名>",
"messages": [{"role": "user", "content": "GPU とは何ですか?"}]
}'
ヒント

Playground で調整したパラメータ(Temperature など)は、「View code」で生成されるサンプルに同期して反映されます。納得のいく設定にしてからコピーするのが最も手軽です。

認証とクレジット

  • すべてのリクエストは API キーで認証されます。キーには予算上限を設定でき、上限に達するとリクエストは拒否されます。
  • 公開エンドポイントはトークン使用量に基づいて課金され、レート制限を受けます。各呼び出しの記録は使用量レポートで確認できます。