Dream
Models
class BetaDream { Type; ID; ArchivedAt; /* 11 more */ }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.
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.
class BetaDreamError { Type; Message; }Failure detail for a Dream whose status is failed.
Failure detail for a Dream whose status is failed.
class BetaDreamInput: union
class BetaDreamMemoryStoreInput { Type; MemoryStoreID; }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.
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.
required string MemoryStoreID
class BetaDreamSessionsInput { Type; SessionIds; }Input session transcripts the dream reads.
Input session transcripts the dream reads.
class BetaDreamMemoryStoreInput { Type; MemoryStoreID; }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.
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.
required string MemoryStoreID
class BetaDreamMemoryStoreOutput { Type; MemoryStoreID; }An output memory store the dream writes consolidated memories into.
An output memory store the dream writes consolidated memories into.
class BetaDreamModelConfig { ID; Speed; }Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.
Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.
required string IDModel identifier, e.g. "claude-opus-5". 1-256 characters.
Model identifier, e.g. "claude-opus-5". 1-256 characters.
Speed SpeedInference speed mode. fast provides significantly faster output token generation at premium pricing. Not all models support fast; invalid combinations are rejected at create time.
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.
class BetaDreamModelConfigParam { ID; Speed; }Model identifier and configuration applied to every pipeline stage.
Model identifier and configuration applied to every pipeline stage.
required string IDModel identifier, e.g. "claude-opus-5". 1-256 characters.
Model identifier, e.g. "claude-opus-5". 1-256 characters.
Speed? SpeedInference speed mode. fast provides significantly faster output token generation at premium pricing. Not all models support fast; invalid combinations are rejected at create time.
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.
class BetaDreamOutput { Type; MemoryStoreID; }An output memory store the dream writes consolidated memories into.
An output memory store the dream writes consolidated memories into.
class BetaDreamSessionsInput { Type; SessionIds; }Input session transcripts the dream reads.
Input session transcripts the dream reads.
enum BetaDreamStatusLifecycle status of a Dream.
Lifecycle status of a Dream.
class BetaDreamUsage { CacheCreationInputTokens; CacheReadInputTokens; InputTokens; OutputTokens; }Cumulative token usage for the dream across every pipeline stage.
Cumulative token usage for the dream across every pipeline stage.
required int CacheCreationInputTokensTotal tokens used to create prompt-cache entries (sum of all TTL tiers).
Total tokens used to create prompt-cache entries (sum of all TTL tiers).
required int CacheReadInputTokensTotal tokens read from prompt cache.
Total tokens read from prompt cache.
required int InputTokensTotal uncached input tokens consumed across every pipeline stage.
Total uncached input tokens consumed across every pipeline stage.
required int OutputTokensTotal output tokens generated across every pipeline stage.
Total output tokens generated across every pipeline stage.
class BetaDreamingError: union
class BetaOutputBehavior: union
class BetaOutputBehaviorCreateNew { 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.
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.
class BetaOutputBehaviorUpdateExisting { Type; MemoryStoreID; }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.
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.
required string MemoryStoreID
class BetaOutputBehaviorCreateNew { 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.
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.
class BetaOutputBehaviorUpdateExisting { Type; MemoryStoreID; }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.
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.
required string MemoryStoreID
class BetaTargetStoreHeldError { Type = "conflict_error"; Message; }The output_behavior.memory_store_id target is still held by a prior {type: "update_existing"} dream — one that is pending or running, or was canceled with its final writes still landing. Rarely the named dream has just finished (completed/failed) and its execution is still closing; an immediate retry then almost always succeeds. The message names the holding dream when the server can identify it (rarely omitted); poll it to a terminal state or cancel it, then retry. Carried with x-should-retry: false.
The output_behavior.memory_store_id target is still held by a prior {type: "update_existing"} dream — one that is pending or running, or was canceled with its final writes still landing. Rarely the named dream has just finished (completed/failed) and its execution is still closing; an immediate retry then almost always succeeds. The message names the holding dream when the server can identify it (rarely omitted); poll it to a terminal state or cancel it, then retry. Carried with x-should-retry: false.
Human-readable description of the conflict, naming the dream that holds the target store when the server can identify it.