ドキュメントAPI リファレンスResponses API

Responses API

OpenAI 互換の Responses エンドポイント：リクエストフィールド、レスポンス形式、ストリーミング。

POST/v1/responses

OpenAI Responses API のリクエストボディと互換の対話エンドポイントで、Codex などのコーディングツールが実際に使用するインターフェースです。認証は Authorization: Bearer を使います。

リクエストボディ

フィールド型必須説明
modelstringはいモデル id。モデル一覧を参照。
inputstring | arrayはいユーザー入力：プレーンテキスト、または複数ターン/マルチモーダルのメッセージ配列。
instructionsstringいいえシステムプロンプト。
max_output_tokensintegerいいえ出力トークンの上限（16 以上）。
streambooleanいいえtrue の場合、SSE でストリーミング返却します。ストリーミング参照。
temperature / tools / …—いいえその他の公式フィールドはそのまま転送され、対応可否は対象モデルに依存します。
request.sh
curl https://soleapi.com/v1/responses \
  -H "Authorization: Bearer $SOLEAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-fable-5",
    "input": "Write a haiku about the sea",
    "max_output_tokens": 200
  }'

レスポンス

response.json
{
  "id": "resp_abc123",
  "object": "response",
  "model": "claude-fable-5",
  "status": "completed",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        { "type": "output_text", "text": "Waves fold into foam..." }
      ]
    }
  ],
  "usage": {
    "input_tokens": 14,
    "output_tokens": 23,
    "total_tokens": 37
  }
}

usage のトークン数がそのまま課金の根拠になります。公式 SDK では resp.output_text でプレーンテキストを取得できます。

その他の OpenAI 互換エンドポイント

同じ認証ヘッダーで次のエンドポイントも利用できます。リクエスト/レスポンスの形は OpenAI 公式と同じです：

エンドポイント用途課金
POST /v1/embeddingsテキスト埋め込み（text-embedding-3-small / -large）入力トークン単位
POST /v1/images/generations · /v1/images/edits画像生成と編集。画像と動画参照枚数単位
POST /v1/videos/generations · /v1/videos/edits · GET /v1/videos/{request_id}非同期の動画生成（Grok Imagine）。画像と動画参照秒単位、完成後に精算
POST /v1/responses/compact · /v1/responses/input_tokens · /v1/alpha/searchCodex クライアントが使うコンテキスト圧縮、入力トークン見積もり、ウェブ検索圧縮はトークン単位、見積もりは無料、検索は回数単位
GET /v1/usageアカウント残高と累計消費。課金と残高参照無料（RPM に計上）
embeddings.sh
curl https://soleapi.com/v1/embeddings \
  -H "Authorization: Bearer $SOLEAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "text-embedding-3-small",
    "input": "The quick brown fox"
  }'

POST /v1/chat/completions は過去互換のためだけに残しています。新規統合では必ず Responses API を使用してください。