Dreams changedapi/beta/dreams
Nearest release: v2.1.245, published 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+228added
Lines−179removed
From line
1
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits21to this page, all time
### Headers ### Body parameters #### Response (200) ### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ### Header Parameters ### Body Parameters #### Response ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types
The whole hunk
from line 1, old and new numbered
/
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 1
1---
2title: Dreams
3url: https://platform.claude.com/docs/en/api/beta/dreams
4---
5
61# Dreams
72
83## Create a Dream
94
10**post** `/v1/dreams`
5**POST** `/v1/dreams`
116
127Create a Dream
138
14### Header Parameters
9### Headers
1510
1611- `"anthropic-beta": optional array of AnthropicBeta`
1712
from line 84
8984
9085 - `"mid-conversation-tool-changes-2026-07-01"`
9186
92### Body Parameters
87### Body parameters
9388
9489- `inputs: array of BetaDreamInput`
9590
96 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
91 - `BetaDreamMemoryStoreInput object`
9792
9893 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.
9994
10095 - `memory_store_id: string`
10196
97 minLength: 1
98
10299 - `type: "memory_store"`
103100
104 - `"memory_store"`
105
106 - `BetaDreamSessionsInput object { session_ids, type }`
101 - `BetaDreamSessionsInput object`
107102
108103 Input session transcripts the dream reads.
109104
from line 106
111106
112107 - `type: "sessions"`
113108
114 - `"sessions"`
115
116109- `model: string or BetaDreamModelConfigParam`
117110
118111 Model identifier and configuration applied to every pipeline stage.
119112
120113 - `string`
121114
122 - `BetaDreamModelConfigParam object { id, speed }`
115 - `BetaDreamModelConfigParam object`
123116
124117 Model identifier and configuration applied to every pipeline stage.
125118
from line 120
127120
128121 Model identifier, e.g. "claude-opus-5". 1-256 characters.
129122
123 minLength: 1, maxLength: 256
124
130125 - `speed: optional "standard" or "fast" or null`
131126
132127 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
from line 132
137132
138133- `instructions: optional string or null`
139134
135 minLength: 1, maxLength: 4096
136
140137- `output_behavior: optional BetaOutputBehavior`
141138
142139 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
143140
144 - `BetaOutputBehaviorCreateNew object { type }`
141 - `BetaOutputBehaviorCreateNew object`
145142
146143 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
147144
148145 - `type: "create_new"`
149146
150 - `"create_new"`
151
152 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
147 - `BetaOutputBehaviorUpdateExisting object`
153148
154149 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.
155150
156151 - `memory_store_id: string`
157152
153 minLength: 1
154
158155 - `type: "update_existing"`
159156
160 - `"update_existing"`
161
162157### Returns
163158
164- `BetaDream object { id, archived_at, created_at, 11 more }`
159- `BetaDream object`
165160
166161 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.
167162
from line 166
171166
172167 A timestamp in RFC 3339 format
173168
169 format: date-time
170
174171 - `created_at: string`
175172
176173 A timestamp in RFC 3339 format
177174
175 format: date-time
176
178177 - `ended_at: string or null`
179178
180179 A timestamp in RFC 3339 format
181180
181 format: date-time
182
182183 - `error: BetaDreamError or null`
183184
184185 Failure detail for a Dream whose `status` is `failed`.
from line 190
189190
190191 - `inputs: array of BetaDreamInput`
191192
192 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
193 - `BetaDreamMemoryStoreInput object`
193194
194195 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.
195196
196197 - `memory_store_id: string`
197198
199 minLength: 1
200
198201 - `type: "memory_store"`
199202
200 - `"memory_store"`
201
202 - `BetaDreamSessionsInput object { session_ids, type }`
203 - `BetaDreamSessionsInput object`
203204
204205 Input session transcripts the dream reads.
205206
from line 208
207208
208209 - `type: "sessions"`
209210
210 - `"sessions"`
211
212211 - `instructions: string or null`
213212
214213 - `model: BetaDreamModelConfig`
from line 218
219218
220219 Model identifier, e.g. "claude-opus-5". 1-256 characters.
221220
221 minLength: 1, maxLength: 256
222
222223 - `speed: optional "standard" or "fast"`
223224
224225 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
from line 232
231232
232233 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
233234
234 - `BetaOutputBehaviorCreateNew object { type }`
235 - `BetaOutputBehaviorCreateNew object`
235236
236237 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
237238
238239 - `type: "create_new"`
239240
240 - `"create_new"`
241
242 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
241 - `BetaOutputBehaviorUpdateExisting object`
243242
244243 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.
245244
246245 - `memory_store_id: string`
247246
247 minLength: 1
248
248249 - `type: "update_existing"`
249250
250 - `"update_existing"`
251
252251 - `outputs: array of BetaDreamOutput`
253252
254253 - `memory_store_id: string`
255254
256255 - `type: "memory_store"`
257256
258 - `"memory_store"`
259
260257 - `session_id: string or null`
261258
262259 - `status: BetaDreamStatus`
from line 272
275272
276273 - `type: "dream"`
277274
278 - `"dream"`
279
280275 - `usage: BetaDreamUsage`
281276
282277 Cumulative token usage for the dream across every pipeline stage.
from line 280
285280
286281 Total tokens used to create prompt-cache entries (sum of all TTL tiers).
287282
283 format: int32
284
288285 - `cache_read_input_tokens: number`
289286
290287 Total tokens read from prompt cache.
291288
289 format: int32
290
292291 - `input_tokens: number`
293292
294293 Total uncached input tokens consumed across every pipeline stage.
295294
295 format: int32
296
296297 - `output_tokens: number`
297298
298299 Total output tokens generated across every pipeline stage.
299300
301 format: int32
302
300303### Example
301304
302```http
305```bash
303306curl https://api.anthropic.com/v1/dreams \
304307 -H 'Content-Type: application/json' \
305308 -H 'anthropic-version: 2023-06-01' \
from line 319
316319 }'
317320```
318321
319#### Response
322#### Response (200)
320323
321324```json
322325{
from line 365
362365
363366## List Dreams
364367
365**get** `/v1/dreams`
368**GET** `/v1/dreams`
366369
367370List Dreams
368371
369### Query Parameters
372### Query parameters
370373
371374- `"created_at[gt]": optional string`
372375
373376 Return dreams with `created_at` strictly after this timestamp (exclusive lower bound, RFC 3339). Unset applies no lower bound.
374377
378 format: date-time
379
375380- `"created_at[lt]": optional string`
376381
377382 Return dreams with `created_at` strictly before this timestamp (exclusive upper bound, RFC 3339). Unset applies no upper bound.
378383
384 format: date-time
385
379386- `include_archived: optional boolean`
380387
381388 Query parameter for include_archived
from line 391
384391
385392 Query parameter for limit
386393
394 format: int32
395
387396- `page: optional string`
388397
389398 Query parameter for page
from line 411
402411
403412 - `"canceled"`
404413
405### Header Parameters
414### Headers
406415
407416- `"anthropic-beta": optional array of AnthropicBeta`
408417
from line 499
490499
491500 A timestamp in RFC 3339 format
492501
502 format: date-time
503
493504 - `created_at: string`
494505
495506 A timestamp in RFC 3339 format
496507
508 format: date-time
509
497510 - `ended_at: string or null`
498511
499512 A timestamp in RFC 3339 format
500513
514 format: date-time
515
501516 - `error: BetaDreamError or null`
502517
503518 Failure detail for a Dream whose `status` is `failed`.
from line 523
508523
509524 - `inputs: array of BetaDreamInput`
510525
511 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
526 - `BetaDreamMemoryStoreInput object`
512527
513528 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.
514529
515530 - `memory_store_id: string`
516531
532 minLength: 1
533
517534 - `type: "memory_store"`
518535
519 - `"memory_store"`
520
521 - `BetaDreamSessionsInput object { session_ids, type }`
536 - `BetaDreamSessionsInput object`
522537
523538 Input session transcripts the dream reads.
524539
from line 541
526541
527542 - `type: "sessions"`
528543
529 - `"sessions"`
530
531544 - `instructions: string or null`
532545
533546 - `model: BetaDreamModelConfig`
from line 551
538551
539552 Model identifier, e.g. "claude-opus-5". 1-256 characters.
540553
554 minLength: 1, maxLength: 256
555
541556 - `speed: optional "standard" or "fast"`
542557
543558 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
from line 565
550565
551566 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
552567
553 - `BetaOutputBehaviorCreateNew object { type }`
568 - `BetaOutputBehaviorCreateNew object`
554569
555570 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
556571
557572 - `type: "create_new"`
558573
559 - `"create_new"`
560
561 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
574 - `BetaOutputBehaviorUpdateExisting object`
562575
563576 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.
564577
565578 - `memory_store_id: string`
566579
580 minLength: 1
581
567582 - `type: "update_existing"`
568583
569 - `"update_existing"`
570
571584 - `outputs: array of BetaDreamOutput`
572585
573586 - `memory_store_id: string`
574587
575588 - `type: "memory_store"`
576589
577 - `"memory_store"`
578
579590 - `session_id: string or null`
580591
581592 - `status: BetaDreamStatus`
from line 605
594605
595606 - `type: "dream"`
596607
597 - `"dream"`
598
599608 - `usage: BetaDreamUsage`
600609
601610 Cumulative token usage for the dream across every pipeline stage.
from line 613
604613
605614 Total tokens used to create prompt-cache entries (sum of all TTL tiers).
606615
616 format: int32
617
607618 - `cache_read_input_tokens: number`
608619
609620 Total tokens read from prompt cache.
610621
622 format: int32
623
611624 - `input_tokens: number`
612625
613626 Total uncached input tokens consumed across every pipeline stage.
614627
628 format: int32
629
615630 - `output_tokens: number`
616631
617632 Total output tokens generated across every pipeline stage.
618633
634 format: int32
635
619636- `next_page: string or null`
620637
621638### Example
622639
623```http
640```bash
624641curl https://api.anthropic.com/v1/dreams \
625642 -H 'anthropic-version: 2023-06-01' \
626643 -H 'anthropic-beta: dreaming-2026-04-21' \
627644 -H "X-Api-Key: $ANTHROPIC_API_KEY"
628645```
629646
630#### Response
647#### Response (200)
631648
632649```json
633650{
from line 695
678695
679696## Get a Dream
680697
681**get** `/v1/dreams/{dream_id}`
698**GET** `/v1/dreams/{dream_id}`
682699
683700Get a Dream
684701
685### Path Parameters
702### Path parameters
686703
687704- `dream_id: string`
688705
689### Header Parameters
706### Headers
690707
691708- `"anthropic-beta": optional array of AnthropicBeta`
692709
from line 783
766783
767784### Returns
768785
769- `BetaDream object { id, archived_at, created_at, 11 more }`
786- `BetaDream object`
770787
771788 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.
772789
from line 793
776793
777794 A timestamp in RFC 3339 format
778795
796 format: date-time
797
779798 - `created_at: string`
780799
781800 A timestamp in RFC 3339 format
782801
802 format: date-time
803
783804 - `ended_at: string or null`
784805
785806 A timestamp in RFC 3339 format
786807
808 format: date-time
809
787810 - `error: BetaDreamError or null`
788811
789812 Failure detail for a Dream whose `status` is `failed`.
from line 817
794817
795818 - `inputs: array of BetaDreamInput`
796819
797 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
820 - `BetaDreamMemoryStoreInput object`
798821
799822 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.
800823
801824 - `memory_store_id: string`
802825
826 minLength: 1
827
803828 - `type: "memory_store"`
804829
805 - `"memory_store"`
806
807 - `BetaDreamSessionsInput object { session_ids, type }`
830 - `BetaDreamSessionsInput object`
808831
809832 Input session transcripts the dream reads.
810833
from line 835
812835
813836 - `type: "sessions"`
814837
815 - `"sessions"`
816
817838 - `instructions: string or null`
818839
819840 - `model: BetaDreamModelConfig`
from line 845
824845
825846 Model identifier, e.g. "claude-opus-5". 1-256 characters.
826847
848 minLength: 1, maxLength: 256
849
827850 - `speed: optional "standard" or "fast"`
828851
829852 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
from line 859
836859
837860 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
838861
839 - `BetaOutputBehaviorCreateNew object { type }`
862 - `BetaOutputBehaviorCreateNew object`
840863
841864 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
842865
843866 - `type: "create_new"`
844867
845 - `"create_new"`
846
847 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
868 - `BetaOutputBehaviorUpdateExisting object`
848869
849870 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.
850871
851872 - `memory_store_id: string`
852873
874 minLength: 1
875
853876 - `type: "update_existing"`
854877
855 - `"update_existing"`
856
857878 - `outputs: array of BetaDreamOutput`
858879
859880 - `memory_store_id: string`
860881
861882 - `type: "memory_store"`
862883
863 - `"memory_store"`
864
865884 - `session_id: string or null`
866885
867886 - `status: BetaDreamStatus`
from line 899
880899
881900 - `type: "dream"`
882901
883 - `"dream"`
884
885902 - `usage: BetaDreamUsage`
886903
887904 Cumulative token usage for the dream across every pipeline stage.
from line 907
890907
891908 Total tokens used to create prompt-cache entries (sum of all TTL tiers).
892909
910 format: int32
911
893912 - `cache_read_input_tokens: number`
894913
895914 Total tokens read from prompt cache.
896915
916 format: int32
917
897918 - `input_tokens: number`
898919
899920 Total uncached input tokens consumed across every pipeline stage.
900921
922 format: int32
923
901924 - `output_tokens: number`
902925
903926 Total output tokens generated across every pipeline stage.
904927
928 format: int32
929
905930### Example
906931
907```http
932```bash
908933curl https://api.anthropic.com/v1/dreams/$DREAM_ID \
909934 -H 'anthropic-version: 2023-06-01' \
910935 -H 'anthropic-beta: dreaming-2026-04-21' \
911936 -H "X-Api-Key: $ANTHROPIC_API_KEY"
912937```
913938
914#### Response
939#### Response (200)
915940
916941```json
917942{
from line 982
957982
958983## Cancel a Dream
959984
960**post** `/v1/dreams/{dream_id}/cancel`
985**POST** `/v1/dreams/{dream_id}/cancel`
961986
962987Cancel a Dream
963988
964### Path Parameters
989### Path parameters
965990
966991- `dream_id: string`
967992
968### Header Parameters
993### Headers
969994
970995- `"anthropic-beta": optional array of AnthropicBeta`
971996
from line 1070
10451070
10461071### Returns
10471072
1048- `BetaDream object { id, archived_at, created_at, 11 more }`
1073- `BetaDream object`
10491074
10501075 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.
10511076
from line 1080
10551080
10561081 A timestamp in RFC 3339 format
10571082
1083 format: date-time
1084
10581085 - `created_at: string`
10591086
10601087 A timestamp in RFC 3339 format
10611088
1089 format: date-time
1090
10621091 - `ended_at: string or null`
10631092
10641093 A timestamp in RFC 3339 format
10651094
1095 format: date-time
1096
10661097 - `error: BetaDreamError or null`
10671098
10681099 Failure detail for a Dream whose `status` is `failed`.
from line 1104
10731104
10741105 - `inputs: array of BetaDreamInput`
10751106
1076 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
1107 - `BetaDreamMemoryStoreInput object`
10771108
10781109 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.
10791110
10801111 - `memory_store_id: string`
10811112
1113 minLength: 1
1114
10821115 - `type: "memory_store"`
10831116
1084 - `"memory_store"`
1085
1086 - `BetaDreamSessionsInput object { session_ids, type }`
1117 - `BetaDreamSessionsInput object`
10871118
10881119 Input session transcripts the dream reads.
10891120
from line 1122
10911122
10921123 - `type: "sessions"`
10931124
1094 - `"sessions"`
1095
10961125 - `instructions: string or null`
10971126
10981127 - `model: BetaDreamModelConfig`
from line 1132
11031132
11041133 Model identifier, e.g. "claude-opus-5". 1-256 characters.
11051134
1135 minLength: 1, maxLength: 256
1136
11061137 - `speed: optional "standard" or "fast"`
11071138
11081139 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
from line 1146
11151146
11161147 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
11171148
1118 - `BetaOutputBehaviorCreateNew object { type }`
1149 - `BetaOutputBehaviorCreateNew object`
11191150
11201151 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
11211152
11221153 - `type: "create_new"`
11231154
1124 - `"create_new"`
1125
1126 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
1155 - `BetaOutputBehaviorUpdateExisting object`
11271156
11281157 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.
11291158
11301159 - `memory_store_id: string`
11311160
1161 minLength: 1
1162
11321163 - `type: "update_existing"`
11331164
1134 - `"update_existing"`
1135
11361165 - `outputs: array of BetaDreamOutput`
11371166
11381167 - `memory_store_id: string`
11391168
11401169 - `type: "memory_store"`
11411170
1142 - `"memory_store"`
1143
11441171 - `session_id: string or null`
11451172
11461173 - `status: BetaDreamStatus`
from line 1186
11591186
11601187 - `type: "dream"`
11611188
1162 - `"dream"`
1163
11641189 - `usage: BetaDreamUsage`
11651190
11661191 Cumulative token usage for the dream across every pipeline stage.
from line 1194
11691194
11701195 Total tokens used to create prompt-cache entries (sum of all TTL tiers).
11711196
1197 format: int32
1198
11721199 - `cache_read_input_tokens: number`
11731200
11741201 Total tokens read from prompt cache.
11751202
1203 format: int32
1204
11761205 - `input_tokens: number`
11771206
11781207 Total uncached input tokens consumed across every pipeline stage.
11791208
1209 format: int32
1210
11801211 - `output_tokens: number`
11811212
11821213 Total output tokens generated across every pipeline stage.
11831214
1215 format: int32
1216
11841217### Example
11851218
1186```http
1219```bash
11871220curl https://api.anthropic.com/v1/dreams/$DREAM_ID/cancel \
11881221 -X POST \
11891222 -H 'anthropic-version: 2023-06-01' \
from line 1224
11911224 -H "X-Api-Key: $ANTHROPIC_API_KEY"
11921225```
11931226
1194#### Response
1227#### Response (200)
11951228
11961229```json
11971230{
from line 1270
12371270
12381271## Archive a Dream
12391272
1240**post** `/v1/dreams/{dream_id}/archive`
1273**POST** `/v1/dreams/{dream_id}/archive`
12411274
12421275Archive a Dream
12431276
1244### Path Parameters
1277### Path parameters
12451278
12461279- `dream_id: string`
12471280
1248### Header Parameters
1281### Headers
12491282
12501283- `"anthropic-beta": optional array of AnthropicBeta`
12511284
from line 1358
13251358
13261359### Returns
13271360
1328- `BetaDream object { id, archived_at, created_at, 11 more }`
1361- `BetaDream object`
13291362
13301363 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.
13311364
from line 1368
13351368
13361369 A timestamp in RFC 3339 format
13371370
1371 format: date-time
1372
13381373 - `created_at: string`
13391374
13401375 A timestamp in RFC 3339 format
13411376
1377 format: date-time
1378
13421379 - `ended_at: string or null`
13431380
13441381 A timestamp in RFC 3339 format
13451382
1383 format: date-time
1384
13461385 - `error: BetaDreamError or null`
13471386
13481387 Failure detail for a Dream whose `status` is `failed`.
from line 1392
13531392
13541393 - `inputs: array of BetaDreamInput`
13551394
1356 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
1395 - `BetaDreamMemoryStoreInput object`
13571396
13581397 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.
13591398
13601399 - `memory_store_id: string`
13611400
1401 minLength: 1
1402
13621403 - `type: "memory_store"`
13631404
1364 - `"memory_store"`
1365
1366 - `BetaDreamSessionsInput object { session_ids, type }`
1405 - `BetaDreamSessionsInput object`
13671406
13681407 Input session transcripts the dream reads.
13691408
from line 1410
13711410
13721411 - `type: "sessions"`
13731412
1374 - `"sessions"`
1375
13761413 - `instructions: string or null`
13771414
13781415 - `model: BetaDreamModelConfig`
from line 1420
13831420
13841421 Model identifier, e.g. "claude-opus-5". 1-256 characters.
13851422
1423 minLength: 1, maxLength: 256
1424
13861425 - `speed: optional "standard" or "fast"`
13871426
13881427 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
from line 1434
13951434
13961435 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
13971436
1398 - `BetaOutputBehaviorCreateNew object { type }`
1437 - `BetaOutputBehaviorCreateNew object`
13991438
14001439 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
14011440
14021441 - `type: "create_new"`
14031442
1404 - `"create_new"`
1405
1406 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
1443 - `BetaOutputBehaviorUpdateExisting object`
14071444
14081445 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.
14091446
14101447 - `memory_store_id: string`
14111448
1449 minLength: 1
1450
14121451 - `type: "update_existing"`
14131452
1414 - `"update_existing"`
1415
14161453 - `outputs: array of BetaDreamOutput`
14171454
14181455 - `memory_store_id: string`
14191456
14201457 - `type: "memory_store"`
14211458
1422 - `"memory_store"`
1423
14241459 - `session_id: string or null`
14251460
14261461 - `status: BetaDreamStatus`
from line 1474
14391474
14401475 - `type: "dream"`
14411476
1442 - `"dream"`
1443
14441477 - `usage: BetaDreamUsage`
14451478
14461479 Cumulative token usage for the dream across every pipeline stage.
from line 1482
14491482
14501483 Total tokens used to create prompt-cache entries (sum of all TTL tiers).
14511484
1485 format: int32
1486
14521487 - `cache_read_input_tokens: number`
14531488
14541489 Total tokens read from prompt cache.
14551490
1491 format: int32
1492
14561493 - `input_tokens: number`
14571494
14581495 Total uncached input tokens consumed across every pipeline stage.
14591496
1497 format: int32
1498
14601499 - `output_tokens: number`
14611500
14621501 Total output tokens generated across every pipeline stage.
14631502
1503 format: int32
1504
14641505### Example
14651506
1466```http
1507```bash
14671508curl https://api.anthropic.com/v1/dreams/$DREAM_ID/archive \
14681509 -X POST \
14691510 -H 'anthropic-version: 2023-06-01' \
from line 1512
14711512 -H "X-Api-Key: $ANTHROPIC_API_KEY"
14721513```
14731514
1474#### Response
1515#### Response (200)
14751516
14761517```json
14771518{
from line 1556
15151556}
15161557```
15171558
1518## Domain Types
1559## Domain types
15191560
15201561### Beta Dream
15211562
1522- `BetaDream object { id, archived_at, created_at, 11 more }`
1563- `BetaDream object`
15231564
15241565 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.
15251566
from line 1570
15291570
15301571 A timestamp in RFC 3339 format
15311572
1573 format: date-time
1574
15321575 - `created_at: string`
15331576
15341577 A timestamp in RFC 3339 format
15351578
1579 format: date-time
1580
15361581 - `ended_at: string or null`
15371582
15381583 A timestamp in RFC 3339 format
15391584
1585 format: date-time
1586
15401587 - `error: BetaDreamError or null`
15411588
15421589 Failure detail for a Dream whose `status` is `failed`.
from line 1594
15471594
15481595 - `inputs: array of BetaDreamInput`
15491596
1550 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
1597 - `BetaDreamMemoryStoreInput object`
15511598
15521599 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.
15531600
15541601 - `memory_store_id: string`
15551602
1603 minLength: 1
1604
15561605 - `type: "memory_store"`
15571606
1558 - `"memory_store"`
1559
1560 - `BetaDreamSessionsInput object { session_ids, type }`
1607 - `BetaDreamSessionsInput object`
15611608
15621609 Input session transcripts the dream reads.
15631610
from line 1612
15651612
15661613 - `type: "sessions"`
15671614
1568 - `"sessions"`
1569
15701615 - `instructions: string or null`
15711616
15721617 - `model: BetaDreamModelConfig`
from line 1622
15771622
15781623 Model identifier, e.g. "claude-opus-5". 1-256 characters.
15791624
1625 minLength: 1, maxLength: 256
1626
15801627 - `speed: optional "standard" or "fast"`
15811628
15821629 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
from line 1636
15891636
15901637 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
15911638
1592 - `BetaOutputBehaviorCreateNew object { type }`
1639 - `BetaOutputBehaviorCreateNew object`
15931640
15941641 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
15951642
15961643 - `type: "create_new"`
15971644
1598 - `"create_new"`
1599
1600 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
1645 - `BetaOutputBehaviorUpdateExisting object`
16011646
16021647 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.
16031648
16041649 - `memory_store_id: string`
16051650
1651 minLength: 1
1652
16061653 - `type: "update_existing"`
16071654
1608 - `"update_existing"`
1609
16101655 - `outputs: array of BetaDreamOutput`
16111656
16121657 - `memory_store_id: string`
16131658
16141659 - `type: "memory_store"`
16151660
1616 - `"memory_store"`
1617
16181661 - `session_id: string or null`
16191662
16201663 - `status: BetaDreamStatus`
from line 1676
16331676
16341677 - `type: "dream"`
16351678
1636 - `"dream"`
1637
16381679 - `usage: BetaDreamUsage`
16391680
16401681 Cumulative token usage for the dream across every pipeline stage.
from line 1684
16431684
16441685 Total tokens used to create prompt-cache entries (sum of all TTL tiers).
16451686
1687 format: int32
1688
16461689 - `cache_read_input_tokens: number`
16471690
16481691 Total tokens read from prompt cache.
16491692
1693 format: int32
1694
16501695 - `input_tokens: number`
16511696
16521697 Total uncached input tokens consumed across every pipeline stage.
16531698
1699 format: int32
1700
16541701 - `output_tokens: number`
16551702
16561703 Total output tokens generated across every pipeline stage.
16571704
1705 format: int32
1706
16581707### Beta Dream Error
16591708
1660- `BetaDreamError object { message, type }`
1709- `BetaDreamError object`
16611710
16621711 Failure detail for a Dream whose `status` is `failed`.
16631712
from line 1720
16711720
16721721 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.
16731722
1674 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
1723 - `BetaDreamMemoryStoreInput object`
16751724
16761725 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.
16771726
16781727 - `memory_store_id: string`
16791728
1729 minLength: 1
1730
16801731 - `type: "memory_store"`
16811732
1682 - `"memory_store"`
1683
1684 - `BetaDreamSessionsInput object { session_ids, type }`
1733 - `BetaDreamSessionsInput object`
16851734
16861735 Input session transcripts the dream reads.
16871736
from line 1738
16891738
16901739 - `type: "sessions"`
16911740
1692 - `"sessions"`
1693
16941741### Beta Dream Memory Store Input
16951742
1696- `BetaDreamMemoryStoreInput object { memory_store_id, type }`
1743- `BetaDreamMemoryStoreInput object`
16971744
16981745 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.
16991746
17001747 - `memory_store_id: string`
17011748
1749 minLength: 1
1750
17021751 - `type: "memory_store"`
17031752
1704 - `"memory_store"`
1705
17061753### Beta Dream Memory Store Output
17071754
1708- `BetaDreamMemoryStoreOutput object { memory_store_id, type }`
1755- `BetaDreamMemoryStoreOutput object`
17091756
17101757 An output memory store the dream writes consolidated memories into.
17111758
from line 1760
17131760
17141761 - `type: "memory_store"`
17151762
1716 - `"memory_store"`
1717
17181763### Beta Dream Model Config
17191764
1720- `BetaDreamModelConfig object { id, speed }`
1765- `BetaDreamModelConfig object`
17211766
17221767 Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.
17231768
from line 1770
17251770
17261771 Model identifier, e.g. "claude-opus-5". 1-256 characters.
17271772
1773 minLength: 1, maxLength: 256
1774
17281775 - `speed: optional "standard" or "fast"`
17291776
17301777 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
from line 1782
17351782
17361783### Beta Dream Model Config Param
17371784
1738- `BetaDreamModelConfigParam object { id, speed }`
1785- `BetaDreamModelConfigParam object`
17391786
17401787 Model identifier and configuration applied to every pipeline stage.
17411788
from line 1790
17431790
17441791 Model identifier, e.g. "claude-opus-5". 1-256 characters.
17451792
1793 minLength: 1, maxLength: 256
1794
17461795 - `speed: optional "standard" or "fast" or null`
17471796
17481797 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
from line 1802
17531802
17541803### Beta Dream Output
17551804
1756- `BetaDreamOutput object { memory_store_id, type }`
1805- `BetaDreamOutput object`
17571806
17581807 An output memory store the dream writes consolidated memories into.
17591808
from line 1810
17611810
17621811 - `type: "memory_store"`
17631812
1764 - `"memory_store"`
1765
17661813### Beta Dream Sessions Input
17671814
1768- `BetaDreamSessionsInput object { session_ids, type }`
1815- `BetaDreamSessionsInput object`
17691816
17701817 Input session transcripts the dream reads.
17711818
from line 1820
17731820
17741821 - `type: "sessions"`
17751822
1776 - `"sessions"`
1777
17781823### Beta Dream Status
17791824
17801825- `BetaDreamStatus = "pending" or "running" or "completed" or 2 more`
from line 1838
17931838
17941839### Beta Dream Usage
17951840
1796- `BetaDreamUsage object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, output_tokens }`
1841- `BetaDreamUsage object`
17971842
17981843 Cumulative token usage for the dream across every pipeline stage.
17991844
from line 1846
18011846
18021847 Total tokens used to create prompt-cache entries (sum of all TTL tiers).
18031848
1849 format: int32
1850
18041851 - `cache_read_input_tokens: number`
18051852
18061853 Total tokens read from prompt cache.
18071854
1855 format: int32
1856
18081857 - `input_tokens: number`
18091858
18101859 Total uncached input tokens consumed across every pipeline stage.
18111860
1861 format: int32
1862
18121863 - `output_tokens: number`
18131864
18141865 Total output tokens generated across every pipeline stage.
18151866
1867 format: int32
1868
18161869### Beta Output Behavior
18171870
18181871- `BetaOutputBehavior = BetaOutputBehaviorCreateNew or BetaOutputBehaviorUpdateExisting`
18191872
18201873 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
18211874
1822 - `BetaOutputBehaviorCreateNew object { type }`
1875 - `BetaOutputBehaviorCreateNew object`
18231876
18241877 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
18251878
18261879 - `type: "create_new"`
18271880
1828 - `"create_new"`
1829
1830 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
1881 - `BetaOutputBehaviorUpdateExisting object`
18311882
18321883 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.
18331884
18341885 - `memory_store_id: string`
18351886
1887 minLength: 1
1888
18361889 - `type: "update_existing"`
18371890
1838 - `"update_existing"`
1839
18401891### Beta Output Behavior Create New
18411892
1842- `BetaOutputBehaviorCreateNew object { type }`
1893- `BetaOutputBehaviorCreateNew object`
18431894
18441895 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.
18451896
18461897 - `type: "create_new"`
18471898
1848 - `"create_new"`
1849
18501899### Beta Output Behavior Update Existing
18511900
1852- `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
1901- `BetaOutputBehaviorUpdateExisting object`
18531902
18541903 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.
18551904
18561905 - `memory_store_id: string`
18571906
1907 minLength: 1
1908
18581909 - `type: "update_existing"`
1859
1860 - `"update_existing"`
18611910
No line in this hunk matches that.