メインコンテンツへスキップ
POST /api/v1/forward/sessions/{session_id}/cancel 現在のターンのキャンセルを要求します。実行中のターンがない場合、このエンドポイントはキャンセルを開始せずに成功を返します。

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>
Idempotency-KeyNo安全でないリクエスト向けの任意の冪等性キー。

Path parameters

ParameterTypeRequiredDescription
session_idstringYesSession ID。

Example request

curl -s -X POST 'https://api.qoder.com/api/v1/forward/sessions/sess_xxx/cancel' \
  -H "Authorization: Bearer $QODER_PAT"

Example response

HTTP 202 Accepted
{
  "id": "sess_xxx",
  "type": "session",
  "status": "canceling"
}

Response fields

FieldTypeDescription
idstringSession ID。
typestring常に session
statusstringキャンセルが受理されると canceling

Errors

HTTPTypeCodeTrigger
401authentication_errorauthentication_requiredPAT が無効または期限切れ。
404not_found_errorsession_not_foundSession が存在しない。
409conflict_errorsession_archivedSession がアーカイブ済み。
502api_errorruntime_unavailableランタイムセッションサービスが利用できない。

Notes

  • 202 Accepted はキャンセルが要求されたことを意味します。
  • 200 OK はキャンセル対象の実行中ターンがなかったことを意味します。
  • 完了は Event Stream または Session ステータスのポーリングで確認してください。

セッションイベントのストリーミング

セッションイベントの送信