Claude Platform Docs

List Dreams

GET/v1/dreams

List Dreams

Query parameters
"created_at[gt]": optional string

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

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 parameter for include_archived

limit: optional number

Query parameter for limit

formatint32
page: optional string

Query parameter for page

statuses: optional array of BetaDreamStatus

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

One of the following:
"pending"
"running"
"completed"
"failed"
"canceled"
Headers
"anthropic-beta": optional array of AnthropicBeta

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

One of the following:
string
"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more
One of the following:
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
Returns
data: array of BetaDream { id, archived_at, created_at, 11 more }
id: string
archived_at: string or null

A timestamp in RFC 3339 format

formatdate-time
created_at: string

A timestamp in RFC 3339 format

formatdate-time
ended_at: string or null

A timestamp in RFC 3339 format

formatdate-time
error: BetaDreamError { message, type } or null

Failure detail for a Dream whose status is failed.

message: string
type: string
inputs: array of BetaDreamInput
One of the following:
BetaDreamMemoryStoreInput 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.

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

Input session transcripts the dream reads.

session_ids: array of string
type: "sessions"
instructions: string or null
model: BetaDreamModelConfig { 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: BetaOutputBehavior

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

type: "create_new"
BetaOutputBehaviorUpdateExisting 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.

memory_store_id: string
minLength1
type: "update_existing"
outputs: array of BetaDreamOutput { memory_store_id, type }
memory_store_id: string
type: "memory_store"
session_id: string or null
status: BetaDreamStatus

Lifecycle status of a Dream.

One of the following:
"pending"
"running"
"completed"
"failed"
"canceled"
type: "dream"
usage: BetaDreamUsage { 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 or null

List Dreams

curl https://api.anthropic.com/v1/dreams \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: dreaming-2026-04-21' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"
{
  "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"
}
Returns Examples
{
  "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"
}