セッションイベントのストリーミング

​

Headers

​

Path parameters

​

Query parameters

​

Example request

curl -s -X GET 'https://api.qoder.com/api/v1/forward/sessions/sess_xxx/events/stream' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Accept: text/event-stream"

curl -s -G 'https://api.qoder.com/api/v1/forward/sessions/sess_xxx/events/stream' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Accept: text/event-stream" \
  -H "X-Qoder-Beta: thinking-event-stream-delta-2026-07-20" \
  --data-urlencode 'event_deltas[]=agent.message' \
  --data-urlencode 'event_deltas[]=agent.thinking'

​

Example response

id: evt_xxx
event: agent.message
data: {"id":"evt_xxx","type":"agent.message","session_id":"sess_xxx","content":[{"type":"text","text":"Here is the analysis result."}],"processed_at":"2026-06-22T11:00:03Z"}

​

Event delta streaming の例

id: evt_xxx
event: event_start
data: {"id":"evt_xxx","type":"event_start","session_id":"sess_xxx","event":{"id":"evt_xxx","type":"agent.message"}}

id: evt_xxx
event: event_delta
data: {"id":"evt_xxx","type":"event_delta","session_id":"sess_xxx","event_id":"evt_xxx","delta":{"type":"content_delta","index":0,"content":{"type":"text","text":"Here"}}}

​

モデル使用量イベントの例

id: evt_xxx
event: span.model_request_end
data: {"id":"evt_xxx","type":"span.model_request_end","is_error":false,"model_request_start_id":"evt_yyy","model_usage":{"credits":0.42},"processed_at":"2026-06-22T11:00:01Z"}

​

Response fields

​

接続の切断と再接続

• 最後に受信した SSE frame の id（Event ID）を継続的に記録します。
• 切断後、その ID を Last-Event-ID リクエストヘッダーに指定して再接続すると、続きから購読を再開でき、Event の取りこぼしを防げます。
• 再接続時に Last-Event-ID を省略すると、接続時点のイベントストリーム末尾から配信を開始し、接続確立後に新しく生成された Event のみを受信します。履歴 Event は再送されません。切断中の Event を取得するには、先に Session Event の一覧取得で履歴をページ単位で取得してから、SSE 接続を確立してストリームを継続してください。
• 2026 年 8 月 24 日以降、Last-Event-ID を指定せずに接続した場合、サーバーは接続時点のイベントストリーム末尾から配信を開始し、履歴 Event を再送しません。推奨される接続方法は、履歴 Event を List Events でページ単位に取得し、リアルタイム Event を SSE で受信し、切断時は最後に受信した Event ID を Last-Event-ID に指定して再接続し、Event ID に基づいて冪等に処理することです。

​

Errors

​

Notes

• event_deltas[] は推奨のストリーミング方法です。このパラメータが提供されない場合、標準のパブリックイベントのみ返されます。
• event_cursor_not_found のエラーメッセージは Event '<event_id>' was not found. です。このエラーを受け取った場合は、イベント履歴を再クエリして新しい接続を確立してください。Session が削除されたことを意味するものではありません。
• agent.thinking の増分ストリーミングは現在 Beta 機能です。購読するリクエストには X-Qoder-Beta: thinking-event-stream-delta-2026-07-20 を指定する必要があり、Beta 期間中に動作が変更される場合があります。
• モデル呼び出しが完了するたびに、ストリームは span.model_request_end モデル使用量イベントを出力します。model_usage.credits はその呼び出し単体の増分使用量です。Session の累積使用量は Get Session から usage.total_credits を読み取ってください。フィールドの詳細はデータ構造ドキュメントのモデル使用量イベントを参照してください。
• 不明な Event タイプは利用可能な場合、エンベロープのみのイベントとして転送されます。
• include_thinking=false は thinking イベント、レガシー thinking デルタ、および新しいストリーム agent.thinking event start シグナルと delta.content.type=thinking フラグメントをフィルタリングします。
• include_tool_calls=false はツール使用イベントとレガシーツール input/output デルタをフィルタリングします。

​

Related