Skip to Content
API リファレンスOpenAI 互換プロトコル概要

OpenAI 互換プロトコル

OpenAI 公式 SDK や OpenAI 互換のクライアントでは、API アドレスを OfoxAI に変更し、OfoxAI の Key を設定するだけでご利用いただけます。

API アドレスhttps://api.ofox.ai/v1
認証ヘッダーAuthorization: Bearer <あなたの OFOXAI_API_KEY>

エンドポイント

対話型のリクエストには Responses(OpenAI が現在推奨しているエンドポイントで、プロンプトキャッシュとの相性が優れています)を優先してご利用ください。Chat Completions ベースの既存コードは、変更せずに API アドレスと Key を差し替えるだけで動作します。

エンドポイントメソッドとパス用途
Chat CompletionsPOST /v1/chat/completionsチャット補完。既存コードとの互換性が最も広い
ResponsesPOST /v1/responses次世代の対話エンドポイント。推奨
EmbeddingsPOST /v1/embeddingsテキストエンベディング
ImagesPOST /v1/images/generations、/v1/images/edits画像の生成と編集
ModelsGET /v1/models利用可能なモデルとその詳細の一覧
Models CountGET /v1/models/countモデル数の集計

3 つのプロトコルのアドレスと認証方式の比較は API 概要を、Key の取得と保管は API Key の取得と使用を参照してください。

Last updated on