ANanthropics

Get a Dream

Changed on

Get a dream by ID to check its status, output memory store, and token usage.

Archived dreams are returned too.

See the Dreams guide for how to poll a dream and what each status means.

get/v1/dreams/{dream_id}?beta=true

Request

Path parameters

dream_idstring required

The ID of the dream to get (drm_...).

Headers

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

anthropic-workspace-idstring

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.

Response

Successful response (OK)

type'dream' required
idstring required

The unique ID of the dream (drm_...).

status'pending' | 'running' | 'completed' | 'failed' | 'canceled' required

Where a dream is in its lifecycle.

completed, failed, and canceled are final: once a dream has one of these statuses, its status doesn't change again.

See the Dreams guide for what each status means.

created_atstring date-time required

A timestamp in RFC 3339 format

ended_atstring date-time required

A timestamp in RFC 3339 format

archived_atstring date-time required

A timestamp in RFC 3339 format

instructionsstring nullable required

The guidance given when the dream was created, or null if none was given.

session_idstring nullable required

The ID of the session that runs the dream (sesn_...), or null if that session hasn't started.

Stream that session's events to follow what the dream reads and writes.

See the Dreams guide for how to watch a running dream.

Changes

  • 037a593978dcRevision changes
    • info

      added the enum value admin-user-sign-out-2026-10-08 to the property items/anyOf[subschema #2]/ of the header request parameter anthropic-beta

  • f538a797852cRevision changes
    • info

      added the enum value experimental-claude-tag-2026-10-21 to the property items/anyOf[subschema #2]/ of the header request parameter anthropic-beta