Claude Platform Docs

Create a Dream

$ ant beta:dreams create
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
--input: array of BetaDreamInput

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

--model: string or BetaDreamModelConfigParam

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.

--instructions: optional string

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
--output-behavior: optional BetaOutputBehaviorCreateNew or BetaOutputBehaviorUpdateExisting

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

--beta: optional array of AnthropicBeta⁠Header parameter

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

--workspace-id: optional string⁠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
beta_dream: object{ type: "dream", id, archived_at, 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.

type: "dream"
id: string

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

archived_at: string

When the dream was archived, in RFC 3339, or null if it hasn't been archived.

formatdate-time
created_at: string

When the dream was created, in RFC 3339.

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

formatdate-time
ended_at: string

When the dream reached completed, failed, or canceled, in RFC 3339, or null if it is still pending or running.

formatdate-time
error: object{ type, message }

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 lists common error codes and when they occur.

message: string

A human-readable explanation of why the dream failed.

inputs: array of BetaDreamInput

The sources that the dream reads, from the request that created it.

One of the following:
beta_dream_memory_store_input: object{ type: "memory_store", memory_store_id }

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: "memory_store"
memory_store_id: 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.

minLength1
beta_dream_sessions_input: object{ type: "sessions", session_ids }

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

type: "sessions"
session_ids: array of 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 lists all the limits on a dream.

instructions: string

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

model: object{ id, speed }

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.

minLength1
maxLength256
speed: optional "standard" or "fast"

How fast the model generates output for the dream. Always standard.

One of the following:
"standard"
"fast"
output_behavior: BetaOutputBehaviorCreateNew or BetaOutputBehaviorUpdateExisting

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.

One of the following:
beta_output_behavior_create_new: object{ type: "create_new" }

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: "create_new"
beta_output_behavior_update_existing: object{ type: "update_existing", memory_store_id }

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: "update_existing"
memory_store_id: 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.

minLength1
outputs: array of BetaDreamOutput { type: "memory_store", memory_store_id }

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 for how to review and use the result.

type: "memory_store"
memory_store_id: 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.

session_id: 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 for how to watch a running dream.

status: "pending" or "running" or "completed" or 2 more

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.

One of the following:
"pending"

The dream is waiting to start and hasn't read its inputs yet.

outputs is empty and every usage count is zero.

"running"

The dream is reading its inputs and writing its result.

usage updates while the dream has this status.

"completed"

The dream finished and its output memory store holds the complete result.

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

"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: object{ cache_creation_input_tokens, cache_read_input_tokens, input_tokens, output_tokens }

The dream's token counts, which stop changing once its status is completed or failed. After a cancel, they can keep changing.

cache_creation_input_tokens: number

The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations.

formatint32
cache_read_input_tokens: number

The dream's input tokens that were read from the prompt cache.

formatint32
input_tokens: number

The dream's input tokens that weren't read from or written to the prompt cache.

formatint32
output_tokens: number

The tokens that the model generated for the dream.

formatint32
Create a Dream
ant beta:dreams create \
  --api-key my-anthropic-api-key \
  --input '{memory_store_id: x, type: memory_store}' \
  --model string
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
  }
}