メインコンテンツへスキップ
POST /v1/dreams/{id}/cancel 指定された Dream をキャンセルします。ステータスが pending または running の Dream のみキャンセル可能です。すでにキャンセル済みの Dream に対する cancel 呼び出しは冪等です。更新された Dream オブジェクト を返します。

ヘッダー

ヘッダー必須説明
AuthorizationはいBearer <PAT>

パスパラメータ

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

リクエスト例

curl -s -X POST 'https://api.qoder.com/api/v1/cloud/dreams/drm_019e86b4a8f070a3b6c5d4e3f2a1b0c9/cancel' \
  -H "Authorization: Bearer $QODER_PAT"

レスポンス例

HTTP 200 OK
{
  "id": "drm_019e86b4a8f070a3b6c5d4e3f2a1b0c9",
  "type": "dream",
  "status": "canceled",
  "inputs": [{ "type": "memory_store", "memory_store_id": "memstore_019e5cdb9c3f71c3b6505eba937a40b4" }],
  "outputs": [],
  "model": { "id": "auto" },
  "instructions": "",
  "session_id": "sess_019e86b4b10578059435632bb357c5ed",
  "usage": { "input_tokens": 0, "output_tokens": 0, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0 },
  "error": null,
  "created_at": "2026-06-15T10:00:00Z",
  "ended_at": "2026-06-15T10:01:15Z",
  "archived_at": null
}

エラー

HTTP種別トリガー
400invalid_request_errorDream が completed または failed(終了状態、キャンセル不可)。canceled は冪等で 200 を返す
401authentication_error認証トークンが欠落または無効
404not_found_errorDream が存在しない
完全なエラーエンベロープは エラーリファレンス を参照してください。