--- title: Create a Dream url: https://platform.claude.com/docs/en/api/php/beta/dreams/create --- # Create a Dream `$client->beta->dreams->create(list inputs, Model model, ?string instructions, ?BetaOutputBehavior outputBehavior, ?list betas, ?string workspaceID): BetaDream` **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](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=php#create-a-dream) to learn more about creating dreams. ## Parameters - `inputs: list` The memory store and sessions for the dream to read, as exactly one `memory_store` entry and exactly one `sessions` entry. - `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 [Availability section of the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=php#feature-availability) 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](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=php#steer-with-instructions) for what kinds of instructions work well. - `outputBehavior?: optional BetaOutputBehavior` Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request. - `betas?: optional list` (header parameter) This endpoint is in beta: requests must send `dreaming-2026-04-21` in this header. - `workspaceID?: 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 - `class BetaDream` - `"dream" type` - `string id` The unique ID of the dream (`drm_...`). - `?\Datetime archivedAt` When the dream was archived, in RFC 3339, or `null` if it hasn't been archived. - `\Datetime createdAt` When the dream was created, in RFC 3339. Lists of dreams are sorted by this time, newest first. - `?\Datetime endedAt` When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`. - `?BetaDreamError error` Why the dream failed, or `null` if `status` isn't `failed`. - `list inputs` The sources that the dream reads, from the request that created it. - `?string instructions` The guidance given when the dream was created, or `null` if none was given. - `BetaDreamModelConfig model` 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. - `BetaOutputBehavior outputBehavior` 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. - `list outputs` 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=php#use-the-output) for how to review and use the result. - `?string sessionID` 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=php#watch-the-pipeline-run) for how to watch a running dream. - `BetaDreamStatus status` 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=php#lifecycle) for what each status means. - `BetaDreamUsage usage` The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing. ## Example ```php beta->dreams->create( inputs: [['memoryStoreID' => 'x', 'type' => 'memory_store']], model: 'string', instructions: 'x', outputBehavior: ['type' => 'create_new'], betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($betaDream); ``` ### 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 } } ```