--- title: Archive a Dream url: https://platform.claude.com/docs/en/api/go/beta/dreams/archive --- # Archive a Dream `client.Beta.Dreams.Archive(ctx, dreamID, body) (*BetaDream, error)` **POST** `/v1/dreams/{dream_id}/archive` 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](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=go#archive-a-dream) to learn more about archiving dreams. ## Parameters - `dreamID string` (path parameter) The ID of the dream to archive (`drm_...`). - `body BetaDreamArchiveParams` - `Betas []AnthropicBeta Optional` (header parameter) This endpoint is in beta: requests must send `dreaming-2026-04-21` in this header. - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - `const AnthropicBetaUserProfiles2026_09_04 AnthropicBeta = "user-profiles-2026-09-04"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` - `const AnthropicBetaMidConversationOutputConfig2026_07_01 AnthropicBeta = "mid-conversation-output-config-2026-07-01"` - `const AnthropicBetaThinkingBindingControls2026_08_01 AnthropicBeta = "thinking-binding-controls-2026-08-01"` - `const AnthropicBetaMidConversationSystemClearAt2026_08_21 AnthropicBeta = "mid-conversation-system-clear-at-2026-08-21"` - `const AnthropicBetaCompact2026_09_04 AnthropicBeta = "compact-2026-09-04"` - `const AnthropicBetaInlineTools2026_09_15 AnthropicBeta = "inline-tools-2026-09-15"` - `const AnthropicBetaMCPClient2026_09_15 AnthropicBeta = "mcp-client-2026-09-15"` - `const AnthropicBetaCEPlugins2026_09_01 AnthropicBeta = "ce-plugins-2026-09-01"` - `const AnthropicBetaSpendLimitReads2026_09_26 AnthropicBeta = "spend-limit-reads-2026-09-26"` - `const AnthropicBetaTelemetryDestinations2026_08_11 AnthropicBeta = "telemetry-destinations-2026-08-11"` - `WorkspaceID param.Opt[string] Optional` (header parameter) 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 - `type BetaDream` An asynchronous job that reads a memory store and past sessions, then writes a reorganized version of that memory store. By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead. 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. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=go#how-it-works) for what a dream reads and produces. - `Type BetaDreamType` - `ID string` The unique ID of the dream (`drm_...`). - `ArchivedAt Time` When the dream was archived, in RFC 3339, or `null` if it hasn't been archived. format: date-time - `CreatedAt Time` When the dream was created, in RFC 3339. Lists of dreams are sorted by this time, newest first. format: date-time - `EndedAt Time` When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`. format: date-time - `Error BetaDreamError` Why the dream failed, or `null` if `status` isn't `failed`. - `Type string` A code for why the dream failed, such as `timeout` or `internal_error`. The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=go#errors) lists common error codes and when they occur. - `Message string` A human-readable explanation of why the dream failed. - `Inputs []BetaDreamInputUnion` The sources that the dream reads, from the request that created it. - `type BetaDreamMemoryStoreInput` The memory store that a dream reads, given as an entry in `inputs`. With `output_behavior` set to `update_existing`, the dream writes its result into this memory store. Otherwise the dream doesn't change it. - `Type BetaDreamMemoryStoreInputType` - `MemoryStoreID string` The ID of the memory store for the dream to read (`memstore_...`). The memory store must be in the same workspace as the dream and must not be archived. minLength: 1 - `type BetaDreamSessionsInput` The sessions that a dream reads, given as an entry in `inputs`. - `Type BetaDreamSessionsInputType` - `SessionIDs []string` The IDs of the sessions whose transcripts the dream reads (`sesn_...`). Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order. The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=go#limits) lists all the limits on a dream. - `Instructions string` The guidance given when the dream was created, or `null` if none was given. - `Model BetaDreamModelConfig` The model that runs a dream, from the request that created it. The dream uses this model for all of its work. The response always gives the model as an object, even if the request gave only a model ID. - `ID string` The ID of the model that runs the dream, as given in the request that created it. minLength: 1, maxLength: 256 - `Speed BetaDreamModelConfigSpeed Optional` How fast the model generates output for the dream. Always `standard`. - `const BetaDreamModelConfigSpeedStandard BetaDreamModelConfigSpeed = "standard"` - `const BetaDreamModelConfigSpeedFast BetaDreamModelConfigSpeed = "fast"` - `OutputBehavior BetaOutputBehaviorUnion` Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior. - `type BetaOutputBehaviorCreateNew` Write the result to a new memory store that starts as a copy of the input memory store. This is the default. The new memory store is in the same workspace as the dream. The dream doesn't change the input memory store. - `Type BetaOutputBehaviorCreateNewType` - `type BetaOutputBehaviorUpdateExisting` Write the result into the input memory store instead of a new memory store. The credential must be allowed to write memory stores, or the request returns a 403 error. While another `update_existing` dream on the same memory store hasn't fully stopped, the request returns a 409 error. - `Type BetaOutputBehaviorUpdateExistingType` - `MemoryStoreID string` The ID of the memory store for the dream to write its result to (`memstore_...`). It must be the memory store in the `memory_store` entry of `inputs`. minLength: 1 - `Outputs []BetaDreamOutput` The memory store that holds the dream's result, as a one-item array, or an empty array until the dream records that memory store. The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=go#use-the-output) for how to review and use the result. - `Type BetaDreamOutputType` - `MemoryStoreID string` The ID of the memory store that the dream writes its result to (`memstore_...`). With `output_behavior` set to `create_new`, this is a new memory store. With `update_existing`, it is the input memory store. - `SessionID string` 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](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=go#watch-the-pipeline-run) for how to watch a running dream. - `Status BetaDreamStatus` 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](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=go#lifecycle) for what each status means. - `const BetaDreamStatusPending BetaDreamStatus = "pending"` The dream is waiting to start and hasn't read its inputs yet. `outputs` is empty and every `usage` count is zero. - `const BetaDreamStatusRunning BetaDreamStatus = "running"` The dream is reading its inputs and writing its result. `usage` updates while the dream has this status. - `const BetaDreamStatusCompleted BetaDreamStatus = "completed"` The dream finished and its output memory store holds the complete result. - `const BetaDreamStatusFailed BetaDreamStatus = "failed"` The dream stopped with an error, which `error` describes. If `outputs` references a memory store, that memory store keeps what the dream wrote before it stopped. - `const BetaDreamStatusCanceled BetaDreamStatus = "canceled"` A cancel request stopped the dream before it reached `completed` or `failed`. If `outputs` references a memory store, that memory store keeps what the dream wrote. `usage` can keep changing after the cancel. - `Usage BetaDreamUsage` The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing. - `CacheCreationInputTokens int64` The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations. format: int32 - `CacheReadInputTokens int64` The dream's input tokens that were read from the prompt cache. format: int32 - `InputTokens int64` The dream's input tokens that weren't read from or written to the prompt cache. format: int32 - `OutputTokens int64` The tokens that the model generated for the dream. format: int32 ## Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaDream, err := client.Beta.Dreams.Archive( context.TODO(), "dream_id", anthropic.BetaDreamArchiveParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaDream.ID) } ``` ### Response (200) ```json { "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 } } ```