Create a Dream

BetaDream beta().dreams().create(, )

POST/v1/dreams

Create a Dream

Parameters

DreamCreateParams params

Optional<List<AnthropicBeta>> betas

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

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")

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")

List<BetaDreamInput> inputs

class BetaDreamMemoryStoreInput:

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.

String memoryStoreId

minLength1

Type type

class BetaDreamSessionsInput:

Input session transcripts the dream reads.

List<String> sessionIds

Type type

Model model

Model identifier and configuration applied to every pipeline stage.

String

class BetaDreamModelConfigParam:

Model identifier and configuration applied to every pipeline stage.

String id

Model identifier, e.g. "claude-opus-5". 1-256 characters.

minLength1

maxLength256

Optional<Speed> speed

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("standard")

FAST("fast")

Optional<String> instructions

minLength1

maxLength4096

Optional<BetaOutputBehavior> outputBehavior

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.

Returns

class BetaDream:

An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into an output memory store — a new store by default, or an existing store chosen via output_behavior. 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.

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);
    }
}

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

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