Cancel a Dream
Changed onStop a pending or running dream.
The response shows status as canceled, unless the dream reached completed or failed first. usage can keep changing after the response. Canceling a canceled dream returns it unchanged. Canceling a completed or failed dream returns a 400 error.
See the Dreams guide to learn more about canceling dreams.
Request
- Base URLhttps://api.anthropic.com
- Authnone declared
Path parameters
The ID of the dream to cancel (drm_...).
Headers
The version of the Claude API you want to use.
Read more about versioning and our version history here.
Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).
Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
Response
Successful response (OK)
Changes
- info
added the enum value
user-profiles-billing-2026-10-01to the propertyitems/anyOf[subschema #2]/of theheaderrequest parameteranthropic-beta
- info
- info
added the enum value
admin-user-sign-out-2026-10-08to the propertyitems/anyOf[subschema #2]/of theheaderrequest parameteranthropic-beta
- info