接続 URL
Last-Event-ID ヘッダーをサポートします。最後に受信したイベントの id を渡すと、その ID の次のイベントからストリームが再開されます。イベントタイプによるクエリフィルタは現在サポートされていません。
増分ストリーミングは Session 作成時に Session ごとに有効化します。
SSE 形式
各イベントは標準の SSE フィールドを使用します。典型的なイベントフロー
session.thread_created、session.thread_status_running、agent.thread_message_sent、agent.thread_message_received などのスレッドイベントも発行されることがあります。
注意: 公開されるagent.thinkingイベントにはid、processed_at、typeのみが含まれます。推論内容は意図的に公開されません。Agent が推論のために一時停止したことを示すマーカーとして扱ってください。他にもいくつかの Agent 生成イベントはprocessed_atを省略します。パース時にはこのフィールドを任意として扱ってください。
増分イベント
incremental_streaming_enabled が true の場合、クライアントは次のトップレベルの増分イベントタイプを受信することがあります。
agent.message_start、agent.content_block_start、agent.content_block_delta、agent.content_block_stop、agent.message_delta、agent.message_stop。
典型的なアシスタントメッセージの増分は、次の順序で現れます。
agent.content_block_delta.delta.type 内で伝えられます。例:
agent.tool_result イベントとして届きます。
接続のライフサイクル
session.status_idleは現在のターンが終了したことを示します。接続は開いたまま、次のターンを待つべきです。session.status_terminatedとsession.deletedは終端状態です。クライアントは再接続を停止すべきで、以降イベントは届きません。session.status_rescheduledは一時的なシグナルです。ストリームは一時的に切断されることがありますが、ランタイムの準備が整うと再接続されます。- ストリーム途中でネットワークが切断された場合は、最後に受信したイベント ID を
Last-Event-IDヘッダーに設定して再接続してください。サーバーはその時点以降のイベントをリプレイします。
ツールの応答
ストリームが確認を必要とするagent.tool_use を発行した場合、ツールイベントの ID を付けて POST /api/v1/cloud/sessions/{session_id}/events に user.tool_confirmation を送信します。
agent.custom_tool_use を発行した場合は、クライアント側でカスタムツールを実行し、user.custom_tool_result を送信します。
イベント履歴
履歴イベントとページングにはリストエンドポイントを使用します。data と next_page を使用します。List events と Session schemas を参照してください。