Skip to main content
Dreams

Dream のキャンセル

実行待ちまたは実行中の Dream をキャンセルします。

POST /api/v1/forward/dreams/{id}/cancel pending または running 状態の Dream のみキャンセルできます。キャンセル済みの Dream に対する再呼び出しでは、冪等に現在のオブジェクトを返します。

ヘッダー

Header必須説明
AuthorizationはいBearer <PAT or admin SAT>。

パスパラメーター

パラメーター型必須説明
idstringはいdrm_ プレフィックスを持つ Dream ID。

リクエスト例

curl -s -X POST 'https://api.qoder.com/api/v1/forward/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": "",
  "usage": {
    "input_tokens": 1000,
    "output_tokens": 200,
    "cache_creation_input_tokens": 0,
    "cache_read_input_tokens": 500
  },
  "error": null,
  "created_at": "2026-09-15T03:00:00Z",
  "ended_at": "2026-09-15T03:01:15Z",
  "archived_at": null
}

レスポンスフィールド

フィールド型説明
戻り値objectキャンセル後の Dream オブジェクト。status は canceled です。

エラー

HTTPType発生条件
400invalid_request_errorid が無効、リクエストボディが空でない、または Dream がキャンセルできない終端状態です。error.code は invalid_dream_id、invalid_request_body、dream_not_cancelable のいずれかです。
401authentication_error認証情報がないか、無効または期限切れです。
403permission_errorトークンに Dream の管理権限がありません。この API は Identity SAT に対応していません。
404not_found_errorDream が存在しないか、呼び出し元から参照できません。error.code は dream_not_found です。
429rate_limit_errorリクエスト頻度の上限に達しています。
500/502/503api_errorサービスまたは内部の依存サービスが一時的に利用できません。

関連