Session データ構造

Session オブジェクト

create、get、list、update、archive エンドポイントで返却されます。

フィールド	型	説明
`id`	string	`sess_` プレフィックス付きの Session ID
`type`	string	固定値 `"session"`
`agent`	Agent オブジェクト	Session 作成時にキャプチャされた Agent スナップショット
`agent_id`	string	この Session で使用する Agent ID
`environment_id`	string	この Session で使用する Environment ID
`status`	string	Session のライフサイクルステータス。`idle`、`running`、`terminated` など
`turn_status`	string	現在の Turn のステータス。空の場合は `idle` がデフォルト
`title`	string	Session のタイトル
`metadata`	object	メタデータオブジェクト
`resources`	Session リソースの配列	Session にアタッチされたファイルまたはリポジトリ。デフォルトは `[]`
`vault_ids`	string の配列	Session にアタッチされた Vault ID。デフォルトは `[]`
`memory_store_ids`	string の配列	Session にアタッチされた Memory Store ID。デフォルトは `[]`
`stats`	Session 統計情報	Session の統計情報
`archived_at`	string \| null	アーカイブ時刻、未アーカイブの場合は `null`
`created_at`	string	作成時刻
`updated_at`	string	最終更新時刻

作成リクエストの agent は Agent ID の文字列、またはこのオブジェクトのいずれかです:

フィールド	型	必須	説明
`id`	string	はい	`agent_` プレフィックス付きの Agent ID
`type`	string	いいえ	任意のマーカー
`version`	integer	いいえ	スナップショットする Agent バージョン。省略するか `0` を渡すと最新のアクティブバージョンが使用されます

作成リクエストの environment は Environment ID の文字列、またはこのオブジェクトです。

フィールド	型	必須	説明
`name`	string	いいえ	Environment 名。省略または空欄の場合、デフォルトは `"Session Environment"`
`description`	string	いいえ	Environment の説明
`config`	Environment 設定	はい	Environment の設定
`metadata`	object	いいえ	メタデータオブジェクト

resources[] は type で区別されるユニオン型です。

フィールド	型	必須	説明
`type`	string	いいえ	`"file"`。省略時のデフォルトは `"file"`
`file_id`	string	はい	`file_` プレフィックス付きの File ID。ファイルは `ready` ステータスでなければなりません
`path`	string	いいえ	コンテナ内のマウントパス。デフォルトは `/data/{file_id}`。相対値には `/data/` がプレフィックスとして付与され、正規化されたパスは `/data/` 配下で最大 512 文字でなければなりません
`mount_path`	string	いいえ	`path` のリクエストエイリアス。両方指定する場合は同一でなければなりません。レスポンスでは正規化された値が `path` として保存されます

フィールド	型	必須	説明
`type`	string	はい	`"github_repository"`
`url`	string	はい	リポジトリ URL
`mount_path`	string	いいえ	コンテナ内のクローン先パス
`authorization_token`	string	いいえ	プライベートリポジトリアクセス用トークン

フィールド	型	説明
`active_seconds`	number	アクティブな処理時間（秒）。新規 Session は `0` から開始
`duration_seconds`	number	Session の経過時間（秒）。新規 Session は `0` から開始

send-event、list-events、stream エンドポイントで返却されるイベントは、以下の共通フィールドを持つイベント固有の JSON オブジェクトです。

フィールド	型	説明
`id`	string	`evt_` プレフィックス付きのイベント ID
`type`	string	イベントタイプ
`schema_version`	string	イベントスキーマバージョン、CAS が作成したユーザーイベントの場合は現在 `"1.0"`
`session_id`	string	所有する Session ID
`turn_id`	string	イベントが Turn に属する場合に存在
`created_at`	string	作成時刻
`processed_at`	string \| null	処理時刻

タイプ	必須フィールド	注意事項
`user.message`	`content`	新しい Turn を開始します。`content` は文字列またはコンテンツブロックの配列
`user.interrupt`	なし	中断/キャンセルをリクエスト
`user.tool_confirmation`	`tool_use_id`、`result`	`result` は `allow` または `deny`。`deny_message` は任意
`user.custom_tool_result`	`custom_tool_use_id`	`content` は任意で、テキストコンテンツブロックとして保存されます
`user.define_outcome`	なし	追加フィールドは保持されます

Agent を環境で実行し、ステートフルな対話を行う。