Cancel a Dream changedapi/beta/dreams/cancel
Nearest release: v2.1.268, published under an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
Recorded here
Lines+22added
Lines−13removed
From line
1
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits24to this page, all time
The whole hunk
from line 1, old and new numbered
/
from line 1
1---
2title: Cancel a Dream
3url: https://platform.claude.com/docs/en/api/beta/dreams/cancel
4---
5
16# Cancel a Dream
27
38**POST** `/v1/dreams/{dream_id}/cancel`
from line 21
1621
1722 - `string`
1823
19 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2025
2126 - `"message-batches-2024-09-24"`
2227
from line 69
6469
6570 - `"user-profiles-2026-08-18"`
6671
72 - `"user-profiles-2026-09-04"`
73
6774 - `"advisor-tool-2026-03-01"`
6875
6976 - `"managed-agents-2026-04-01"`
from line 113
106113
107114 - `"mid-conversation-system-clear-at-2026-08-21"`
108115
116- `"anthropic-workspace-id": optional string`
117
109118## Returns
110119
111120- `BetaDream object`
from line 121
112121
113122 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into an output memory store — a new store by default, or an existing store chosen via output_behavior. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
114123
124 - `type: "dream"`
125
115126 - `id: string`
116127
117128 - `archived_at: string or null`
from line 147
136147
137148 Failure detail for a Dream whose `status` is `failed`.
138149
139 - `message: string`
140
141150 - `type: string`
142151
152 - `message: string`
153
143154 - `inputs: array of BetaDreamInput`
144155
145156 - `BetaDreamMemoryStoreInput object`
from line 157
146157
147158 An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: "update_existing"} the job consolidates this store in place.
148159
160 - `type: "memory_store"`
161
149162 - `memory_store_id: string`
150163
151164 minLength: 1
152165
153 - `type: "memory_store"`
154
155166 - `BetaDreamSessionsInput object`
156167
157168 Input session transcripts the dream reads.
158169
159 - `session_ids: array of string`
160
161170 - `type: "sessions"`
162171
172 - `session_ids: array of string`
173
163174 - `instructions: string or null`
164175
165176 - `model: BetaDreamModelConfig`
from line 205
194205
195206 The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.
196207
208 - `type: "update_existing"`
209
197210 - `memory_store_id: string`
198211
199212 minLength: 1
200213
201 - `type: "update_existing"`
202
203214 - `outputs: array of BetaDreamOutput`
204215
205 - `memory_store_id: string`
206
207216 - `type: "memory_store"`
208217
218 - `memory_store_id: string`
219
209220 - `session_id: string or null`
210221
211222 - `status: BetaDreamStatus`
from line 232
221232 - `"failed"`
222233
223234 - `"canceled"`
224
225 - `type: "dream"`
226235
227236 - `usage: BetaDreamUsage`
228237
No line in this hunk matches that.