Hide a completed, failed, or canceled dream from the default list of dreams.

Archiving a pending or running dream returns a 400 error, so cancel it first. Archiving an archived dream returns it unchanged. An archived dream can still be fetched by ID. Archiving can't be undone.

See the Dreams guide to learn more about archiving dreams.

post/v1/dreams/{dream_id}/archive?beta=true

Request

  • Base URL
    https://api.anthropic.com
  • Auth
    none declared

Path parameters

dream_idstring required

The ID of the dream to archive (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

When the dream was created, in RFC 3339.

Lists of dreams are sorted by this time, newest first.

ended_atstring date-time nullable required

A timestamp in RFC 3339 format

archived_atstring date-time nullable 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

    • info

      added the enum value ce-claude-code-managed-settings-2026-10-06 to the property items/anyOf[subschema #2]/ of the header request parameter anthropic-beta

    • info

      added the enum value user-profiles-billing-2026-10-01 to the property items/anyOf[subschema #2]/ of the header request parameter anthropic-beta