メインコンテンツへスキップ
POST
チャット補完を作成

サーバーツールを使う

自分の関数ツールと並べて tools に phaseo: ツールを追加すると、モデルがそれを呼び出したときに Phaseo が実行します。/v1/chat/completions は phaseo:apply_patch を除くすべてのサーバーツールを受け付けます。一覧はサーバーツールガイドにあります。
サーバーツールの各呼び出しは usage.server_tool_use に計数されます。
phaseo:web_search は web_search_requests、web_search_results、web_search_extra_results を追加し、phaseo:web_fetch は web_fetch_requests を追加します。以前の gateway:datetime タイプも引き続き動作します。 stream: true の場合、Phaseo がツールのターンを自分で実行し、続きの回答を 1 つのストリームとして送信します。

ツールループでの推論

推論モデルは、アシスタントメッセージの 2 つのフィールドで推論を返します。
  • reasoning_content: プロバイダーが返す場合の推論テキスト。
  • reasoning_details: 推論ブロックの配列。各エントリーには、reasoning.text、reasoning.summary、reasoning.encrypted のいずれかの type、index、プロバイダーの系統を示す format(例: anthropic-claude-v1 や google-gemini-v1)があります。
エントリーには、ツールループの次のステップでモデルが必要とするプロバイダーの状態が含まれることがあります。 ストリーミングでは、各推論ブロックが完了するたびに reasoning_details のデルタが届きます。
ツールループに限らず、すべてのリクエストで、各アシスタントメッセージを reasoning_details を変更せずに送り返してください。暗号化の有無にかかわらず、テキストのないエントリーも含め、エントリーを削除、編集、並べ替えしないでください。
signature と data の値は不透明で、それを生成したプロバイダーとモデルを記録しています。Phaseo はこれらをそのプロバイダーの系統とモデルにのみ送信するため、別のプロバイダーにフォールバックした場合は失敗せずに除外されます。これらがないと、手動思考モードの Claude モデルはツールループの次のステップを思考なしで実行し、reasoning_effort を変更すると Claude のプロンプトキャッシュがやり直しになります。会話の途中で推論の度合いを変えるを参照してください。

承認

Authorization
string
header
必須

Bearer トークンによる認証

ボディ

application/json

null として送信された省略可能なトップレベルのフィールドは、省略した場合と同じく未設定として扱われます。

model
string
必須
messages
object[]
必須
Minimum array length: 1
models
string[]

model の後に試行される、任意の順序付きフォールバックモデルです。model は必須で、常にプライマリモデルです。試行が 429、500、502、503、504 で失敗すると次のエントリーが試行され、その他のエラーはそのまま返されます。最大 25 個のモデル ID またはプリセットを指定でき、重複や model と同じエントリーは無視されます。各試行は個別のリクエストとして検証、記録、課金され、レスポンスの model フィールドとルーティングトレースには、リクエストを処理したモデルが表示されます。ストリーミングリクエストは最初のバイトの送信前にのみフォールバックし、動画と音楽のジョブは送信時にのみフォールバックします。Batch、realtime、council のリクエストは models を拒否します。動的ルートで設定されたフォールバックが優先され、phaseo/auto は models と併用できません。

Required array length: 1 - 25 elements
Minimum string length: 1
例:
prompt
object

プリセットに保存されたプロンプトテンプレートを埋めます。model は省略するか同じ参照を指定し、空の会話か、テンプレートの後に追加するターンを送信してください。

reasoning
object
reasoning_effort
enum<string>

reasoning.effort の OpenAI 互換エイリアスです。

利用可能なオプション:
none,
instant,
minimal,
low,
medium,
high,
xhigh,
max
frequency_penalty
number
必須範囲: -2 <= x <= 2
logit_bias
object
max_completion_tokens
integer
必須範囲: x >= 1
max_tokens
integer
必須範囲: x >= 1
metadata
object
session_id
string

関連するリクエスト(会話やエージェントのワークフローなど)を可観測性のためにまとめる一意の識別子です。

Maximum string length: 256
presence_penalty
number
必須範囲: -2 <= x <= 2
seed
integer
必須範囲: -9223372036854776000 <= x <= 9223372036854776000
store
boolean
stream
boolean
デフォルト:false
stream_options
object
temperature
number
デフォルト:1
必須範囲: 0 <= x <= 2
tools
object[]

モデルの関数呼び出しとゲートウェイのサーバーツールのツール定義です。組み込みサーバーツールには、日付・時刻、Web 検索、Web 取得、Advisor、Subagent、Fusion、モデル検索、画像生成、パッチ作成が含まれます。

max_tool_calls
integer
必須範囲: x >= 1
parallel_tool_calls
boolean
デフォルト:true
tool_choice

