One change
Dreams
api/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.
api/beta/dreams Changed · +264 / -39 lines
### Beta Output Behavior ### Beta Output Behavior Create New ### Beta Output Behavior Update Existing
from line 19
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 65
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 95
- `BetaDreamMemoryStoreInput object { memory_store_id, type }` - An input memory store the dream reads from. The dream never mutates this store. + 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. - `memory_store_id: string`
from line 125
- `id: string` - Model identifier, e.g. "claude-opus-4-7". 1-256 characters. + Model identifier, e.g. "claude-opus-5". 1-256 characters. - `speed: optional "standard" or "fast" or null`
from line 137
- `instructions: optional string or null` +- `output_behavior: optional BetaOutputBehavior` + + 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. + + - `BetaOutputBehaviorCreateNew object { type }` + + 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. + + - `type: "create_new"` + + - `"create_new"` + + - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }` + + 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. + + - `memory_store_id: string` + + - `type: "update_existing"` + + - `"update_existing"` + ### Returns -- `BetaDream object { id, archived_at, created_at, 10 more }` +- `BetaDream object { id, archived_at, created_at, 11 more }` - 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. + 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. - `id: string`
from line 191
- `BetaDreamMemoryStoreInput object { memory_store_id, type }` - An input memory store the dream reads from. The dream never mutates this store. + 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. - `memory_store_id: string`
from line 217
- `id: string` - Model identifier, e.g. "claude-opus-4-7". 1-256 characters. + Model identifier, e.g. "claude-opus-5". 1-256 characters. - `speed: optional "standard" or "fast"`
from line 227
- `"fast"` + - `output_behavior: BetaOutputBehavior` + + 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. + + - `BetaOutputBehaviorCreateNew object { type }` + + 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. + + - `type: "create_new"` + + - `"create_new"` + + - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }` + + 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. + + - `memory_store_id: string` + + - `type: "update_existing"` + + - `"update_existing"` + - `outputs: array of BetaDreamOutput` - `memory_store_id: string`
from line 339
"id": "x", "speed": "standard" }, + "output_behavior": { + "type": "create_new" + }, "outputs": [ { "memory_store_id": "memory_store_id",
from line 410
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 456
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 510
- `BetaDreamMemoryStoreInput object { memory_store_id, type }` - An input memory store the dream reads from. The dream never mutates this store. + 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. - `memory_store_id: string`
from line 536
- `id: string` - Model identifier, e.g. "claude-opus-4-7". 1-256 characters. + Model identifier, e.g. "claude-opus-5". 1-256 characters. - `speed: optional "standard" or "fast"`
from line 546
- `"fast"` + - `output_behavior: BetaOutputBehavior` + + 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. + + - `BetaOutputBehaviorCreateNew object { type }` + + 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. + + - `type: "create_new"` + + - `"create_new"` + + - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }` + + 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. + + - `memory_store_id: string` + + - `type: "update_existing"` + + - `"update_existing"` + - `outputs: array of BetaDreamOutput` - `memory_store_id: string`
from line 652
"id": "x", "speed": "standard" }, + "output_behavior": { + "type": "create_new" + }, "outputs": [ { "memory_store_id": "memory_store_id",
from line 694
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 740
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 766
### Returns -- `BetaDream object { id, archived_at, created_at, 10 more }` +- `BetaDream object { id, archived_at, created_at, 11 more }` - 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. + 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. - `id: string`
from line 796
- `BetaDreamMemoryStoreInput object { memory_store_id, type }` - An input memory store the dream reads from. The dream never mutates this store. + 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. - `memory_store_id: string`
from line 822
- `id: string` - Model identifier, e.g. "claude-opus-4-7". 1-256 characters. + Model identifier, e.g. "claude-opus-5". 1-256 characters. - `speed: optional "standard" or "fast"`
from line 832
- `"fast"` + - `output_behavior: BetaOutputBehavior` + + 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. + + - `BetaOutputBehaviorCreateNew object { type }` + + 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. + + - `type: "create_new"` + + - `"create_new"` + + - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }` + + 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. + + - `memory_store_id: string` + + - `type: "update_existing"` + + - `"update_existing"` + - `outputs: array of BetaDreamOutput` - `memory_store_id: string`
from line 934
"id": "x", "speed": "standard" }, + "output_behavior": { + "type": "create_new" + }, "outputs": [ { "memory_store_id": "memory_store_id",
from line 973
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 1019
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 1045
### Returns -- `BetaDream object { id, archived_at, created_at, 10 more }` +- `BetaDream object { id, archived_at, created_at, 11 more }` - 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. + 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. - `id: string`
from line 1075
- `BetaDreamMemoryStoreInput object { memory_store_id, type }` - An input memory store the dream reads from. The dream never mutates this store. + 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. - `memory_store_id: string`
from line 1101
- `id: string` - Model identifier, e.g. "claude-opus-4-7". 1-256 characters. + Model identifier, e.g. "claude-opus-5". 1-256 characters. - `speed: optional "standard" or "fast"`
from line 1111
- `"fast"` + - `output_behavior: BetaOutputBehavior` + + 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. + + - `BetaOutputBehaviorCreateNew object { type }` + + 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. + + - `type: "create_new"` + + - `"create_new"` + + - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }` + + 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. + + - `memory_store_id: string` + + - `type: "update_existing"` + + - `"update_existing"` + - `outputs: array of BetaDreamOutput` - `memory_store_id: string`
from line 1214
"id": "x", "speed": "standard" }, + "output_behavior": { + "type": "create_new" + }, "outputs": [ { "memory_store_id": "memory_store_id",
from line 1253
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 1299
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 1325
### Returns -- `BetaDream object { id, archived_at, created_at, 10 more }` +- `BetaDream object { id, archived_at, created_at, 11 more }` - 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. + 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. - `id: string`
from line 1355
- `BetaDreamMemoryStoreInput object { memory_store_id, type }` - An input memory store the dream reads from. The dream never mutates this store. + 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. - `memory_store_id: string`
from line 1381
- `id: string` - Model identifier, e.g. "claude-opus-4-7". 1-256 characters. + Model identifier, e.g. "claude-opus-5". 1-256 characters. - `speed: optional "standard" or "fast"`
from line 1391
- `"fast"` + - `output_behavior: BetaOutputBehavior` + + 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. + + - `BetaOutputBehaviorCreateNew object { type }` + + 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. + + - `type: "create_new"` + + - `"create_new"` + + - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }` + + 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. + + - `memory_store_id: string` + + - `type: "update_existing"` + + - `"update_existing"` + - `outputs: array of BetaDreamOutput` - `memory_store_id: string`
from line 1494
"id": "x", "speed": "standard" }, + "output_behavior": { + "type": "create_new" + }, "outputs": [ { "memory_store_id": "memory_store_id",
from line 1519
### Beta Dream -- `BetaDream object { id, archived_at, created_at, 10 more }` +- `BetaDream object { id, archived_at, created_at, 11 more }` - 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. + 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. - `id: string`
from line 1549
- `BetaDreamMemoryStoreInput object { memory_store_id, type }` - An input memory store the dream reads from. The dream never mutates this store. + 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. - `memory_store_id: string`
from line 1575
- `id: string` - Model identifier, e.g. "claude-opus-4-7". 1-256 characters. + Model identifier, e.g. "claude-opus-5". 1-256 characters. - `speed: optional "standard" or "fast"`
from line 1585
- `"fast"` + - `output_behavior: BetaOutputBehavior` + + 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. + + - `BetaOutputBehaviorCreateNew object { type }` + + 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. + + - `type: "create_new"` + + - `"create_new"` + + - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }` + + 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. + + - `memory_store_id: string` + + - `type: "update_existing"` + + - `"update_existing"` + - `outputs: array of BetaDreamOutput` - `memory_store_id: string`
from line 1669
- `BetaDreamInput = BetaDreamMemoryStoreInput or BetaDreamSessionsInput` - An input memory store the dream reads from. The dream never mutates this store. + 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. - `BetaDreamMemoryStoreInput object { memory_store_id, type }` - An input memory store the dream reads from. The dream never mutates this store. + 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. - `memory_store_id: string`
from line 1695
- `BetaDreamMemoryStoreInput object { memory_store_id, type }` - An input memory store the dream reads from. The dream never mutates this store. + 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. - `memory_store_id: string`
from line 1723
- `id: string` - Model identifier, e.g. "claude-opus-4-7". 1-256 characters. + Model identifier, e.g. "claude-opus-5". 1-256 characters. - `speed: optional "standard" or "fast"`
from line 1741
- `id: string` - Model identifier, e.g. "claude-opus-4-7". 1-256 characters. + Model identifier, e.g. "claude-opus-5". 1-256 characters. - `speed: optional "standard" or "fast" or null`
from line 1812
- `output_tokens: number` Total output tokens generated across every pipeline stage. + +### Beta Output Behavior + +- `BetaOutputBehavior = BetaOutputBehaviorCreateNew or BetaOutputBehaviorUpdateExisting` + + 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. + + - `BetaOutputBehaviorCreateNew object { type }` + + 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. + + - `type: "create_new"` + + - `"create_new"` + + - `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }` + + 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. + + - `memory_store_id: string` + + - `type: "update_existing"` + + - `"update_existing"` + +### Beta Output Behavior Create New + +- `BetaOutputBehaviorCreateNew object { type }` + + 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. + + - `type: "create_new"` + + - `"create_new"` + +### Beta Output Behavior Update Existing + +- `BetaOutputBehaviorUpdateExisting object { memory_store_id, type }` + + 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. + + - `memory_store_id: string` + + - `type: "update_existing"` + + - `"update_existing"`