Dreams
Dream erstellen
Dreams auflisten
Dream abrufen
Dream abbrechen
Dream archivieren
Models
BetaDream object{ type, id, archived_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.
BetaDreamError object{ type, message }Failure detail for a Dream whose status is failed.
Failure detail for a Dream whose status is failed.
BetaDreamInput = BetaDreamMemoryStoreInput { type, memory_store_id } or BetaDreamSessionsInput { type, session_ids }
BetaDreamMemoryStoreInput object{ type, memory_store_id }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
BetaDreamSessionsInput object{ type, session_ids }Input session transcripts the dream reads.
Input session transcripts the dream reads.
BetaDreamMemoryStoreInput object{ type, memory_store_id }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
BetaDreamMemoryStoreOutput object{ type, memory_store_id }An output memory store the dream writes consolidated memories into.
An output memory store the dream writes consolidated memories into.
BetaDreamModelConfig 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.
BetaDreamModelConfigParam 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" or nullInference 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.
BetaDreamOutput object{ type, memory_store_id }An output memory store the dream writes consolidated memories into.
An output memory store the dream writes consolidated memories into.
BetaDreamSessionsInput object{ type, session_ids }Input session transcripts the dream reads.
Input session transcripts the dream reads.
BetaDreamStatus = "pending" or "running" or "completed" or 2 moreLifecycle status of a Dream.
Lifecycle status of a Dream.
BetaDreamUsage 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.
BetaDreamingError = BetaInvalidRequestError { type, message } or BetaAuthenticationError { type, message } or BetaBillingError { type, message } or 7 more
BetaOutputBehavior = BetaOutputBehaviorCreateNew { type } or BetaOutputBehaviorUpdateExisting { type, memory_store_id }
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.
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.
BetaOutputBehaviorUpdateExisting object{ type, memory_store_id }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
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.
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.
BetaOutputBehaviorUpdateExisting object{ type, memory_store_id }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
BetaTargetStoreHeldError 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.