ツール選択の方法です。Phaseo サーバーツールのタイプを受け付け、上流の関数またはツールの指定に変換します。allowed_tools オブジェクトは、すべてのツールとともに OpenAI にそのまま送られます。その他のプロバイダーには、許可されたツールとそのモード(auto または required)だけが送られ、required で許可されるツールが 1 つだけの場合はそのツールの呼び出しが強制されます。tools に定義されていないツールが allowed_tools に含まれる場合、リクエストを処理できるのは OpenAI だけです。それ以外の場合は 400 エラーが返されます。

利用可能なオプション:
auto,
none,
required,
phaseo:datetime,
phaseo:web_search,
phaseo:web_fetch,
phaseo:subagent,
phaseo:fusion,
phaseo:search_models,
gateway:datetime,
gateway:web_search,
gateway:web_fetch
plugins
object[]

このリクエストで使うゲートウェイプラグイン。web は任意のモデルに Web 検索を、web-fetch はページの取得を追加します。response-healing はストリーミングしない構造化レスポンスの不正な JSON を修復します。ワークスペースとプリセットの既定値はこのリストとマージされます。不明なプラグイン ID には 400 unknown_gateway_plugin が返ります。

リクエストにサーバーツール phaseo:web_search を追加し、任意のモデルが Web を検索できるようにします。リクエストの実行、検索の計数と課金は phaseo:web_search ツールを使った場合とまったく同じです。リクエストにすでに Web 検索ツールがある場合、プラグインは何も追加しません。その他のオプションは無視されます。

logprobs
boolean
デフォルト:false
top_logprobs
integer
必須範囲: 0 <= x <= 20
top_p
number
必須範囲: 0 <= x <= 1
stop
response_format
modalities
enum<string>[]
利用可能なオプション:
text,
image,
audio
image_config
object
usage
boolean
provider

プロバイダー選択子です。単一のプロバイダーには文字列を、ルーティングオプションには { "only": ["groq"] } のような値を使います。

利用可能なオプション:
openai,
anthropic,
google-ai-studio,
gemini,
mistral,
x-ai,
xai,
groq,
together
provider_options
object

任意のプロバイダー固有オプションです。

user_id
string
user
string
include_reasoning
boolean

互換性のために受け付けます。この値にかかわらず、モデルが推論を生成した場合は常に返されます(reasoning_content と reasoning_details)。

prediction
object

予測出力。返答の大部分が事前にわかっている場合に、レスポンスを高速化します。OpenAI、Mistral、Moonshot のモデルに転送され、その他のプロバイダーでは無視されます。

service_tier
enum<string> | null

サポートされるルーティングまたは料金のティアを選択します。auto(または null)は特定のティアを指定せず、このフィールドが未設定の場合と同じようにルーティングおよび課金されます。scale は標準ティアである default として扱われます。

利用可能なオプション:
standard,
default,
fast,
ultrafast,
priority,
flex,
batch,
auto,
scale
prompt_cache_key
string | null

関連するリクエストをまとめ、そのプロンプトキャッシュを持つプロバイダーにとどめます。Phaseoは生のキーではなく、ワークスペースとこのキーのハッシュを上流に送ります。

prompt_cache_retention
enum<string>

GPT-5.6より前のOpenAIとAzure OpenAIのモデル向けのプロンプトキャッシュ保持期間。provider_options.openai.prompt_cache_retentionより優先されます。

利用可能なオプション:
in_memory,
24h
prompt_cache_options
object

GPT-5.6以降のOpenAIとAzure OpenAI(ttl 30m、OpenAIでは12hも可)、およびDeepInfra(ttl 5mまたは1h)向けのプロンプトキャッシュのモードとTTL。ほかのプロバイダーでは削除されます。

cache_control
object

プロンプトキャッシュの制御。type ephemeralと、任意で5mまたは1hのttlを指定します。scopeはトップレベルのClaudeキャッシュポリシーにだけ適用されます。Amazon BedrockとGoogle Vertex AIは、Claude 3.7 Sonnet、3.5 Sonnet、3 Opusを5分間しかキャッシュしません。これらのルートではttlを削除し、削除した1hはX-Phaseo-Dropped-Paramsにcache_control.ttlとして報告します。

safety_identifier
string | null
meta
boolean
デフォルト:false
echo_upstream_request
boolean
debug
object

ゲートウェイのデバッグ設定です。これらのフラグがプロバイダーに転送されることはありません。

レスポンス

チャット補完の応答

id
string
nativeResponseId
string | null
object
string
created
integer
model
string
provider
string
choices
object[]
usage
object
最終更新日 2026年11月12日