Create a Dream

BetaDream beta().dreams().create(params, requestOptions = RequestOptions.none())

POST/v1/dreams

Start an asynchronous job that uses past sessions to produce a reorganized version of a memory store and get back the dream to poll for the result.

By default the dream writes its result to a new memory store and doesn't change the input memory store. The response has status set to pending and an empty outputs array. Poll the dream until status is completed, failed, or canceled.

See the Dreams guide to learn more about creating dreams.

Parameters

DreamCreateParams params

Optional<List<AnthropicBeta>> betas⁠Header

This endpoint is in beta: requests must send dreaming-2026-04-21 in this header.

MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")

PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")

COMPUTER_USE_2024_10_22("computer-use-2024-10-22")

COMPUTER_USE_2025_01_24("computer-use-2025-01-24")

PDFS_2024_09_25("pdfs-2024-09-25")

TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")

TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")

OUTPUT_128K_2025_02_19("output-128k-2025-02-19")

FILES_API_2025_04_14("files-api-2025-04-14")

MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")

MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")

DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")

INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")

CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")

EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")

CONTEXT_1M_2025_08_07("context-1m-2025-08-07")

CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")

MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")

SKILLS_2025_10_02("skills-2025-10-02")

FAST_MODE_2026_02_01("fast-mode-2026-02-01")

OUTPUT_300K_2026_03_24("output-300k-2026-03-24")

USER_PROFILES_2026_03_24("user-profiles-2026-03-24")

USER_PROFILES_2026_08_18("user-profiles-2026-08-18")

USER_PROFILES_2026_09_04("user-profiles-2026-09-04")

ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")

MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")

CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")

DREAMING_2026_04_21("dreaming-2026-04-21")

THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")

SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")

SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")

FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")

FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")

AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")

MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")

COMPACT_2026_01_12("compact-2026-01-12")

COMPUTER_USE_2025_11_24("computer-use-2025-11-24")

MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")

STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")

TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")

THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")

CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")

MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")

THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")

MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")

COMPACT_2026_09_04("compact-2026-09-04")

INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")

MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")

CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")

SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")

TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")

Optional<String> workspaceId⁠Header

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.

List<BetaDreamInput> inputs

The memory store and sessions for the dream to read, as exactly one memory_store entry and exactly one sessions entry.

class BetaDreamMemoryStoreInput { type; memoryStoreId; }

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 type

String memoryStoreId

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.

minLength1

class BetaDreamSessionsInput { type; sessionIds; }

The sessions that a dream reads, given as an entry in inputs.

Type type

List<String> sessionIds

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 lists all the limits on a dream.

Model model

The model that runs a dream, given as a model ID or as an object with id and speed.

In the object form, speed can only be standard.

The limits table in the Dreams guide lists the supported models.

String

class BetaDreamModelConfigParam { id; speed; }

The object form of model in a request to create a dream.

String id

The ID of the model to run the dream with.

The ID can be 1 to 256 characters long.

The limits table in the Dreams guide lists the supported models.

minLength1

maxLength256

Optional<Speed> speed

How fast the model generates output for the dream. Defaults to standard.

Dreams accept only standard.

One of the following:

STANDARD("standard")

FAST("fast")

Optional<String> instructions

Guidance that steers how the dream reads the sessions and organizes the output memory store, from 1 to 4,096 characters.

See the Dreams guide for what kinds of instructions work well.

minLength1

maxLength4096

Optional<BetaOutputBehavior> outputBehavior

Which memory store a dream writes its result to. Defaults to create_new when left out of a create request.

Returns

class BetaDream { type; id; archivedAt; /* 11 more */ }

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 for what a dream reads and produces.

Create a Dream

package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.beta.dreams.BetaDream;
import com.anthropic.models.beta.dreams.DreamCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        DreamCreateParams params = DreamCreateParams.builder()
            .addMemoryStoreInput("x")
            .model("string")
            .build();
        BetaDream betaDream = client.beta().dreams().create(params);
    }
}

Response 200

{
  "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
  }
}

Returns Examples

Response 200

{
  "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
  }
}