Skip to Content
API リファレンスAPI 概要

API 概要

OfoxAI は3種類のプロトコルによるAPI接続方式を提供しており、各ベンダーの公式SDKと完全互換です。

Base URL

プロトコルBase URL説明
OpenAI 互換https://api.ofox.ai/v1OpenAI SDK互換、全モデル対応
Anthropic ネイティブhttps://api.ofox.ai/anthropicAnthropic SDK互換、ネイティブClaude体験
Gemini ネイティブhttps://api.ofox.ai/geminiGoogle GenAI SDK互換

認証

すべてのプロトコルで統一されたOfoxAI API Keyを使用しますが、Headerの形式はプロトコルによって異なります：

プロトコルHeader形式
OpenAIAuthorizationBearer sk-xxx
Anthropicx-api-keysk-xxx
Geminix-goog-api-keysk-xxx

詳細は認証ガイドをご覧ください。

利用可能なエンドポイント

OpenAI 互換プロトコル

エンドポイントメソッド説明
/v1/chat/completionsPOSTチャット補完の作成
/v1/embeddingsPOSTテキストエンベディングの作成
/v1/modelsGET利用可能なモデルの一覧
/v1/models/{model_id}GETモデル詳細の取得
/v1/images/generationsPOST画像生成

Anthropic ネイティブプロトコル

エンドポイントメソッド説明
/anthropic/v1/messagesPOSTMessagesの作成

Gemini ネイティブプロトコル

エンドポイントメソッド説明
/gemini/v1beta/models/{model}:generateContentPOSTコンテンツ生成
/gemini/v1beta/models/{model}:streamGenerateContentPOSTストリーミングコンテンツ生成

レート制限

OfoxAI は従量課金制で、すべてのユーザーが統一されたレートポリシーを共有します：

制限項目上限
RPM（リクエスト/分）200
TPM（Token/分）無制限

より高いレート制限が必要な場合は、OfoxAI サポート にお問い合わせください。

レート制限に達した場合、APIは 429 Too Many Requests を返します。レスポンスHeaderには以下が含まれます：

x-ratelimit-limit-requests: 200
x-ratelimit-remaining-requests: 0
x-ratelimit-reset-requests: 1s

エラーコード

すべてのプロトコルで統一されたHTTPステータスコードを返します：

ステータスコード説明よくある原因
200成功—
400リクエストエラーパラメータ形式エラー、必須フィールドの欠落
401認証失敗API Keyが無効または期限切れ
403権限不足アカウントにそのモデルへのアクセス権がない
404リソースが存在しないモデルIDの誤り
429レート制限レート制限を超過
500サーバーエラー内部エラー、リトライしてください
502アップストリームエラーモデルプロバイダーのサービス異常
503サービス利用不可メンテナンス中

エラーレスポンス形式

{
  "error": {
    "code": "invalid_api_key",
    "message": "提供されたAPI Keyが無効です。確認して再度お試しください。",
    "type": "authentication_error"
  }
}

OfoxAI 拡張パラメータ

OfoxAI は標準プロトコルに加えて、高度なルーティングとフォールバック制御のための拡張パラメータを提供します：

{
  "model": "openai/gpt-4o",
  "messages": [...],
  "provider": {
    "routing": "cost",
    "fallback": ["anthropic/claude-sonnet-4.5", "google/gemini-3-flash-preview"]
  }
}

詳細はプロバイダールーティングとフォールバックをご覧ください。

Last updated on
Chat Completions