Dreams
Models
beta_dream: 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 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.
beta_dream_error: object{ message, type }Failure detail for a Dream whose status is failed.
Failure detail for a Dream whose status is failed.
beta_dream_input: BetaDreamMemoryStoreInput { memory_store_id, type } or BetaDreamSessionsInput { session_ids, type }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.
beta_dream_memory_store_input: object{ memory_store_id, type }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.
memory_store_id: string
beta_dream_sessions_input: object{ session_ids, type }Input session transcripts the dream reads.
Input session transcripts the dream reads.
beta_dream_memory_store_input: object{ memory_store_id, type }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.
memory_store_id: string
beta_dream_memory_store_output: object{ memory_store_id, type }An output memory store the dream writes consolidated memories into.
An output memory store the dream writes consolidated memories into.
beta_dream_model_config: object{ 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.
id: stringModel identifier, e.g. "claude-opus-5". 1-256 characters.
Model identifier, e.g. "claude-opus-5". 1-256 characters.
speed: optional "standard" or "fast"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.
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.
beta_dream_model_config_param: object{ id, speed }Model identifier and configuration applied to every pipeline stage.
Model identifier and configuration applied to every pipeline stage.
id: stringModel identifier, e.g. "claude-opus-5". 1-256 characters.
Model identifier, e.g. "claude-opus-5". 1-256 characters.
speed: optional "standard" or "fast"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.
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.
beta_dream_output: object{ memory_store_id, type }An output memory store the dream writes consolidated memories into.
An output memory store the dream writes consolidated memories into.
beta_dream_sessions_input: object{ session_ids, type }Input session transcripts the dream reads.
Input session transcripts the dream reads.
beta_dream_status: "pending" or "running" or "completed" or 2 moreLifecycle status of a Dream.
Lifecycle status of a Dream.
beta_dream_usage: object{ cache_creation_input_tokens, cache_read_input_tokens, input_tokens, output_tokens }Cumulative token usage for the dream across every pipeline stage.
Cumulative token usage for the dream across every pipeline stage.
cache_creation_input_tokens: numberTotal 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).
cache_read_input_tokens: numberTotal tokens read from prompt cache.
Total tokens read from prompt cache.
input_tokens: numberTotal uncached input tokens consumed across every pipeline stage.
Total uncached input tokens consumed across every pipeline stage.
output_tokens: numberTotal output tokens generated across every pipeline stage.
Total output tokens generated across every pipeline stage.
beta_dreaming_error: BetaInvalidRequestError { message, type } or BetaAuthenticationError { message, type } or BetaBillingError { message, type } or 7 moreThe 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.
beta_output_behavior: BetaOutputBehaviorCreateNew { type } or BetaOutputBehaviorUpdateExisting { memory_store_id, 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.
beta_output_behavior_create_new: 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.
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.
beta_output_behavior_update_existing: 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.
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
beta_output_behavior_create_new: 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.
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.
beta_output_behavior_update_existing: 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.
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
beta_target_store_held_error: object{ type, 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.