メインコンテンツへスキップ
POST
応答を作成

サーバーツールを使う

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

ツールループでの推論

OpenAI、Azure OpenAI、xAI では、Phaseo は Responses リクエストを store: false で上流に送信するため、ツールループのステップ間でモデルの推論が引き継がれるのは reasoning 出力アイテムを通じてのみです。 各 reasoning アイテムには id、summary、content があります。プロバイダーが推論の状態を返す場合、アイテムには encrypted_content も含まれ、次のいずれかが入ります。
  • OpenAI、Azure OpenAI、xAI の暗号化された推論。推論モデルでは、Phaseo が include: ["reasoning.encrypted_content"] で要求します。
  • Claude の思考の署名と秘匿化された思考。
  • Gemini の思考の署名。署名が属する関数呼び出しの直前に置かれる、別の reasoning アイテムも含みます。
  • Claude の返信が実行された度合い。出力の最後の reasoning アイテムに入り、テキストはありません。
ストリーミングのレスポンスでは、同じアイテムが response.output_item.done と response.completed で届きます。
ツールループに限らず、すべてのリクエストで、すべての出力アイテムを変更せずに input で送り返してください。encrypted_content の有無にかかわらず、テキストのないアイテムも含め、reasoning アイテムを削除、編集、並べ替えしないでください。
encrypted_content は不透明で、それを生成したプロバイダーとモデルを記録しています。Phaseo はこれをそのプロバイダーの系統とモデルにのみ送信するため、別のプロバイダーにフォールバックした場合は失敗せずに除外されます。これがないと、Claude はツールループのステップ間で推論を失い、reasoning.effort を変更すると Claude のプロンプトキャッシュがやり直しになります。会話の途中で推論の度合いを変えるを参照してください。

承認

Authorization
string
header
必須

Bearer トークンによる認証

ボディ

application/json

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

model
string
必須
input
必須
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 は省略するか同じ参照を指定し、空の会話か、テンプレートの後に追加するターンを送信してください。

background
boolean
include
string[]
instructions
string
max_output_tokens
integer
必須範囲: x >= 1
metadata
object
session_id
string

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

Maximum string length: 256
parallel_tool_calls
boolean
previous_response_id
string

サポートされていません。Phaseoはレスポンスを保存しないため、previous_response_idまたはconversationを指定したリクエストは400 unsupported_paramを返します。会話全体をinputで送ってください。

reasoning
object
service_tier
enum<string> | null

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

利用可能なオプション:
standard,
default,
fast,
ultrafast,
priority,
flex,
batch,
auto,
scale
store
boolean
stream
boolean
temperature
number
必須範囲: 0 <= x <= 2
text
object
plugins
object[]

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

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

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
tools
object[]

モデルの関数呼び出しとゲートウェイのサーバーツールのツール定義です。ゲートウェイの組み込みサーバーツールは gateway:datetime、gateway:web_search、gateway:web_fetch です。

top_p
number
必須範囲: 0 <= x <= 1
truncation
enum<string>
利用可能なオプション:
auto,
disabled
user
string
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
modalities
enum<string>[]
利用可能なオプション:
text,
image,
audio
image_config
object
provider_options
object

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

usage
boolean
meta
boolean
echo_upstream_request
boolean
debug
object

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

provider
object

ゲートウェイでの選択に使用するプロバイダーのルーティング設定。

レスポンス

応答

id
string
object
string
created
integer
model
string
provider
string
provider_id
string
nativeResponseId
string | null
status
enum<string>
利用可能なオプション:
completed,
failed,
incomplete
finish_reason
string | null
meta
object
cost_nanos
number
cost_cents
integer
currency
string
pricing_lines
object[]
output
object[]
output_items
object[]
content
object[]
role
string
stop_reason
string
type
string
usage
object
最終更新日 2026年11月12日