GET /v1/sessions/{session_id}/events
Session 内のイベント一覧を時系列順(昇順)で取得します。カーソルページネーションをサポートします。
リクエストの Accept ヘッダーに text/event-stream が含まれる場合、このルートは SSE ストリーミングに切り替わり、ページネーション付き JSON 形式を返しません。リスト形式のレスポンスが必要な場合は Accept: application/json を使用するか、SSE メディアタイプを省略してください。
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
session_id | string | Session ID(sess_ プレフィックス) |
ヘッダー
| 名称 | 必須 | 値 |
|---|---|---|
| Authorization | はい | Bearer $QODER_PAT |
クエリパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | 返却件数の上限、デフォルト 20 |
after_id | string | いいえ | カーソルページネーション:このイベント ID 以降のレコードを返す |
before_id | string | いいえ | カーソルページネーション:このイベント ID 以前のレコードを返す |
order | string | いいえ | ソート方向:asc(デフォルト、時系列順)または desc(逆時系列順) |
type | string | いいえ | イベントタイプでフィルタリング。値は返却イベントの type フィールドに対応(例: user.message、agent.message、agent.artifact_delivered)。カンマ区切りで複数指定可能(例: type=user.message,agent.message)。キーの繰り返しも可能(例: type=a&type=b)。省略時は全タイプを返却 |
types[] | string | いいえ | type の配列形式の代替。複数の types[]=… パラメータで複数のイベントタイプをフィルタリング(例: types[]=user.message&types[]=agent.message) |
created_at[gte] | string | いいえ | この時刻以降(含む)に作成されたイベントを返却。RFC 3339 形式 |
created_at[lte] | string | いいえ | この時刻以前(含む)に作成されたイベントを返却。RFC 3339 形式 |
リクエスト例
イベントタイプによるフィルタリング
レスポンス例
HTTP 200 OKイベントタイプリファレンス
| type | 説明 | 固有フィールド |
|---|---|---|
user.message | ユーザーメッセージ | content (string) |
agent.tool_use | Agent の組み込みツール呼び出し | name, input, evaluated_permission |
agent.tool_result | ツール実行結果 | tool_use_id, content (ContentBlock[]), is_error |
agent.custom_tool_use | Agent がクライアント側カスタムツールをリクエスト | name, input |
agent.mcp_tool_use | Agent が MCP ツールを呼び出し | name, input, mcp_server_name, evaluated_permission |
agent.mcp_tool_result | MCP ツール実行結果 | tool_use_id, content (ContentBlock[]), is_error |
agent.message | Agent の応答 | content (ContentBlock[]) |
agent.thinking | Agent の思考 | - |
user.interrupt | ユーザーが Agent 実行を中断 | - |
user.tool_confirmation | ユーザーが保留中のツール呼び出しを承認または拒否 | tool_use_id, result, 任意の deny_message |
user.custom_tool_result | ユーザー/クライアントがカスタムツール結果を返却 | custom_tool_use_id, content (ContentBlock[]) |
user.define_outcome | ユーザー定義のアウトカムイベント | イベント固有のペイロード |
session.status_running | Session が実行を開始 | - |
session.status_idle | Session がアイドルに戻った | usage, status, stop_reason |
session.error | Session 実行エラー | error, details, retry_status |
agent.artifact_delivered | Agent が DeliverArtifacts ツールでファイルを配信 | file_id, original_filename, size, content_type |
session.thread_created | 新しい子スレッドが作成された(Managed Agents) | parent_thread_id, agent_id, agent_version, agent_name, role, created_by_tool_use_id |
session.thread_status_running | 子スレッドが実行を開始した(Managed Agents) | agent_name, status |
session.thread_status_idle | 子スレッドがアイドルに戻った(Managed Agents) | status, stop_reason |
session.thread_status_terminated | 子スレッドがアーカイブまたは終了された(Managed Agents) | status, stop_reason |
agent.thread_message_sent | スレッド間メッセージが送信された(Managed Agents) | direction, content, from_session_thread_id, to_session_thread_id |
agent.thread_message_received | スレッド間メッセージが受信された(Managed Agents) | direction, content, is_error, from_session_thread_id, to_session_thread_id |
agent.raw、agent.system、turn_completed、turn_cancelled、turn_failed、terminated、span.model_request_start、span.model_request_end、pending_action.* などの内部イベントタイプをフィルタリングして除外します。
agent.message の content 形式
session.status_idle の追加フィールド
ターン完了時:
stop_reason.type が requires_action の場合、event_ids にはクライアントからのレスポンスが必要な agent.tool_use または agent.custom_tool_use イベントの ID がリストされます。これらの ID を user.tool_confirmation.tool_use_id または user.custom_tool_result.custom_tool_use_id に使用してください。
session.error 形式
ページネーションフィールド
| フィールド | 型 | 説明 |
|---|---|---|
data | array | 表示可能なイベントオブジェクトのリスト。各項目には id、type、session_id、schema_version、created_at、通常は processed_at が含まれます。ターンスコープのイベントには turn_id が含まれます。その他のフィールドは type に依存します。 |
first_id | string | 現在ページ先頭レコードの ID |
last_id | string | 現在ページ末尾レコードの ID |
has_more | boolean | さらにレコードがあるかどうか |
エラーレスポンス
| HTTP | type | 説明 |
|---|---|---|
| 401 | authentication_error | PAT が無効または期限切れ |
| 404 | not_found_error | Session が存在しない |
Agent 出力ファイルの取得
Agent がDeliverArtifacts ツールを呼び出すと、プラットフォームは各ファイルを永続ストレージにアップロードし、agent.artifact_delivered イベントを発行します。type フィルタでこれらのイベントのみを取得し、Files API でファイルをダウンロードします。
agent.artifact_delivered イベント形式
エンドツーエンドのダウンロード例
関連項目
Session イベントストリーム
SSE で Agent の思考、メッセージ、ツール呼び出し、ステータスをストリーミング。