POST /v1/sessions/{session_id}/cancel
処理中の Session をキャンセルします。cancel が Agent 実行を実際に中断するのは、現在のターンが処理中の場合のみです。ターンはキャンセルに向かって進み、中断完了後に idle に戻ります。Session は引き続き再利用可能です。idle になった後に次の user.message を送信してください。すでに idle の Session に対する cancel は no-op で、HTTP 200 を返します。
パスパラメータ
| パラメータ | 型 | 説明 |
|---|
session_id | string | Session ID（sess_ プレフィックス） |
ヘッダー
| 名称 | 必須 | 値 |
|---|
| Authorization | はい | Bearer $QODER_PAT |
リクエスト例
curl -X POST https://api.qoder.com/api/v1/cloud/sessions/sess_019e3bb1e8c171fd9abbb1477ffb84cc/cancel \
-H "Authorization: Bearer $QODER_PAT"
レスポンス例
HTTP 202 Accepted
キャンセル指令は非同期で実行され、簡略化された状態確認オブジェクトを返します。HTTP 202 はキャンセルが処理中のターンに適用されたことを示します。HTTP 200 は no-op であったことを示し、通常は処理中のターンがなかったことを意味します。どちらの場合もレスポンスボディの形式は同じです。
{
"id": "sess_019e3bb1e8c171fd9abbb1477ffb84cc",
"type": "session",
"status": "canceling"
}
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|
id | string | Session ID |
type | string | 固定値 "session" |
status | string | キャンセル確認値。最新のコードではこのレスポンスボディに "canceling" を返します。 |
canceling は中間状態で、キャンセル指令が送信されたことを示します。中断完了後、最終状態は idle に戻ります。SSE ストリームで session.status_idle イベントを監視することで確認できます。
エラーレスポンス
| HTTP | type | 説明 |
|---|
| 401 | authentication_error | PAT が無効または期限切れ |
| 404 | not_found_error | Session が存在しない |
関連項目
Session の起動
Agent を環境で実行し、ステートフルな対話を行う。
