Claude Platform Docs

List Dreams

$ ant beta:dreams list
GET/v1/dreams

List Dreams

Parameters
--created-at-gt: optional string

Query param: Return dreams with created_at strictly after this timestamp (exclusive lower bound, RFC 3339). Unset applies no lower bound.

formatdate-time
--created-at-lt: optional string

Query param: Return dreams with created_at strictly before this timestamp (exclusive upper bound, RFC 3339). Unset applies no upper bound.

formatdate-time
--include-archived: optional boolean

Query param: Query parameter for include_archived

--limit: optional number

Query param: Query parameter for limit

formatint32
--page: optional string

Query param: Query parameter for page

--status: optional array of BetaDreamStatus

Query param: Filter by lifecycle status. Repeat the parameter to match any of multiple statuses. Empty applies no status filter.

--beta: optional array of AnthropicBeta

Header param: Optional header to specify the beta version(s) you want to use.

--workspace-id: optional string

Header param: Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns
BetaListDreamsResponse: object{ data, next_page }
data: array of BetaDream { type: "dream", id, archived_at, 11 more }
type: "dream"
id: string
archived_at: string

A timestamp in RFC 3339 format

formatdate-time
created_at: string

A timestamp in RFC 3339 format

formatdate-time
ended_at: string

A timestamp in RFC 3339 format

formatdate-time
error: object{ type, message }

Failure detail for a Dream whose status is failed.

type: string
message: string
inputs: array of BetaDreamInput
One of the following:
beta_dream_memory_store_input: object{ type: "memory_store", 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.

type: "memory_store"
memory_store_id: string
minLength1
beta_dream_sessions_input: object{ type: "sessions", session_ids }

Input session transcripts the dream reads.

type: "sessions"
session_ids: array of string
instructions: string
model: object{ id, speed }

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: 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.

One of the following:
"standard"
"fast"
output_behavior: BetaOutputBehaviorCreateNew or BetaOutputBehaviorUpdateExisting
One of the following:
beta_output_behavior_create_new: object{ type: "create_new" }

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"
beta_output_behavior_update_existing: object{ type: "update_existing", 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.

type: "update_existing"
memory_store_id: string
minLength1
outputs: array of BetaDreamOutput { type: "memory_store", memory_store_id }
type: "memory_store"
memory_store_id: string
session_id: string
status: "pending" or "running" or "completed" or 2 more

Lifecycle status of a Dream.

One of the following:
"pending"
"running"
"completed"
"failed"
"canceled"
usage: object{ cache_creation_input_tokens, cache_read_input_tokens, input_tokens, output_tokens }

Cumulative token usage for the dream across every pipeline stage.

cache_creation_input_tokens: number

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

formatint32
cache_read_input_tokens: number

Total tokens read from prompt cache.

formatint32
input_tokens: number

Total uncached input tokens consumed across every pipeline stage.

formatint32
output_tokens: number

Total output tokens generated across every pipeline stage.

formatint32
next_page: string
List Dreams
ant beta:dreams list \
  --api-key my-anthropic-api-key
Returns Examples
Response 200
{
  "data": [
    {
      "id": "id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "created_at": "2019-12-27T18:11:19.117Z",
      "ended_at": "2019-12-27T18:11:19.117Z",
      "error": {
        "message": "message",
        "type": "type"
      },
      "inputs": [
        {
          "memory_store_id": "x",
          "type": "memory_store"
        }
      ],
      "instructions": "instructions",
      "model": {
        "id": "x",
        "speed": "standard"
      },
      "output_behavior": {
        "type": "create_new"
      },
      "outputs": [
        {
          "memory_store_id": "memory_store_id",
          "type": "memory_store"
        }
      ],
      "session_id": "session_id",
      "status": "pending",
      "type": "dream",
      "usage": {
        "cache_creation_input_tokens": 0,
        "cache_read_input_tokens": 0,
        "input_tokens": 0,
        "output_tokens": 0
      }
    }
  ],
  "next_page": "next_page"
}