API概要 - OpenModex

ベースURL

環境	URL
本番環境	`https://api.openmodex.com/v1`
サンドボックス	`https://api-sandbox.openmodex.com/v1`

開発やテストにはサンドボックス環境をご利用ください。本番環境と同じ動作をしますが、課金は発生しません。すべてのAPIエンドポイントはOpenAI互換です。すでにOpenAI APIを使用している場合は、ベースURLとAPIキーを変更するだけで切り替えられます。

認証

AuthorizationヘッダーにAPIキーを含めてください：

Authorization: Bearer omx_sk_YOUR_API_KEY

エンドポイント

メソッド	エンドポイント	説明
`POST`	`/chat/completions`	チャット補完を作成
`POST`	`/completions`	テキスト補完を作成（レガシー）
`POST`	`/embeddings`	エンベディングを作成
`GET`	`/models`	利用可能なモデルを一覧表示
`GET`	`/models/:id`	モデルを取得
`GET`	`/models/compare`	モデルを並列比較

リクエスト形式

すべてのPOSTリクエストはContent-Type: application/jsonのJSONボディを受け付けます。

レスポンス形式

すべてのレスポンスはJSONで返されます。成功したレスポンスはデータを直接含みます。エラーレスポンスは以下の形式に従います：

{
  "error": {
    "message": "Human-readable error message",
    "type": "invalid_request_error",
    "code": "invalid_api_key"
  }
}

HTTPステータスコード

コード	説明
`200`	成功
`400`	不正なリクエスト — パラメータを確認してください
`401`	認証エラー — APIキーが無効または不足
`403`	禁止 — 権限が不十分
`404`	見つからない — エンドポイントまたはモデルが無効
`429`	レート制限 — 速度を落とすかプランをアップグレードしてください
`500`	サーバーエラー — バックオフしてリトライしてください
`502`	不正なゲートウェイ — アップストリームプロバイダーエラー
`503`	サービス利用不可 — 一時的な停止

OpenModexレスポンスメタデータ

すべてのレスポンスには、ルーティングとパフォーマンスのメタデータを含むオプションのopenmodexフィールドが含まれます：

{
  "id": "chatcmpl-abc123",
  "choices": [...],
  "usage": {...},
  "openmodex": {
    "request_id": "req_abc123",
    "model_used": "gpt-4o-2024-08-06",
    "provider": "openai",
    "cache_hit": false,
    "routing_strategy": "cost_optimized",
    "fallback_used": false,
    "latency_ms": 1250
  }
}

べき等性

POSTリクエストでは、Idempotency-Keyヘッダーを渡すことで、同じリクエストが二重に処理されないようにできます：

curl https://api.openmodex.com/v1/chat/completions \
  -H "Authorization: Bearer omx_sk_..." \
  -H "Idempotency-Key: my-unique-key-123" \
  -H "Content-Type: application/json" \
  -d '...'

べき等性キーは24時間有効です。

​ベースURL

​認証

​エンドポイント

​リクエスト形式

​レスポンス形式

​HTTPステータスコード

​OpenModexレスポンスメタデータ

​べき等性