Skip to main content
POST

Authorizations

string
必須
APIキー、Bearerトークン形式APIキーの取得:APIキー管理ページにアクセスしてAPIキーを取得してください

Body

string
必須
モデル名OpenAI 互換モデル(ツール呼び出しに推奨):
  • gpt-4o-mini — 軽量で高速、頻繁かつ単純なタスクに最適
  • gpt-4o — バランスの取れた性能とコストで総合推奨
  • gpt-5.2 — 高性能版、ツール呼び出しを完全にサポート
  • その他のモデルは GET /api/v1/models を参照してください
Claude モデル(Anthropic プロトコル経由):
  • claude-haiku-4-5-20251001 — 軽量で高速
  • claude-sonnet-4-5-20250929 — 総合推奨
  • claude-sonnet-4-6 — Sonnet 新バージョン
  • claude-opus-4-5-20251101 — フラグシップ推論モデル
  • claude-opus-4-6 — Opus 新バージョン、最高性能
完全なモデルリストは GET /api/v1/models をご覧ください
array
必須
メッセージリストモデルはメッセージ履歴に基づいて次の応答を生成します。各メッセージに rolecontent を含みます。プレーンテキストメッセージ:
マルチターン対話:
マルチターンツール呼び出し:
integer
最大出力トークン数最大生成トークン数を制御します。モデルは上限に達する前に自然に終了する可能性があります。最小値:1。 デフォルトは無制限(モデルのコンテキストウィンドウ制限を受けます)。
integer
最大出力トークン数(max_tokens の新名称)max_tokens と完全に同等で、どちらか一方を指定すればよく、max_tokens が優先されます。
boolean
ストリーム出力の有効化true に設定すると、SSE(Server-Sent Events)を通じてリアルタイムにストリーミングで返されます。デフォルトは true。非ストリーミング応答が必要な場合は明示的に "stream": false を指定してください。false の場合は、生成完了後に一括で完全な応答を返します。
number
温度、範囲 0–2
  • 低い値(例:0.2) — 出力がより確定的で保守的
  • 高い値(例:0.8) — 出力がよりランダムでクリエイティブ
デフォルトは 1.0top_p と併用は推奨されません。
number
nucleusサンプリングパラメータ、範囲 0–1累積確率が top_p に達するまでのトークン集合からサンプリングします。デフォルトは 1.0temperature と同時使用は推奨されません。
number
頻度ペナルティ、範囲 -2.0–2.0正の値は既生成テキスト内のトークンの頻度に応じてペナルティをかけ、繰り返し表現の確率を減少させます。デフォルトは 0
number
存在ペナルティ、範囲 -2.0–2.0正の値は既に出現したトークンにペナルティをかけ、モデルに新しいトピックを探索させます。デフォルトは 0
integer
ランダムシード設定すると、同じシードと同じリクエストパラメータで可能な限り決定的な出力を生成し、結果の再現性を高めます。
string | array
停止シーケンスこれらの文字列(もしくは配列内のいずれか)に遭遇すると直ちに生成を停止します。最大4つまで設定可能。
array
ツール定義リストモデルが呼び出せる関数ツールを定義します。各ツールは名前、説明、パラメータのJSON Schemaを含みます。
string | object
ツール選択ポリシー
  • "auto" — モデルがツール呼び出しの可否を自動判断(デフォルト)
  • "required" — モデルが必ず特定ツールを呼び出す
  • "none" — ツールの呼び出しを禁止
  • {"type": "function", "function": {"name": "get_weather"}} — 特定ツールを強制呼び出し
boolean
並列ツール呼び出しの許可false の場合は1回に1つのツールのみ呼び出します。デフォルトは true (並列呼び出し許可)。
object
応答フォーマットモデルの出力フォーマットを制御します。JSONオブジェクトモード:
JSON Schemaモード:
string
推論強度推論対応モデル(例:gpt-5.2 以上)向けに推論の深さを制御します。
  • "low" — 高速推論でトークン節約
  • "medium" — バランスの取れた推論
  • "high" — 深い推論で精度向上、トークン消費は多め

Response

string
補完の一意識別子例:"chatcmpl-9vKqnMf3Ax8ZpRdTw2LsYe7b"
string
オブジェクトタイプで、固定値は "chat.completion"(非ストリーミング)または "chat.completion.chunk"(ストリーミング)
integer
作成日時、Unixタイムスタンプ(秒)
string
リクエスト時に指定したモデル名
string
請求タスクID(プロジェクトの拡張フィールド)、今回の呼び出しにおけるポイント消費記録の追跡に使用
array
生成結果の配列(常に1件のみ)
object
Token使用統計(非ストリーミングではレスポンスボディトップレベル、ストリーミングでは最終フレームに含む)

使用例

基本的な対話

システムプロンプト + 複数ターンの対話

ストリーミングレスポンス

ツール呼び出し(完全な複数ターンプロセス)

構造化出力(JSON Schema)

サンプリングパラメータの制御

ストリーミングレスポンスイベントフォーマット

ツール呼び出しストリーミングイベント:

注意事項

  1. 認証方法Authorization: Bearer <api_key> 形式のみサポートしており、OpenAI SDKを使用する場合は直接 api_key を設定してください。
  2. デフォルトはストリーミングstream パラメータはデフォルトで true です。非ストリーミングレスポンスが必要な場合は、明示的に "stream": false を渡してください。
  3. ポイント不足:残高が足りない場合は HTTP 402 を返し、チャージ後に再試行してください。
  4. stop と停止シーケンスstop パラメータは現時点で有効ではなく、バックエンドのプロバイダがこの機能をサポートしていません。パラメータを渡してもエラーにならず、指定されたシーケンスで生成が停止することもありません。
  5. response_format 注意点:現行のバックエンドプロバイダによる response_format のサポートは限定的です——json_object モードではモデルが純粋な JSON ではなく Markdown のコードブロックを出力する可能性があり、json_schema モードではスキーマの制約が守られない場合があります。構造化出力が必要な場合は、プロンプト内で明確にフォーマットを指定することを推奨します。
  6. ツールパラメータparameters フィールドは有効な JSON Schema である必要があり、required 配列が必須のパラメータを決定します。
  7. モデル選択のおすすめ
    • Haiku — 高頻度の簡単な質問応答、最もコストが低い
    • Sonnet — コード生成やドキュメント処理、総合的におすすめ
    • Opus — 複雑な推論や長文分析、最も高い性能
    • -thinking シリーズ — 数学的証明や論理的導出など深い思考が必要なシナリオ