メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.qoder.com/llms.txt

Use this file to discover all available pages before exploring further.

POST /v1/sessions/{session_id}/cancel 処理中の Session をキャンセルします。processing 状態のときに cancel を呼び出した場合のみ Agent 実行が実際に中断されます:状態は canceling に遷移し、中断完了後に自動的に idle に戻ります。Session は引き続き再利用可能です——次の user.message をそのまま送信できます(新しい Session を作成する必要はありません)。すでに idle の Session に対する cancel は no-op で、同じく 200 を返し、状態は idle のまま維持されます。

パスパラメータ

パラメータ説明
session_idstringSession ID(sess_ プレフィックス)

ヘッダー

名称必須
AuthorizationはいBearer $QODER_PAT
Content-Typeはいapplication/json

リクエスト例

curl -X POST https://api.qoder.com/api/v1/cloud/sessions/sess_019e3bb1e8c171fd9abbb1477ffb84cc/cancel \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json"

レスポンス例

HTTP 200 OK 簡略化された状態確認オブジェクトを返します。
{
  "id": "sess_019e3bb1e8c171fd9abbb1477ffb84cc",
  "type": "session",
  "status": "canceling"
}

レスポンスフィールド

フィールド説明
idstringSession ID
typestring固定値 "session"
statusstringキャンセル後の状態、値は "canceling"
メモ: canceling は中間状態で、キャンセル指令が送信されたことを示します。中断完了後、最終状態は idle に戻ります。SSE ストリームで session.status_idle イベントを監視することで確認できます。

エラーレスポンス

HTTPtype説明
401authentication_errorPAT が無効または期限切れ
404not_found_errorSession が存在しない