Dreams

Create a Dream

client.Beta.Dreams.New(ctx, params) (*BetaDream, error)

POST/v1/dreams

List Dreams

client.Beta.Dreams.List(ctx, params) (*PageCursor[BetaDream], error)

GET/v1/dreams

Get a Dream

client.Beta.Dreams.Get(ctx, dreamID, query) (*BetaDream, error)

GET/v1/dreams/{dream_id}

Cancel a Dream

client.Beta.Dreams.Cancel(ctx, dreamID, body) (*BetaDream, error)

POST/v1/dreams/{dream_id}/cancel

Archive a Dream

client.Beta.Dreams.Archive(ctx, dreamID, body) (*BetaDream, error)

POST/v1/dreams/{dream_id}/archive

Models

type BetaDream struct{…}

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.

type BetaDreamError struct{…}

Failure detail for a Dream whose status is failed.

Message string

Type string

type BetaDreamInputUnion interface{…}

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.

One of the following:

type BetaDreamMemoryStoreInput struct{…}

MemoryStoreID string

minLength1

Type BetaDreamMemoryStoreInputType

type BetaDreamSessionsInput struct{…}

Input session transcripts the dream reads.

SessionIDs []string

Type BetaDreamSessionsInputType

type BetaDreamMemoryStoreInput struct{…}

MemoryStoreID string

minLength1

Type BetaDreamMemoryStoreInputType

type BetaDreamMemoryStoreOutput struct{…}

An output memory store the dream writes consolidated memories into.

MemoryStoreID string

Type BetaDreamMemoryStoreOutputType

type BetaDreamModelConfig struct{…}

Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.

ID string

Model identifier, e.g. "claude-opus-5". 1-256 characters.

minLength1

maxLength256

Speed BetaDreamModelConfigSpeed Optional

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.

One of the following:

const BetaDreamModelConfigSpeedStandard BetaDreamModelConfigSpeed = "standard"

const BetaDreamModelConfigSpeedFast BetaDreamModelConfigSpeed = "fast"

type BetaDreamModelConfigParamResp struct{…}

Model identifier and configuration applied to every pipeline stage.

ID string

Model identifier, e.g. "claude-opus-5". 1-256 characters.

minLength1

maxLength256

Speed BetaDreamModelConfigParamSpeed Optional

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.

One of the following:

const BetaDreamModelConfigParamSpeedStandard BetaDreamModelConfigParamSpeed = "standard"

const BetaDreamModelConfigParamSpeedFast BetaDreamModelConfigParamSpeed = "fast"

type BetaDreamOutput struct{…}

An output memory store the dream writes consolidated memories into.

MemoryStoreID string

Type BetaDreamOutputType

type BetaDreamSessionsInput struct{…}

Input session transcripts the dream reads.

SessionIDs []string

Type BetaDreamSessionsInputType

type BetaDreamStatus string

Lifecycle status of a Dream.

One of the following:

const BetaDreamStatusPending BetaDreamStatus = "pending"

const BetaDreamStatusRunning BetaDreamStatus = "running"

const BetaDreamStatusCompleted BetaDreamStatus = "completed"

const BetaDreamStatusFailed BetaDreamStatus = "failed"

const BetaDreamStatusCanceled BetaDreamStatus = "canceled"

type BetaDreamUsage struct{…}

Cumulative token usage for the dream across every pipeline stage.

CacheCreationInputTokens int64

Total tokens used to create prompt-cache entries (sum of all TTL tiers).

formatint32

CacheReadInputTokens int64

Total tokens read from prompt cache.

formatint32

InputTokens int64

Total uncached input tokens consumed across every pipeline stage.

formatint32

OutputTokens int64

Total output tokens generated across every pipeline stage.

formatint32

type BetaOutputBehaviorUnion interface{…}

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.

One of the following:

type BetaOutputBehaviorCreateNew struct{…}

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 BetaOutputBehaviorCreateNewType

type BetaOutputBehaviorUpdateExisting struct{…}

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.

MemoryStoreID string

minLength1

Type BetaOutputBehaviorUpdateExistingType

type BetaOutputBehaviorCreateNew struct{…}

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 BetaOutputBehaviorCreateNewType

type BetaOutputBehaviorUpdateExisting struct{…}

MemoryStoreID string

minLength1

Type BetaOutputBehaviorUpdateExistingType