Dreams changedapi/beta/dreams
Recorded here
Lines+50added
Lines−50removed
From line
13
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits20to this page, all time
The whole hunk
from line 13, old and new numbered
/
from line 13
1313
1414By default the dream writes its result to a new memory store and doesn't change the input memory store. The response has `status` set to `pending` and an empty `outputs` array. Poll the dream until `status` is `completed`, `failed`, or `canceled`.
1515
16See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#create-a-dream) to learn more about creating dreams.
16See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#create-a-dream) to learn more about creating dreams.
1717
1818### Headers
1919
from line 165
165165
166166 Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order.
167167
168 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists all the limits on a dream.
168 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream.
169169
170170- `model: string or BetaDreamModelConfigParam`
171171
from line 173
173173
174174 In the object form, `speed` can only be `standard`.
175175
176 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists the supported models.
176 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists the supported models.
177177
178178 - `string`
179179
from line 187
187187
188188 The ID can be 1 to 256 characters long.
189189
190 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists the supported models.
190 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists the supported models.
191191
192192 minLength: 1, maxLength: 256
193193
from line 205
205205
206206 Guidance that steers how the dream reads the sessions and organizes the output memory store, from 1 to 4,096 characters.
207207
208 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#steer-with-instructions) for what kinds of instructions work well.
208 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#steer-with-instructions) for what kinds of instructions work well.
209209
210210 minLength: 1, maxLength: 4096
211211
from line 245
245245
246246 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.
247247
248 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#how-it-works) for what a dream reads and produces.
248 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces.
249249
250250 - `type: "dream"`
251251
from line 281
281281
282282 A code for why the dream failed, such as `timeout` or `internal_error`.
283283
284 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#errors) lists common error codes and when they occur.
284 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur.
285285
286286 - `message: string`
287287
from line 319
319319
320320 Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order.
321321
322 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists all the limits on a dream.
322 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream.
323323
324324 - `instructions: string or null`
325325
from line 377
377377
378378 The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`.
379379
380 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#use-the-output) for how to review and use the result.
380 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result.
381381
382382 - `type: "memory_store"`
383383
from line 393
393393
394394 Stream that session's events to follow what the dream reads and writes.
395395
396 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#watch-the-pipeline-run) for how to watch a running dream.
396 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream.
397397
398398 - `status: BetaDreamStatus`
399399
from line 401
401401
402402 `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again.
403403
404 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#lifecycle) for what each status means.
404 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means.
405405
406406 - `"pending"`
407407
from line 530
530530
531531Archived dreams are left out unless `include_archived` is `true`.
532532
533See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#list-dreams) for how to page through dreams.
533See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#list-dreams) for how to page through dreams.
534534
535535### Query parameters
536536
from line 752
752752
753753 A code for why the dream failed, such as `timeout` or `internal_error`.
754754
755 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#errors) lists common error codes and when they occur.
755 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur.
756756
757757 - `message: string`
758758
from line 790
790790
791791 Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order.
792792
793 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists all the limits on a dream.
793 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream.
794794
795795 - `instructions: string or null`
796796
from line 848
848848
849849 The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`.
850850
851 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#use-the-output) for how to review and use the result.
851 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result.
852852
853853 - `type: "memory_store"`
854854
from line 864
864864
865865 Stream that session's events to follow what the dream reads and writes.
866866
867 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#watch-the-pipeline-run) for how to watch a running dream.
867 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream.
868868
869869 - `status: BetaDreamStatus`
870870
from line 872
872872
873873 `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again.
874874
875 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#lifecycle) for what each status means.
875 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means.
876876
877877 - `"pending"`
878878
from line 1002
10021002
10031003Archived dreams are returned too.
10041004
1005See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#track-progress) for how to poll a dream and what each status means.
1005See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#track-progress) for how to poll a dream and what each status means.
10061006
10071007### Path parameters
10081008
from line 1136
11361136
11371137 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.
11381138
1139 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#how-it-works) for what a dream reads and produces.
1139 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces.
11401140
11411141 - `type: "dream"`
11421142
from line 1172
11721172
11731173 A code for why the dream failed, such as `timeout` or `internal_error`.
11741174
1175 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#errors) lists common error codes and when they occur.
1175 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur.
11761176
11771177 - `message: string`
11781178
from line 1210
12101210
12111211 Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order.
12121212
1213 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists all the limits on a dream.
1213 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream.
12141214
12151215 - `instructions: string or null`
12161216
from line 1268
12681268
12691269 The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`.
12701270
1271 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#use-the-output) for how to review and use the result.
1271 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result.
12721272
12731273 - `type: "memory_store"`
12741274
from line 1284
12841284
12851285 Stream that session's events to follow what the dream reads and writes.
12861286
1287 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#watch-the-pipeline-run) for how to watch a running dream.
1287 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream.
12881288
12891289 - `status: BetaDreamStatus`
12901290
from line 1292
12921292
12931293 `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again.
12941294
1295 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#lifecycle) for what each status means.
1295 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means.
12961296
12971297 - `"pending"`
12981298
from line 1411
14111411
14121412The 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.
14131413
1414See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#cancel-a-dream) to learn more about canceling dreams.
1414See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#cancel-a-dream) to learn more about canceling dreams.
14151415
14161416### Path parameters
14171417
from line 1545
15451545
15461546 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.
15471547
1548 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#how-it-works) for what a dream reads and produces.
1548 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces.
15491549
15501550 - `type: "dream"`
15511551
from line 1581
15811581
15821582 A code for why the dream failed, such as `timeout` or `internal_error`.
15831583
1584 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#errors) lists common error codes and when they occur.
1584 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur.
15851585
15861586 - `message: string`
15871587
from line 1619
16191619
16201620 Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order.
16211621
1622 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists all the limits on a dream.
1622 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream.
16231623
16241624 - `instructions: string or null`
16251625
from line 1677
16771677
16781678 The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`.
16791679
1680 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#use-the-output) for how to review and use the result.
1680 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result.
16811681
16821682 - `type: "memory_store"`
16831683
from line 1693
16931693
16941694 Stream that session's events to follow what the dream reads and writes.
16951695
1696 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#watch-the-pipeline-run) for how to watch a running dream.
1696 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream.
16971697
16981698 - `status: BetaDreamStatus`
16991699
from line 1701
17011701
17021702 `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again.
17031703
1704 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#lifecycle) for what each status means.
1704 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means.
17051705
17061706 - `"pending"`
17071707
from line 1821
18211821
18221822Archiving a `pending` or `running` dream returns a 400 error, so cancel it first. Archiving an archived dream returns it unchanged. An archived dream can still be fetched by ID. Archiving can't be undone.
18231823
1824See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#archive-a-dream) to learn more about archiving dreams.
1824See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#archive-a-dream) to learn more about archiving dreams.
18251825
18261826### Path parameters
18271827
from line 1955
19551955
19561956 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.
19571957
1958 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#how-it-works) for what a dream reads and produces.
1958 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces.
19591959
19601960 - `type: "dream"`
19611961
from line 1991
19911991
19921992 A code for why the dream failed, such as `timeout` or `internal_error`.
19931993
1994 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#errors) lists common error codes and when they occur.
1994 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur.
19951995
19961996 - `message: string`
19971997
from line 2029
20292029
20302030 Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order.
20312031
2032 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists all the limits on a dream.
2032 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream.
20332033
20342034 - `instructions: string or null`
20352035
from line 2087
20872087
20882088 The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`.
20892089
2090 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#use-the-output) for how to review and use the result.
2090 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result.
20912091
20922092 - `type: "memory_store"`
20932093
from line 2103
21032103
21042104 Stream that session's events to follow what the dream reads and writes.
21052105
2106 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#watch-the-pipeline-run) for how to watch a running dream.
2106 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream.
21072107
21082108 - `status: BetaDreamStatus`
21092109
from line 2111
21112111
21122112 `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again.
21132113
2114 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#lifecycle) for what each status means.
2114 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means.
21152115
21162116 - `"pending"`
21172117
from line 2235
22352235
22362236 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.
22372237
2238 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#how-it-works) for what a dream reads and produces.
2238 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces.
22392239
22402240 - `type: "dream"`
22412241
from line 2271
22712271
22722272 A code for why the dream failed, such as `timeout` or `internal_error`.
22732273
2274 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#errors) lists common error codes and when they occur.
2274 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur.
22752275
22762276 - `message: string`
22772277
from line 2309
23092309
23102310 Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order.
23112311
2312 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists all the limits on a dream.
2312 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream.
23132313
23142314 - `instructions: string or null`
23152315
from line 2367
23672367
23682368 The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`.
23692369
2370 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#use-the-output) for how to review and use the result.
2370 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result.
23712371
23722372 - `type: "memory_store"`
23732373
from line 2383
23832383
23842384 Stream that session's events to follow what the dream reads and writes.
23852385
2386 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#watch-the-pipeline-run) for how to watch a running dream.
2386 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream.
23872387
23882388 - `status: BetaDreamStatus`
23892389
from line 2391
23912391
23922392 `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again.
23932393
2394 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#lifecycle) for what each status means.
2394 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means.
23952395
23962396 - `"pending"`
23972397
from line 2459
24592459
24602460 A code for why the dream failed, such as `timeout` or `internal_error`.
24612461
2462 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#errors) lists common error codes and when they occur.
2462 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur.
24632463
24642464 - `message: string`
24652465
from line 2499
24992499
25002500 Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order.
25012501
2502 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists all the limits on a dream.
2502 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream.
25032503
25042504### Beta Dream Memory Store Input
25052505
from line 2567
25672567
25682568 The ID can be 1 to 256 characters long.
25692569
2570 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists the supported models.
2570 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists the supported models.
25712571
25722572 minLength: 1, maxLength: 256
25732573
from line 2609
26092609
26102610 Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order.
26112611
2612 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists all the limits on a dream.
2612 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream.
26132613
26142614### Beta Dream Status
26152615
from line 2619
26192619
26202620 `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again.
26212621
2622 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#lifecycle) for what each status means.
2622 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means.
26232623
26242624 - `"pending"`
26252625
from line 2657
26572657
26582658 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
26592659
2660 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
2660 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http#tracking-cache-performance) for how the input token counts add up.
26612661
26622662 - `cache_creation_input_tokens: number`
26632663
No line in this hunk matches that.