Cancel a Dream

POST /api/v1/forward/dreams/{id}/cancel Only Dreams in the pending or running state can be canceled. Calling this endpoint again for an already canceled Dream returns the current object idempotently.

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <PAT or admin SAT>`.

Path parameters

Parameter	Type	Required	Description
`id`	string	Yes	Dream ID with the `drm_` prefix.

Example request

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

Example response

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
}

Response fields

Field	Type	Description
Return value	object	The canceled Dream object, with `status` set to `canceled`.

Errors

HTTP	Type	Trigger
`400`	`invalid_request_error`	Invalid `id`, non-empty request body, or the Dream is in a terminal state that cannot be canceled. `error.code` can be `invalid_dream_id`, `invalid_request_body`, or `dream_not_cancelable`.
`401`	`authentication_error`	Authentication is missing, invalid, or expired.
`403`	`permission_error`	The token cannot manage Dreams. Identity SAT is not supported by this endpoint.
`404`	`not_found_error`	The Dream does not exist or is not visible to the caller. `error.code` is `dream_not_found`.
`429`	`rate_limit_error`	The request rate limit has been reached.
`500/502/503`	`api_error`	The service or an internal dependency is temporarily unavailable.

Cancel a Dream

Headers

Path parameters

Example request

Example response

Response fields

Errors

Get a Dream

Archive a Dream

​Headers

​Path parameters

​Example request

​Example response

​Response fields

​Errors

​Related

Get a Dream

Archive a Dream

Headers

Path parameters

Example request

Example response

Response fields

Errors

Related