POST /v1/sessions/{session_id}/threads/{thread_id}/archive
子スレッドをアーカイブします。アーカイブ操作はスレッドステータスを archived に設定し、保留中の mailbox メッセージをすべてキャンセルし、Coordinator スレッドのブロックを解除します(該当する場合)。
role が child のスレッドのみアーカイブできます。Coordinator スレッドはアーカイブできません。ヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer <PAT> |
パスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
session_id | string | はい | Session ID(sess_ プレフィックス) |
thread_id | string | はい | Thread ID(sthr_ プレフィックス) |
リクエスト例
レスポンス例
HTTP 200 OKレスポンスフィールド
アーカイブされた Session Thread オブジェクト を返します。status は "archived" になり、stop_reason は {"type": "archive"} に設定されます。
アーカイブの動作
アーカイブ操作は以下をトリガーします:- スレッドステータスが
archivedに設定される - スレッドの mailbox 内の保留中メッセージがすべてキャンセルされる
- Coordinator が
Agentツール経由でこのスレッドの結果を待っている場合、"Agent cancelled."のツール結果を受信し、Coordinator は実行を再開する session.thread_status_terminatedイベントがstop_reasonを{"type": "archive"}に設定して発行される
エラーコード
| HTTP | type | トリガー条件 |
|---|---|---|
| 401 | authentication_error | PAT が無効または期限切れ |
| 404 | not_found_error | Session または Thread が存在しない |
| 409 | invalid_request_error | Coordinator スレッドをアーカイブしようとした |
| 409 | invalid_request_error | スレッドステータスが idle ではなくアーカイブできない |
関連項目
Managed Agents
マルチ Agent 協調とスレッドライフサイクルの全体像を確認します。
Session Threads 一覧
Session 内のすべてのスレッドとそのステータスを取得します。
スレッドイベント一覧
アーカイブ後のスレッドイベント履歴を確認します。
Session Thread オブジェクト
archived ステータスや stop_reason フィールドの仕様を参照します。