メインコンテンツへスキップ
POST /api/v1/cloud/sessions/{session_id}/cancel Session の現在のターンのキャンセルを要求します。実行中の Session への cancel は HTTP 202 Accepted を返し、Session は canceling を経て idle に戻ります。アイドル状態の Session への cancel は安全な no-op で、HTTP 200 OK を返します。

​
パスパラメータ

パラメータ型説明
session_idstringsess_ プレフィックスを持つ Session ID

​
ヘッダー

ヘッダー必須説明
AuthorizationはいBearer $QODER_PAT

​
リクエスト例

curl -X POST https://api.qoder.com/api/v1/cloud/sessions/sess_019ef30a4f0275678965d496ab542ef0/cancel \
  -H "Authorization: Bearer $QODER_PAT"

​
レスポンス例

HTTP 200 OK(no-op)または HTTP 202 Accepted(キャンセル適用) 
{
  "id": "sess_019ef30a4f0275678965d496ab542ef0",
  "type": "session",
  "status": "canceling"
}
status フィールドはどちらの場合も "canceling" です。ターンが中断された後、Session は idle に戻ります。

​
エラー

HTTPType発生条件
401authentication_errorPAT が無効または期限切れ
404not_found_errorSession が存在しないか、アーカイブ済み
注意: すでにアイドル状態の Session に対する cancel は安全な no-op で、HTTP 200 を返します。レスポンスは、キャンセルが適用された場合(202)か no-op だった場合(200)かに関わらず、常に同じ軽量フォーマットを使用します。
HTTP 404 Not Found 
{
  "type": "error",
  "request_id": "cb80235f-76a2-4ff3-9e28-5aa2da12dc14",
  "error": {
    "type": "not_found_error",
    "message": "Session 'sess_does_not_exist_0000000000000000000000000000' was not found."
  }
}
完全なエラーエンベロープについては Errors を参照してください。

​
関連項目

Session の起動

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