Dreams changedapi/beta/dreams
Nearest release: v2.1.238, 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+264added
Lines−39removed
From line
19
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits21to this page, all time
### Beta Output Behavior ### Beta Output Behavior Create New ### Beta Output Behavior Update Existing
The whole hunk
from line 19, old and new numbered
/
from line 19
1919
2020 - `string`
2121
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
2323
2424 - `"message-batches-2024-09-24"`
2525
from line 65
6565
6666 - `"user-profiles-2026-03-24"`
6767
68 - `"user-profiles-2026-08-18"`
69
6870 - `"advisor-tool-2026-03-01"`
6971
7072 - `"managed-agents-2026-04-01"`
from line 95
9395
9496 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
9597
96 An input memory store the dream reads from. The dream never mutates this store.
98 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.
9799
98100 - `memory_store_id: string`
99101
from line 125
123125
124126 - `id: string`
125127
126 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
128 Model identifier, e.g. "claude-opus-5". 1-256 characters.
127129
128130 - `speed: optional "standard" or "fast" or null`
129131
from line 137
135137
136138- `instructions: optional string or null`
137139
140- `output_behavior: optional BetaOutputBehavior`
141
142 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.
143
144 - `BetaOutputBehaviorCreateNew object { type }`
145
146 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.
147
148 - `type: "create_new"`
149
150 - `"create_new"`
151
152 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
153
154 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.
155
156 - `memory_store_id: string`
157
158 - `type: "update_existing"`
159
160 - `"update_existing"`
161
138162### Returns
139163
140- `BetaDream object { id, archived_at, created_at, 10 more }`
164- `BetaDream object { id, archived_at, created_at, 11 more }`
141165
142 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. 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.
166 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.
143167
144168 - `id: string`
145169
from line 191
167191
168192 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
169193
170 An input memory store the dream reads from. The dream never mutates this store.
194 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.
171195
172196 - `memory_store_id: string`
173197
from line 217
193217
194218 - `id: string`
195219
196 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
220 Model identifier, e.g. "claude-opus-5". 1-256 characters.
197221
198222 - `speed: optional "standard" or "fast"`
199223
from line 227
203227
204228 - `"fast"`
205229
230 - `output_behavior: BetaOutputBehavior`
231
232 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.
233
234 - `BetaOutputBehaviorCreateNew object { type }`
235
236 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.
237
238 - `type: "create_new"`
239
240 - `"create_new"`
241
242 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
243
244 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.
245
246 - `memory_store_id: string`
247
248 - `type: "update_existing"`
249
250 - `"update_existing"`
251
206252 - `outputs: array of BetaDreamOutput`
207253
208254 - `memory_store_id: string`
from line 339
293339 "id": "x",
294340 "speed": "standard"
295341 },
342 "output_behavior": {
343 "type": "create_new"
344 },
296345 "outputs": [
297346 {
298347 "memory_store_id": "memory_store_id",
from line 410
361410
362411 - `string`
363412
364 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
413 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
365414
366415 - `"message-batches-2024-09-24"`
367416
from line 456
407456
408457 - `"user-profiles-2026-03-24"`
409458
459 - `"user-profiles-2026-08-18"`
460
410461 - `"advisor-tool-2026-03-01"`
411462
412463 - `"managed-agents-2026-04-01"`
from line 510
459510
460511 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
461512
462 An input memory store the dream reads from. The dream never mutates this store.
513 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.
463514
464515 - `memory_store_id: string`
465516
from line 536
485536
486537 - `id: string`
487538
488 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
539 Model identifier, e.g. "claude-opus-5". 1-256 characters.
489540
490541 - `speed: optional "standard" or "fast"`
491542
from line 546
495546
496547 - `"fast"`
497548
549 - `output_behavior: BetaOutputBehavior`
550
551 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.
552
553 - `BetaOutputBehaviorCreateNew object { type }`
554
555 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.
556
557 - `type: "create_new"`
558
559 - `"create_new"`
560
561 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
562
563 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.
564
565 - `memory_store_id: string`
566
567 - `type: "update_existing"`
568
569 - `"update_existing"`
570
498571 - `outputs: array of BetaDreamOutput`
499572
500573 - `memory_store_id: string`
from line 652
579652 "id": "x",
580653 "speed": "standard"
581654 },
655 "output_behavior": {
656 "type": "create_new"
657 },
582658 "outputs": [
583659 {
584660 "memory_store_id": "memory_store_id",
from line 694
618694
619695 - `string`
620696
621 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
697 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
622698
623699 - `"message-batches-2024-09-24"`
624700
from line 740
664740
665741 - `"user-profiles-2026-03-24"`
666742
743 - `"user-profiles-2026-08-18"`
744
667745 - `"advisor-tool-2026-03-01"`
668746
669747 - `"managed-agents-2026-04-01"`
from line 766
688766
689767### Returns
690768
691- `BetaDream object { id, archived_at, created_at, 10 more }`
769- `BetaDream object { id, archived_at, created_at, 11 more }`
692770
693 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. 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.
771 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.
694772
695773 - `id: string`
696774
from line 796
718796
719797 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
720798
721 An input memory store the dream reads from. The dream never mutates this store.
799 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.
722800
723801 - `memory_store_id: string`
724802
from line 822
744822
745823 - `id: string`
746824
747 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
825 Model identifier, e.g. "claude-opus-5". 1-256 characters.
748826
749827 - `speed: optional "standard" or "fast"`
750828
from line 832
754832
755833 - `"fast"`
756834
835 - `output_behavior: BetaOutputBehavior`
836
837 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.
838
839 - `BetaOutputBehaviorCreateNew object { type }`
840
841 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.
842
843 - `type: "create_new"`
844
845 - `"create_new"`
846
847 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
848
849 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.
850
851 - `memory_store_id: string`
852
853 - `type: "update_existing"`
854
855 - `"update_existing"`
856
757857 - `outputs: array of BetaDreamOutput`
758858
759859 - `memory_store_id: string`
from line 934
834934 "id": "x",
835935 "speed": "standard"
836936 },
937 "output_behavior": {
938 "type": "create_new"
939 },
837940 "outputs": [
838941 {
839942 "memory_store_id": "memory_store_id",
from line 973
870973
871974 - `string`
872975
873 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
976 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
874977
875978 - `"message-batches-2024-09-24"`
876979
from line 1019
9161019
9171020 - `"user-profiles-2026-03-24"`
9181021
1022 - `"user-profiles-2026-08-18"`
1023
9191024 - `"advisor-tool-2026-03-01"`
9201025
9211026 - `"managed-agents-2026-04-01"`
from line 1045
9401045
9411046### Returns
9421047
943- `BetaDream object { id, archived_at, created_at, 10 more }`
1048- `BetaDream object { id, archived_at, created_at, 11 more }`
9441049
945 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. 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.
1050 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.
9461051
9471052 - `id: string`
9481053
from line 1075
9701075
9711076 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
9721077
973 An input memory store the dream reads from. The dream never mutates this store.
1078 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.
9741079
9751080 - `memory_store_id: string`
9761081
from line 1101
9961101
9971102 - `id: string`
9981103
999 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
1104 Model identifier, e.g. "claude-opus-5". 1-256 characters.
10001105
10011106 - `speed: optional "standard" or "fast"`
10021107
from line 1111
10061111
10071112 - `"fast"`
10081113
1114 - `output_behavior: BetaOutputBehavior`
1115
1116 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.
1117
1118 - `BetaOutputBehaviorCreateNew object { type }`
1119
1120 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.
1121
1122 - `type: "create_new"`
1123
1124 - `"create_new"`
1125
1126 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
1127
1128 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.
1129
1130 - `memory_store_id: string`
1131
1132 - `type: "update_existing"`
1133
1134 - `"update_existing"`
1135
10091136 - `outputs: array of BetaDreamOutput`
10101137
10111138 - `memory_store_id: string`
from line 1214
10871214 "id": "x",
10881215 "speed": "standard"
10891216 },
1217 "output_behavior": {
1218 "type": "create_new"
1219 },
10901220 "outputs": [
10911221 {
10921222 "memory_store_id": "memory_store_id",
from line 1253
11231253
11241254 - `string`
11251255
1126 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
1256 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more`
11271257
11281258 - `"message-batches-2024-09-24"`
11291259
from line 1299
11691299
11701300 - `"user-profiles-2026-03-24"`
11711301
1302 - `"user-profiles-2026-08-18"`
1303
11721304 - `"advisor-tool-2026-03-01"`
11731305
11741306 - `"managed-agents-2026-04-01"`
from line 1325
11931325
11941326### Returns
11951327
1196- `BetaDream object { id, archived_at, created_at, 10 more }`
1328- `BetaDream object { id, archived_at, created_at, 11 more }`
11971329
1198 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. 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.
1330 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.
11991331
12001332 - `id: string`
12011333
from line 1355
12231355
12241356 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
12251357
1226 An input memory store the dream reads from. The dream never mutates this store.
1358 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.
12271359
12281360 - `memory_store_id: string`
12291361
from line 1381
12491381
12501382 - `id: string`
12511383
1252 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
1384 Model identifier, e.g. "claude-opus-5". 1-256 characters.
12531385
12541386 - `speed: optional "standard" or "fast"`
12551387
from line 1391
12591391
12601392 - `"fast"`
12611393
1394 - `output_behavior: BetaOutputBehavior`
1395
1396 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.
1397
1398 - `BetaOutputBehaviorCreateNew object { type }`
1399
1400 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.
1401
1402 - `type: "create_new"`
1403
1404 - `"create_new"`
1405
1406 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
1407
1408 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.
1409
1410 - `memory_store_id: string`
1411
1412 - `type: "update_existing"`
1413
1414 - `"update_existing"`
1415
12621416 - `outputs: array of BetaDreamOutput`
12631417
12641418 - `memory_store_id: string`
from line 1494
13401494 "id": "x",
13411495 "speed": "standard"
13421496 },
1497 "output_behavior": {
1498 "type": "create_new"
1499 },
13431500 "outputs": [
13441501 {
13451502 "memory_store_id": "memory_store_id",
from line 1519
13621519
13631520### Beta Dream
13641521
1365- `BetaDream object { id, archived_at, created_at, 10 more }`
1522- `BetaDream object { id, archived_at, created_at, 11 more }`
13661523
1367 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. 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.
1524 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.
13681525
13691526 - `id: string`
13701527
from line 1549
13921549
13931550 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
13941551
1395 An input memory store the dream reads from. The dream never mutates this store.
1552 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.
13961553
13971554 - `memory_store_id: string`
13981555
from line 1575
14181575
14191576 - `id: string`
14201577
1421 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
1578 Model identifier, e.g. "claude-opus-5". 1-256 characters.
14221579
14231580 - `speed: optional "standard" or "fast"`
14241581
from line 1585
14281585
14291586 - `"fast"`
14301587
1588 - `output_behavior: BetaOutputBehavior`
1589
1590 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.
1591
1592 - `BetaOutputBehaviorCreateNew object { type }`
1593
1594 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.
1595
1596 - `type: "create_new"`
1597
1598 - `"create_new"`
1599
1600 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
1601
1602 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.
1603
1604 - `memory_store_id: string`
1605
1606 - `type: "update_existing"`
1607
1608 - `"update_existing"`
1609
14311610 - `outputs: array of BetaDreamOutput`
14321611
14331612 - `memory_store_id: string`
from line 1669
14901669
14911670- `BetaDreamInput = BetaDreamMemoryStoreInput or BetaDreamSessionsInput`
14921671
1493 An input memory store the dream reads from. The dream never mutates this store.
1672 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.
14941673
14951674 - `BetaDreamMemoryStoreInput object { memory_store_id, type }`
14961675
1497 An input memory store the dream reads from. The dream never mutates this store.
1676 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.
14981677
14991678 - `memory_store_id: string`
15001679
from line 1695
15161695
15171696- `BetaDreamMemoryStoreInput object { memory_store_id, type }`
15181697
1519 An input memory store the dream reads from. The dream never mutates this store.
1698 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.
15201699
15211700 - `memory_store_id: string`
15221701
from line 1723
15441723
15451724 - `id: string`
15461725
1547 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
1726 Model identifier, e.g. "claude-opus-5". 1-256 characters.
15481727
15491728 - `speed: optional "standard" or "fast"`
15501729
from line 1741
15621741
15631742 - `id: string`
15641743
1565 Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
1744 Model identifier, e.g. "claude-opus-5". 1-256 characters.
15661745
15671746 - `speed: optional "standard" or "fast" or null`
15681747
from line 1812
16331812 - `output_tokens: number`
16341813
16351814 Total output tokens generated across every pipeline stage.
1815
1816### Beta Output Behavior
1817
1818- `BetaOutputBehavior = BetaOutputBehaviorCreateNew or BetaOutputBehaviorUpdateExisting`
1819
1820 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.
1821
1822 - `BetaOutputBehaviorCreateNew object { type }`
1823
1824 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.
1825
1826 - `type: "create_new"`
1827
1828 - `"create_new"`
1829
1830 - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
1831
1832 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.
1833
1834 - `memory_store_id: string`
1835
1836 - `type: "update_existing"`
1837
1838 - `"update_existing"`
1839
1840### Beta Output Behavior Create New
1841
1842- `BetaOutputBehaviorCreateNew object { type }`
1843
1844 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.
1845
1846 - `type: "create_new"`
1847
1848 - `"create_new"`
1849
1850### Beta Output Behavior Update Existing
1851
1852- `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }`
1853
1854 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.
1855
1856 - `memory_store_id: string`
1857
1858 - `type: "update_existing"`
1859
1860 - `"update_existing"`
16361861
No line in this hunk matches that.