ドキュメント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://api.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 でプレーンテキストを取得できます。

関連エンドポイント

  • POST /v1/responses/compactPOST /v1/responses/input_tokens:Codex クライアントが使うコンテキスト圧縮と入力トークン見積もりの補助エンドポイントです。

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