SPB Git

Repository Public

dreams.md 47.0 KB 2,141 lines markdown

1---2title: Dreams3url: https://platform.claude.com/docs/en/api/beta/dreams4---56# Dreams78## Create a Dream910**POST** `/v1/dreams`1112Create a Dream1314### Headers1516- `"anthropic-beta": optional array of AnthropicBeta`1718  Optional header to specify the beta version(s) you want to use.1920  - `string`2122  - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`2324    - `"message-batches-2024-09-24"`2526    - `"prompt-caching-2024-07-31"`2728    - `"computer-use-2024-10-22"`2930    - `"computer-use-2025-01-24"`3132    - `"pdfs-2024-09-25"`3334    - `"token-counting-2024-11-01"`3536    - `"token-efficient-tools-2025-02-19"`3738    - `"output-128k-2025-02-19"`3940    - `"files-api-2025-04-14"`4142    - `"mcp-client-2025-04-04"`4344    - `"mcp-client-2025-11-20"`4546    - `"dev-full-thinking-2025-05-14"`4748    - `"interleaved-thinking-2025-05-14"`4950    - `"code-execution-2025-05-22"`5152    - `"extended-cache-ttl-2025-04-11"`5354    - `"context-1m-2025-08-07"`5556    - `"context-management-2025-06-27"`5758    - `"model-context-window-exceeded-2025-08-26"`5960    - `"skills-2025-10-02"`6162    - `"fast-mode-2026-02-01"`6364    - `"output-300k-2026-03-24"`6566    - `"user-profiles-2026-03-24"`6768    - `"user-profiles-2026-08-18"`6970    - `"user-profiles-2026-09-04"`7172    - `"advisor-tool-2026-03-01"`7374    - `"managed-agents-2026-04-01"`7576    - `"cache-diagnosis-2026-04-07"`7778    - `"dreaming-2026-04-21"`7980    - `"thinking-token-count-2026-05-13"`8182    - `"server-side-fallback-2026-06-01"`8384    - `"server-side-fallback-2026-07-01"`8586    - `"fallback-credit-2026-06-01"`8788    - `"fallback-credit-2026-07-01"`8990    - `"agent-memory-2026-07-22"`9192    - `"mid-conversation-tool-changes-2026-07-01"`9394    - `"compact-2026-01-12"`9596    - `"computer-use-2025-11-24"`9798    - `"mcp-tunnels-2026-06-22"`99100    - `"structured-outputs-2025-11-13"`101102    - `"task-budgets-2026-03-13"`103104    - `"thinking-display-updates-2026-08-18"`105106    - `"ce-user-management-2026-07-13"`107108    - `"mid-conversation-output-config-2026-07-01"`109110    - `"thinking-binding-controls-2026-08-01"`111112    - `"mid-conversation-system-clear-at-2026-08-21"`113114    - `"compact-2026-09-04"`115116- `"anthropic-workspace-id": optional string`117118### Body parameters119120- `inputs: array of BetaDreamInput`121122  - `BetaDreamMemoryStoreInput object`123124    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.125126    - `type: "memory_store"`127128    - `memory_store_id: string`129130      minLength: 1131132  - `BetaDreamSessionsInput object`133134    Input session transcripts the dream reads.135136    - `type: "sessions"`137138    - `session_ids: array of string`139140- `model: string or BetaDreamModelConfigParam`141142  - `string`143144  - `BetaDreamModelConfigParam object`145146    Model identifier and configuration applied to every pipeline stage.147148    - `id: string`149150      Model identifier, e.g. "claude-opus-5". 1-256 characters.151152      minLength: 1, maxLength: 256153154    - `speed: optional "standard" or "fast" or null`155156      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.157158      - `"standard"`159160      - `"fast"`161162- `instructions: optional string or null`163164  minLength: 1, maxLength: 4096165166- `output_behavior: optional BetaOutputBehavior`167168  - `BetaOutputBehaviorCreateNew object`169170    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.171172    - `type: "create_new"`173174  - `BetaOutputBehaviorUpdateExisting object`175176    The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.177178    - `type: "update_existing"`179180    - `memory_store_id: string`181182      minLength: 1183184### Returns185186- `BetaDream object`187188  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.189190  - `type: "dream"`191192  - `id: string`193194  - `archived_at: string or null`195196    A timestamp in RFC 3339 format197198    format: date-time199200  - `created_at: string`201202    A timestamp in RFC 3339 format203204    format: date-time205206  - `ended_at: string or null`207208    A timestamp in RFC 3339 format209210    format: date-time211212  - `error: BetaDreamError or null`213214    Failure detail for a Dream whose `status` is `failed`.215216    - `type: string`217218    - `message: string`219220  - `inputs: array of BetaDreamInput`221222    - `BetaDreamMemoryStoreInput object`223224      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.225226      - `type: "memory_store"`227228      - `memory_store_id: string`229230        minLength: 1231232    - `BetaDreamSessionsInput object`233234      Input session transcripts the dream reads.235236      - `type: "sessions"`237238      - `session_ids: array of string`239240  - `instructions: string or null`241242  - `model: BetaDreamModelConfig`243244    Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.245246    - `id: string`247248      Model identifier, e.g. "claude-opus-5". 1-256 characters.249250      minLength: 1, maxLength: 256251252    - `speed: optional "standard" or "fast"`253254      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.255256      - `"standard"`257258      - `"fast"`259260  - `output_behavior: BetaOutputBehavior`261262    - `BetaOutputBehaviorCreateNew object`263264      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.265266      - `type: "create_new"`267268    - `BetaOutputBehaviorUpdateExisting object`269270      The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.271272      - `type: "update_existing"`273274      - `memory_store_id: string`275276        minLength: 1277278  - `outputs: array of BetaDreamOutput`279280    - `type: "memory_store"`281282    - `memory_store_id: string`283284  - `session_id: string or null`285286  - `status: BetaDreamStatus`287288    Lifecycle status of a Dream.289290    - `"pending"`291292    - `"running"`293294    - `"completed"`295296    - `"failed"`297298    - `"canceled"`299300  - `usage: BetaDreamUsage`301302    Cumulative token usage for the dream across every pipeline stage.303304    - `cache_creation_input_tokens: number`305306      Total tokens used to create prompt-cache entries (sum of all TTL tiers).307308      format: int32309310    - `cache_read_input_tokens: number`311312      Total tokens read from prompt cache.313314      format: int32315316    - `input_tokens: number`317318      Total uncached input tokens consumed across every pipeline stage.319320      format: int32321322    - `output_tokens: number`323324      Total output tokens generated across every pipeline stage.325326      format: int32327328### Example329330```bash331curl https://api.anthropic.com/v1/dreams \332    -H 'Content-Type: application/json' \333    -H 'anthropic-version: 2023-06-01' \334    -H 'anthropic-beta: dreaming-2026-04-21' \335    -H "X-Api-Key: $ANTHROPIC_API_KEY" \336    -d '{337          "inputs": [338            {339              "memory_store_id": "x",340              "type": "memory_store"341            }342          ],343          "model": "string"344        }'345```346347#### Response (200)348349```json350{351  "id": "id",352  "archived_at": "2019-12-27T18:11:19.117Z",353  "created_at": "2019-12-27T18:11:19.117Z",354  "ended_at": "2019-12-27T18:11:19.117Z",355  "error": {356    "message": "message",357    "type": "type"358  },359  "inputs": [360    {361      "memory_store_id": "x",362      "type": "memory_store"363    }364  ],365  "instructions": "instructions",366  "model": {367    "id": "x",368    "speed": "standard"369  },370  "output_behavior": {371    "type": "create_new"372  },373  "outputs": [374    {375      "memory_store_id": "memory_store_id",376      "type": "memory_store"377    }378  ],379  "session_id": "session_id",380  "status": "pending",381  "type": "dream",382  "usage": {383    "cache_creation_input_tokens": 0,384    "cache_read_input_tokens": 0,385    "input_tokens": 0,386    "output_tokens": 0387  }388}389```390391## List Dreams392393**GET** `/v1/dreams`394395List Dreams396397### Query parameters398399- `"created_at[gt]": optional string`400401  Return dreams with `created_at` strictly after this timestamp (exclusive lower bound, RFC 3339). Unset applies no lower bound.402403  format: date-time404405- `"created_at[lt]": optional string`406407  Return dreams with `created_at` strictly before this timestamp (exclusive upper bound, RFC 3339). Unset applies no upper bound.408409  format: date-time410411- `include_archived: optional boolean`412413  Query parameter for include_archived414415- `limit: optional number`416417  Query parameter for limit418419  format: int32420421- `page: optional string`422423  Query parameter for page424425- `statuses: optional array of BetaDreamStatus`426427  Filter by lifecycle status. Repeat the parameter to match any of multiple statuses. Empty applies no status filter.428429  - `"pending"`430431  - `"running"`432433  - `"completed"`434435  - `"failed"`436437  - `"canceled"`438439### Headers440441- `"anthropic-beta": optional array of AnthropicBeta`442443  Optional header to specify the beta version(s) you want to use.444445  - `string`446447  - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`448449    - `"message-batches-2024-09-24"`450451    - `"prompt-caching-2024-07-31"`452453    - `"computer-use-2024-10-22"`454455    - `"computer-use-2025-01-24"`456457    - `"pdfs-2024-09-25"`458459    - `"token-counting-2024-11-01"`460461    - `"token-efficient-tools-2025-02-19"`462463    - `"output-128k-2025-02-19"`464465    - `"files-api-2025-04-14"`466467    - `"mcp-client-2025-04-04"`468469    - `"mcp-client-2025-11-20"`470471    - `"dev-full-thinking-2025-05-14"`472473    - `"interleaved-thinking-2025-05-14"`474475    - `"code-execution-2025-05-22"`476477    - `"extended-cache-ttl-2025-04-11"`478479    - `"context-1m-2025-08-07"`480481    - `"context-management-2025-06-27"`482483    - `"model-context-window-exceeded-2025-08-26"`484485    - `"skills-2025-10-02"`486487    - `"fast-mode-2026-02-01"`488489    - `"output-300k-2026-03-24"`490491    - `"user-profiles-2026-03-24"`492493    - `"user-profiles-2026-08-18"`494495    - `"user-profiles-2026-09-04"`496497    - `"advisor-tool-2026-03-01"`498499    - `"managed-agents-2026-04-01"`500501    - `"cache-diagnosis-2026-04-07"`502503    - `"dreaming-2026-04-21"`504505    - `"thinking-token-count-2026-05-13"`506507    - `"server-side-fallback-2026-06-01"`508509    - `"server-side-fallback-2026-07-01"`510511    - `"fallback-credit-2026-06-01"`512513    - `"fallback-credit-2026-07-01"`514515    - `"agent-memory-2026-07-22"`516517    - `"mid-conversation-tool-changes-2026-07-01"`518519    - `"compact-2026-01-12"`520521    - `"computer-use-2025-11-24"`522523    - `"mcp-tunnels-2026-06-22"`524525    - `"structured-outputs-2025-11-13"`526527    - `"task-budgets-2026-03-13"`528529    - `"thinking-display-updates-2026-08-18"`530531    - `"ce-user-management-2026-07-13"`532533    - `"mid-conversation-output-config-2026-07-01"`534535    - `"thinking-binding-controls-2026-08-01"`536537    - `"mid-conversation-system-clear-at-2026-08-21"`538539    - `"compact-2026-09-04"`540541- `"anthropic-workspace-id": optional string`542543### Returns544545- `data: array of BetaDream`546547  - `type: "dream"`548549  - `id: string`550551  - `archived_at: string or null`552553    A timestamp in RFC 3339 format554555    format: date-time556557  - `created_at: string`558559    A timestamp in RFC 3339 format560561    format: date-time562563  - `ended_at: string or null`564565    A timestamp in RFC 3339 format566567    format: date-time568569  - `error: BetaDreamError or null`570571    Failure detail for a Dream whose `status` is `failed`.572573    - `type: string`574575    - `message: string`576577  - `inputs: array of BetaDreamInput`578579    - `BetaDreamMemoryStoreInput object`580581      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.582583      - `type: "memory_store"`584585      - `memory_store_id: string`586587        minLength: 1588589    - `BetaDreamSessionsInput object`590591      Input session transcripts the dream reads.592593      - `type: "sessions"`594595      - `session_ids: array of string`596597  - `instructions: string or null`598599  - `model: BetaDreamModelConfig`600601    Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.602603    - `id: string`604605      Model identifier, e.g. "claude-opus-5". 1-256 characters.606607      minLength: 1, maxLength: 256608609    - `speed: optional "standard" or "fast"`610611      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.612613      - `"standard"`614615      - `"fast"`616617  - `output_behavior: BetaOutputBehavior`618619    - `BetaOutputBehaviorCreateNew object`620621      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.622623      - `type: "create_new"`624625    - `BetaOutputBehaviorUpdateExisting object`626627      The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.628629      - `type: "update_existing"`630631      - `memory_store_id: string`632633        minLength: 1634635  - `outputs: array of BetaDreamOutput`636637    - `type: "memory_store"`638639    - `memory_store_id: string`640641  - `session_id: string or null`642643  - `status: BetaDreamStatus`644645    Lifecycle status of a Dream.646647    - `"pending"`648649    - `"running"`650651    - `"completed"`652653    - `"failed"`654655    - `"canceled"`656657  - `usage: BetaDreamUsage`658659    Cumulative token usage for the dream across every pipeline stage.660661    - `cache_creation_input_tokens: number`662663      Total tokens used to create prompt-cache entries (sum of all TTL tiers).664665      format: int32666667    - `cache_read_input_tokens: number`668669      Total tokens read from prompt cache.670671      format: int32672673    - `input_tokens: number`674675      Total uncached input tokens consumed across every pipeline stage.676677      format: int32678679    - `output_tokens: number`680681      Total output tokens generated across every pipeline stage.682683      format: int32684685- `next_page: string or null`686687### Example688689```bash690curl https://api.anthropic.com/v1/dreams \691    -H 'anthropic-version: 2023-06-01' \692    -H 'anthropic-beta: dreaming-2026-04-21' \693    -H "X-Api-Key: $ANTHROPIC_API_KEY"694```695696#### Response (200)697698```json699{700  "data": [701    {702      "id": "id",703      "archived_at": "2019-12-27T18:11:19.117Z",704      "created_at": "2019-12-27T18:11:19.117Z",705      "ended_at": "2019-12-27T18:11:19.117Z",706      "error": {707        "message": "message",708        "type": "type"709      },710      "inputs": [711        {712          "memory_store_id": "x",713          "type": "memory_store"714        }715      ],716      "instructions": "instructions",717      "model": {718        "id": "x",719        "speed": "standard"720      },721      "output_behavior": {722        "type": "create_new"723      },724      "outputs": [725        {726          "memory_store_id": "memory_store_id",727          "type": "memory_store"728        }729      ],730      "session_id": "session_id",731      "status": "pending",732      "type": "dream",733      "usage": {734        "cache_creation_input_tokens": 0,735        "cache_read_input_tokens": 0,736        "input_tokens": 0,737        "output_tokens": 0738      }739    }740  ],741  "next_page": "next_page"742}743```744745## Get a Dream746747**GET** `/v1/dreams/{dream_id}`748749Get a Dream750751### Path parameters752753- `dream_id: string`754755### Headers756757- `"anthropic-beta": optional array of AnthropicBeta`758759  Optional header to specify the beta version(s) you want to use.760761  - `string`762763  - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`764765    - `"message-batches-2024-09-24"`766767    - `"prompt-caching-2024-07-31"`768769    - `"computer-use-2024-10-22"`770771    - `"computer-use-2025-01-24"`772773    - `"pdfs-2024-09-25"`774775    - `"token-counting-2024-11-01"`776777    - `"token-efficient-tools-2025-02-19"`778779    - `"output-128k-2025-02-19"`780781    - `"files-api-2025-04-14"`782783    - `"mcp-client-2025-04-04"`784785    - `"mcp-client-2025-11-20"`786787    - `"dev-full-thinking-2025-05-14"`788789    - `"interleaved-thinking-2025-05-14"`790791    - `"code-execution-2025-05-22"`792793    - `"extended-cache-ttl-2025-04-11"`794795    - `"context-1m-2025-08-07"`796797    - `"context-management-2025-06-27"`798799    - `"model-context-window-exceeded-2025-08-26"`800801    - `"skills-2025-10-02"`802803    - `"fast-mode-2026-02-01"`804805    - `"output-300k-2026-03-24"`806807    - `"user-profiles-2026-03-24"`808809    - `"user-profiles-2026-08-18"`810811    - `"user-profiles-2026-09-04"`812813    - `"advisor-tool-2026-03-01"`814815    - `"managed-agents-2026-04-01"`816817    - `"cache-diagnosis-2026-04-07"`818819    - `"dreaming-2026-04-21"`820821    - `"thinking-token-count-2026-05-13"`822823    - `"server-side-fallback-2026-06-01"`824825    - `"server-side-fallback-2026-07-01"`826827    - `"fallback-credit-2026-06-01"`828829    - `"fallback-credit-2026-07-01"`830831    - `"agent-memory-2026-07-22"`832833    - `"mid-conversation-tool-changes-2026-07-01"`834835    - `"compact-2026-01-12"`836837    - `"computer-use-2025-11-24"`838839    - `"mcp-tunnels-2026-06-22"`840841    - `"structured-outputs-2025-11-13"`842843    - `"task-budgets-2026-03-13"`844845    - `"thinking-display-updates-2026-08-18"`846847    - `"ce-user-management-2026-07-13"`848849    - `"mid-conversation-output-config-2026-07-01"`850851    - `"thinking-binding-controls-2026-08-01"`852853    - `"mid-conversation-system-clear-at-2026-08-21"`854855    - `"compact-2026-09-04"`856857- `"anthropic-workspace-id": optional string`858859### Returns860861- `BetaDream object`862863  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.864865  - `type: "dream"`866867  - `id: string`868869  - `archived_at: string or null`870871    A timestamp in RFC 3339 format872873    format: date-time874875  - `created_at: string`876877    A timestamp in RFC 3339 format878879    format: date-time880881  - `ended_at: string or null`882883    A timestamp in RFC 3339 format884885    format: date-time886887  - `error: BetaDreamError or null`888889    Failure detail for a Dream whose `status` is `failed`.890891    - `type: string`892893    - `message: string`894895  - `inputs: array of BetaDreamInput`896897    - `BetaDreamMemoryStoreInput object`898899      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.900901      - `type: "memory_store"`902903      - `memory_store_id: string`904905        minLength: 1906907    - `BetaDreamSessionsInput object`908909      Input session transcripts the dream reads.910911      - `type: "sessions"`912913      - `session_ids: array of string`914915  - `instructions: string or null`916917  - `model: BetaDreamModelConfig`918919    Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.920921    - `id: string`922923      Model identifier, e.g. "claude-opus-5". 1-256 characters.924925      minLength: 1, maxLength: 256926927    - `speed: optional "standard" or "fast"`928929      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.930931      - `"standard"`932933      - `"fast"`934935  - `output_behavior: BetaOutputBehavior`936937    - `BetaOutputBehaviorCreateNew object`938939      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.940941      - `type: "create_new"`942943    - `BetaOutputBehaviorUpdateExisting object`944945      The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.946947      - `type: "update_existing"`948949      - `memory_store_id: string`950951        minLength: 1952953  - `outputs: array of BetaDreamOutput`954955    - `type: "memory_store"`956957    - `memory_store_id: string`958959  - `session_id: string or null`960961  - `status: BetaDreamStatus`962963    Lifecycle status of a Dream.964965    - `"pending"`966967    - `"running"`968969    - `"completed"`970971    - `"failed"`972973    - `"canceled"`974975  - `usage: BetaDreamUsage`976977    Cumulative token usage for the dream across every pipeline stage.978979    - `cache_creation_input_tokens: number`980981      Total tokens used to create prompt-cache entries (sum of all TTL tiers).982983      format: int32984985    - `cache_read_input_tokens: number`986987      Total tokens read from prompt cache.988989      format: int32990991    - `input_tokens: number`992993      Total uncached input tokens consumed across every pipeline stage.994995      format: int32996997    - `output_tokens: number`998999      Total output tokens generated across every pipeline stage.10001001      format: int3210021003### Example10041005```bash1006curl https://api.anthropic.com/v1/dreams/$DREAM_ID \1007    -H 'anthropic-version: 2023-06-01' \1008    -H 'anthropic-beta: dreaming-2026-04-21' \1009    -H "X-Api-Key: $ANTHROPIC_API_KEY"1010```10111012#### Response (200)10131014```json1015{1016  "id": "id",1017  "archived_at": "2019-12-27T18:11:19.117Z",1018  "created_at": "2019-12-27T18:11:19.117Z",1019  "ended_at": "2019-12-27T18:11:19.117Z",1020  "error": {1021    "message": "message",1022    "type": "type"1023  },1024  "inputs": [1025    {1026      "memory_store_id": "x",1027      "type": "memory_store"1028    }1029  ],1030  "instructions": "instructions",1031  "model": {1032    "id": "x",1033    "speed": "standard"1034  },1035  "output_behavior": {1036    "type": "create_new"1037  },1038  "outputs": [1039    {1040      "memory_store_id": "memory_store_id",1041      "type": "memory_store"1042    }1043  ],1044  "session_id": "session_id",1045  "status": "pending",1046  "type": "dream",1047  "usage": {1048    "cache_creation_input_tokens": 0,1049    "cache_read_input_tokens": 0,1050    "input_tokens": 0,1051    "output_tokens": 01052  }1053}1054```10551056## Cancel a Dream10571058**POST** `/v1/dreams/{dream_id}/cancel`10591060Cancel a Dream10611062### Path parameters10631064- `dream_id: string`10651066### Headers10671068- `"anthropic-beta": optional array of AnthropicBeta`10691070  Optional header to specify the beta version(s) you want to use.10711072  - `string`10731074  - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`10751076    - `"message-batches-2024-09-24"`10771078    - `"prompt-caching-2024-07-31"`10791080    - `"computer-use-2024-10-22"`10811082    - `"computer-use-2025-01-24"`10831084    - `"pdfs-2024-09-25"`10851086    - `"token-counting-2024-11-01"`10871088    - `"token-efficient-tools-2025-02-19"`10891090    - `"output-128k-2025-02-19"`10911092    - `"files-api-2025-04-14"`10931094    - `"mcp-client-2025-04-04"`10951096    - `"mcp-client-2025-11-20"`10971098    - `"dev-full-thinking-2025-05-14"`10991100    - `"interleaved-thinking-2025-05-14"`11011102    - `"code-execution-2025-05-22"`11031104    - `"extended-cache-ttl-2025-04-11"`11051106    - `"context-1m-2025-08-07"`11071108    - `"context-management-2025-06-27"`11091110    - `"model-context-window-exceeded-2025-08-26"`11111112    - `"skills-2025-10-02"`11131114    - `"fast-mode-2026-02-01"`11151116    - `"output-300k-2026-03-24"`11171118    - `"user-profiles-2026-03-24"`11191120    - `"user-profiles-2026-08-18"`11211122    - `"user-profiles-2026-09-04"`11231124    - `"advisor-tool-2026-03-01"`11251126    - `"managed-agents-2026-04-01"`11271128    - `"cache-diagnosis-2026-04-07"`11291130    - `"dreaming-2026-04-21"`11311132    - `"thinking-token-count-2026-05-13"`11331134    - `"server-side-fallback-2026-06-01"`11351136    - `"server-side-fallback-2026-07-01"`11371138    - `"fallback-credit-2026-06-01"`11391140    - `"fallback-credit-2026-07-01"`11411142    - `"agent-memory-2026-07-22"`11431144    - `"mid-conversation-tool-changes-2026-07-01"`11451146    - `"compact-2026-01-12"`11471148    - `"computer-use-2025-11-24"`11491150    - `"mcp-tunnels-2026-06-22"`11511152    - `"structured-outputs-2025-11-13"`11531154    - `"task-budgets-2026-03-13"`11551156    - `"thinking-display-updates-2026-08-18"`11571158    - `"ce-user-management-2026-07-13"`11591160    - `"mid-conversation-output-config-2026-07-01"`11611162    - `"thinking-binding-controls-2026-08-01"`11631164    - `"mid-conversation-system-clear-at-2026-08-21"`11651166    - `"compact-2026-09-04"`11671168- `"anthropic-workspace-id": optional string`11691170### Returns11711172- `BetaDream object`11731174  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.11751176  - `type: "dream"`11771178  - `id: string`11791180  - `archived_at: string or null`11811182    A timestamp in RFC 3339 format11831184    format: date-time11851186  - `created_at: string`11871188    A timestamp in RFC 3339 format11891190    format: date-time11911192  - `ended_at: string or null`11931194    A timestamp in RFC 3339 format11951196    format: date-time11971198  - `error: BetaDreamError or null`11991200    Failure detail for a Dream whose `status` is `failed`.12011202    - `type: string`12031204    - `message: string`12051206  - `inputs: array of BetaDreamInput`12071208    - `BetaDreamMemoryStoreInput object`12091210      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.12111212      - `type: "memory_store"`12131214      - `memory_store_id: string`12151216        minLength: 112171218    - `BetaDreamSessionsInput object`12191220      Input session transcripts the dream reads.12211222      - `type: "sessions"`12231224      - `session_ids: array of string`12251226  - `instructions: string or null`12271228  - `model: BetaDreamModelConfig`12291230    Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.12311232    - `id: string`12331234      Model identifier, e.g. "claude-opus-5". 1-256 characters.12351236      minLength: 1, maxLength: 25612371238    - `speed: optional "standard" or "fast"`12391240      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.12411242      - `"standard"`12431244      - `"fast"`12451246  - `output_behavior: BetaOutputBehavior`12471248    - `BetaOutputBehaviorCreateNew object`12491250      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.12511252      - `type: "create_new"`12531254    - `BetaOutputBehaviorUpdateExisting object`12551256      The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.12571258      - `type: "update_existing"`12591260      - `memory_store_id: string`12611262        minLength: 112631264  - `outputs: array of BetaDreamOutput`12651266    - `type: "memory_store"`12671268    - `memory_store_id: string`12691270  - `session_id: string or null`12711272  - `status: BetaDreamStatus`12731274    Lifecycle status of a Dream.12751276    - `"pending"`12771278    - `"running"`12791280    - `"completed"`12811282    - `"failed"`12831284    - `"canceled"`12851286  - `usage: BetaDreamUsage`12871288    Cumulative token usage for the dream across every pipeline stage.12891290    - `cache_creation_input_tokens: number`12911292      Total tokens used to create prompt-cache entries (sum of all TTL tiers).12931294      format: int3212951296    - `cache_read_input_tokens: number`12971298      Total tokens read from prompt cache.12991300      format: int3213011302    - `input_tokens: number`13031304      Total uncached input tokens consumed across every pipeline stage.13051306      format: int3213071308    - `output_tokens: number`13091310      Total output tokens generated across every pipeline stage.13111312      format: int3213131314### Example13151316```bash1317curl https://api.anthropic.com/v1/dreams/$DREAM_ID/cancel \1318    -X POST \1319    -H 'anthropic-version: 2023-06-01' \1320    -H 'anthropic-beta: dreaming-2026-04-21' \1321    -H "X-Api-Key: $ANTHROPIC_API_KEY"1322```13231324#### Response (200)13251326```json1327{1328  "id": "id",1329  "archived_at": "2019-12-27T18:11:19.117Z",1330  "created_at": "2019-12-27T18:11:19.117Z",1331  "ended_at": "2019-12-27T18:11:19.117Z",1332  "error": {1333    "message": "message",1334    "type": "type"1335  },1336  "inputs": [1337    {1338      "memory_store_id": "x",1339      "type": "memory_store"1340    }1341  ],1342  "instructions": "instructions",1343  "model": {1344    "id": "x",1345    "speed": "standard"1346  },1347  "output_behavior": {1348    "type": "create_new"1349  },1350  "outputs": [1351    {1352      "memory_store_id": "memory_store_id",1353      "type": "memory_store"1354    }1355  ],1356  "session_id": "session_id",1357  "status": "pending",1358  "type": "dream",1359  "usage": {1360    "cache_creation_input_tokens": 0,1361    "cache_read_input_tokens": 0,1362    "input_tokens": 0,1363    "output_tokens": 01364  }1365}1366```13671368## Archive a Dream13691370**POST** `/v1/dreams/{dream_id}/archive`13711372Archive a Dream13731374### Path parameters13751376- `dream_id: string`13771378### Headers13791380- `"anthropic-beta": optional array of AnthropicBeta`13811382  Optional header to specify the beta version(s) you want to use.13831384  - `string`13851386  - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`13871388    - `"message-batches-2024-09-24"`13891390    - `"prompt-caching-2024-07-31"`13911392    - `"computer-use-2024-10-22"`13931394    - `"computer-use-2025-01-24"`13951396    - `"pdfs-2024-09-25"`13971398    - `"token-counting-2024-11-01"`13991400    - `"token-efficient-tools-2025-02-19"`14011402    - `"output-128k-2025-02-19"`14031404    - `"files-api-2025-04-14"`14051406    - `"mcp-client-2025-04-04"`14071408    - `"mcp-client-2025-11-20"`14091410    - `"dev-full-thinking-2025-05-14"`14111412    - `"interleaved-thinking-2025-05-14"`14131414    - `"code-execution-2025-05-22"`14151416    - `"extended-cache-ttl-2025-04-11"`14171418    - `"context-1m-2025-08-07"`14191420    - `"context-management-2025-06-27"`14211422    - `"model-context-window-exceeded-2025-08-26"`14231424    - `"skills-2025-10-02"`14251426    - `"fast-mode-2026-02-01"`14271428    - `"output-300k-2026-03-24"`14291430    - `"user-profiles-2026-03-24"`14311432    - `"user-profiles-2026-08-18"`14331434    - `"user-profiles-2026-09-04"`14351436    - `"advisor-tool-2026-03-01"`14371438    - `"managed-agents-2026-04-01"`14391440    - `"cache-diagnosis-2026-04-07"`14411442    - `"dreaming-2026-04-21"`14431444    - `"thinking-token-count-2026-05-13"`14451446    - `"server-side-fallback-2026-06-01"`14471448    - `"server-side-fallback-2026-07-01"`14491450    - `"fallback-credit-2026-06-01"`14511452    - `"fallback-credit-2026-07-01"`14531454    - `"agent-memory-2026-07-22"`14551456    - `"mid-conversation-tool-changes-2026-07-01"`14571458    - `"compact-2026-01-12"`14591460    - `"computer-use-2025-11-24"`14611462    - `"mcp-tunnels-2026-06-22"`14631464    - `"structured-outputs-2025-11-13"`14651466    - `"task-budgets-2026-03-13"`14671468    - `"thinking-display-updates-2026-08-18"`14691470    - `"ce-user-management-2026-07-13"`14711472    - `"mid-conversation-output-config-2026-07-01"`14731474    - `"thinking-binding-controls-2026-08-01"`14751476    - `"mid-conversation-system-clear-at-2026-08-21"`14771478    - `"compact-2026-09-04"`14791480- `"anthropic-workspace-id": optional string`14811482### Returns14831484- `BetaDream object`14851486  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.14871488  - `type: "dream"`14891490  - `id: string`14911492  - `archived_at: string or null`14931494    A timestamp in RFC 3339 format14951496    format: date-time14971498  - `created_at: string`14991500    A timestamp in RFC 3339 format15011502    format: date-time15031504  - `ended_at: string or null`15051506    A timestamp in RFC 3339 format15071508    format: date-time15091510  - `error: BetaDreamError or null`15111512    Failure detail for a Dream whose `status` is `failed`.15131514    - `type: string`15151516    - `message: string`15171518  - `inputs: array of BetaDreamInput`15191520    - `BetaDreamMemoryStoreInput object`15211522      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.15231524      - `type: "memory_store"`15251526      - `memory_store_id: string`15271528        minLength: 115291530    - `BetaDreamSessionsInput object`15311532      Input session transcripts the dream reads.15331534      - `type: "sessions"`15351536      - `session_ids: array of string`15371538  - `instructions: string or null`15391540  - `model: BetaDreamModelConfig`15411542    Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.15431544    - `id: string`15451546      Model identifier, e.g. "claude-opus-5". 1-256 characters.15471548      minLength: 1, maxLength: 25615491550    - `speed: optional "standard" or "fast"`15511552      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.15531554      - `"standard"`15551556      - `"fast"`15571558  - `output_behavior: BetaOutputBehavior`15591560    - `BetaOutputBehaviorCreateNew object`15611562      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.15631564      - `type: "create_new"`15651566    - `BetaOutputBehaviorUpdateExisting object`15671568      The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.15691570      - `type: "update_existing"`15711572      - `memory_store_id: string`15731574        minLength: 115751576  - `outputs: array of BetaDreamOutput`15771578    - `type: "memory_store"`15791580    - `memory_store_id: string`15811582  - `session_id: string or null`15831584  - `status: BetaDreamStatus`15851586    Lifecycle status of a Dream.15871588    - `"pending"`15891590    - `"running"`15911592    - `"completed"`15931594    - `"failed"`15951596    - `"canceled"`15971598  - `usage: BetaDreamUsage`15991600    Cumulative token usage for the dream across every pipeline stage.16011602    - `cache_creation_input_tokens: number`16031604      Total tokens used to create prompt-cache entries (sum of all TTL tiers).16051606      format: int3216071608    - `cache_read_input_tokens: number`16091610      Total tokens read from prompt cache.16111612      format: int3216131614    - `input_tokens: number`16151616      Total uncached input tokens consumed across every pipeline stage.16171618      format: int3216191620    - `output_tokens: number`16211622      Total output tokens generated across every pipeline stage.16231624      format: int3216251626### Example16271628```bash1629curl https://api.anthropic.com/v1/dreams/$DREAM_ID/archive \1630    -X POST \1631    -H 'anthropic-version: 2023-06-01' \1632    -H 'anthropic-beta: dreaming-2026-04-21' \1633    -H "X-Api-Key: $ANTHROPIC_API_KEY"1634```16351636#### Response (200)16371638```json1639{1640  "id": "id",1641  "archived_at": "2019-12-27T18:11:19.117Z",1642  "created_at": "2019-12-27T18:11:19.117Z",1643  "ended_at": "2019-12-27T18:11:19.117Z",1644  "error": {1645    "message": "message",1646    "type": "type"1647  },1648  "inputs": [1649    {1650      "memory_store_id": "x",1651      "type": "memory_store"1652    }1653  ],1654  "instructions": "instructions",1655  "model": {1656    "id": "x",1657    "speed": "standard"1658  },1659  "output_behavior": {1660    "type": "create_new"1661  },1662  "outputs": [1663    {1664      "memory_store_id": "memory_store_id",1665      "type": "memory_store"1666    }1667  ],1668  "session_id": "session_id",1669  "status": "pending",1670  "type": "dream",1671  "usage": {1672    "cache_creation_input_tokens": 0,1673    "cache_read_input_tokens": 0,1674    "input_tokens": 0,1675    "output_tokens": 01676  }1677}1678```16791680## Domain types16811682### Beta Dream16831684- `BetaDream object`16851686  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.16871688  - `type: "dream"`16891690  - `id: string`16911692  - `archived_at: string or null`16931694    A timestamp in RFC 3339 format16951696    format: date-time16971698  - `created_at: string`16991700    A timestamp in RFC 3339 format17011702    format: date-time17031704  - `ended_at: string or null`17051706    A timestamp in RFC 3339 format17071708    format: date-time17091710  - `error: BetaDreamError or null`17111712    Failure detail for a Dream whose `status` is `failed`.17131714    - `type: string`17151716    - `message: string`17171718  - `inputs: array of BetaDreamInput`17191720    - `BetaDreamMemoryStoreInput object`17211722      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.17231724      - `type: "memory_store"`17251726      - `memory_store_id: string`17271728        minLength: 117291730    - `BetaDreamSessionsInput object`17311732      Input session transcripts the dream reads.17331734      - `type: "sessions"`17351736      - `session_ids: array of string`17371738  - `instructions: string or null`17391740  - `model: BetaDreamModelConfig`17411742    Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.17431744    - `id: string`17451746      Model identifier, e.g. "claude-opus-5". 1-256 characters.17471748      minLength: 1, maxLength: 25617491750    - `speed: optional "standard" or "fast"`17511752      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.17531754      - `"standard"`17551756      - `"fast"`17571758  - `output_behavior: BetaOutputBehavior`17591760    - `BetaOutputBehaviorCreateNew object`17611762      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.17631764      - `type: "create_new"`17651766    - `BetaOutputBehaviorUpdateExisting object`17671768      The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.17691770      - `type: "update_existing"`17711772      - `memory_store_id: string`17731774        minLength: 117751776  - `outputs: array of BetaDreamOutput`17771778    - `type: "memory_store"`17791780    - `memory_store_id: string`17811782  - `session_id: string or null`17831784  - `status: BetaDreamStatus`17851786    Lifecycle status of a Dream.17871788    - `"pending"`17891790    - `"running"`17911792    - `"completed"`17931794    - `"failed"`17951796    - `"canceled"`17971798  - `usage: BetaDreamUsage`17991800    Cumulative token usage for the dream across every pipeline stage.18011802    - `cache_creation_input_tokens: number`18031804      Total tokens used to create prompt-cache entries (sum of all TTL tiers).18051806      format: int3218071808    - `cache_read_input_tokens: number`18091810      Total tokens read from prompt cache.18111812      format: int3218131814    - `input_tokens: number`18151816      Total uncached input tokens consumed across every pipeline stage.18171818      format: int3218191820    - `output_tokens: number`18211822      Total output tokens generated across every pipeline stage.18231824      format: int3218251826### Beta Dream Error18271828- `BetaDreamError object`18291830  Failure detail for a Dream whose `status` is `failed`.18311832  - `type: string`18331834  - `message: string`18351836### Beta Dream Input18371838- `BetaDreamInput = BetaDreamMemoryStoreInput or BetaDreamSessionsInput`18391840  - `BetaDreamMemoryStoreInput object`18411842    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.18431844    - `type: "memory_store"`18451846    - `memory_store_id: string`18471848      minLength: 118491850  - `BetaDreamSessionsInput object`18511852    Input session transcripts the dream reads.18531854    - `type: "sessions"`18551856    - `session_ids: array of string`18571858### Beta Dream Memory Store Input18591860- `BetaDreamMemoryStoreInput object`18611862  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.18631864  - `type: "memory_store"`18651866  - `memory_store_id: string`18671868    minLength: 118691870### Beta Dream Memory Store Output18711872- `BetaDreamMemoryStoreOutput object`18731874  An output memory store the dream writes consolidated memories into.18751876  - `type: "memory_store"`18771878  - `memory_store_id: string`18791880### Beta Dream Model Config18811882- `BetaDreamModelConfig object`18831884  Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.18851886  - `id: string`18871888    Model identifier, e.g. "claude-opus-5". 1-256 characters.18891890    minLength: 1, maxLength: 25618911892  - `speed: optional "standard" or "fast"`18931894    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.18951896    - `"standard"`18971898    - `"fast"`18991900### Beta Dream Model Config Param19011902- `BetaDreamModelConfigParam object`19031904  Model identifier and configuration applied to every pipeline stage.19051906  - `id: string`19071908    Model identifier, e.g. "claude-opus-5". 1-256 characters.19091910    minLength: 1, maxLength: 25619111912  - `speed: optional "standard" or "fast" or null`19131914    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.19151916    - `"standard"`19171918    - `"fast"`19191920### Beta Dream Output19211922- `BetaDreamOutput object`19231924  An output memory store the dream writes consolidated memories into.19251926  - `type: "memory_store"`19271928  - `memory_store_id: string`19291930### Beta Dream Sessions Input19311932- `BetaDreamSessionsInput object`19331934  Input session transcripts the dream reads.19351936  - `type: "sessions"`19371938  - `session_ids: array of string`19391940### Beta Dream Status19411942- `BetaDreamStatus = "pending" or "running" or "completed" or 2 more`19431944  Lifecycle status of a Dream.19451946  - `"pending"`19471948  - `"running"`19491950  - `"completed"`19511952  - `"failed"`19531954  - `"canceled"`19551956### Beta Dream Usage19571958- `BetaDreamUsage object`19591960  Cumulative token usage for the dream across every pipeline stage.19611962  - `cache_creation_input_tokens: number`19631964    Total tokens used to create prompt-cache entries (sum of all TTL tiers).19651966    format: int3219671968  - `cache_read_input_tokens: number`19691970    Total tokens read from prompt cache.19711972    format: int3219731974  - `input_tokens: number`19751976    Total uncached input tokens consumed across every pipeline stage.19771978    format: int3219791980  - `output_tokens: number`19811982    Total output tokens generated across every pipeline stage.19831984    format: int3219851986### Beta Dreaming Error19871988- `BetaDreamingError = BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 7 more`19891990  - `BetaInvalidRequestError object`19911992    - `type: "invalid_request_error"`19931994      default: invalid_request_error19951996    - `message: string`19971998      default: Invalid request19992000  - `BetaAuthenticationError object`20012002    - `type: "authentication_error"`20032004      default: authentication_error20052006    - `message: string`20072008      default: Authentication error20092010  - `BetaBillingError object`20112012    - `type: "billing_error"`20132014      default: billing_error20152016    - `message: string`20172018      default: Billing error20192020  - `BetaPermissionError object`20212022    - `type: "permission_error"`20232024      default: permission_error20252026    - `message: string`20272028      default: Permission denied20292030  - `BetaNotFoundError object`20312032    - `type: "not_found_error"`20332034      default: not_found_error20352036    - `message: string`20372038      default: Not found20392040  - `BetaRateLimitError object`20412042    - `type: "rate_limit_error"`20432044      default: rate_limit_error20452046    - `message: string`20472048      default: Rate limited20492050  - `BetaGatewayTimeoutError object`20512052    - `type: "timeout_error"`20532054      default: timeout_error20552056    - `message: string`20572058      default: Request timeout20592060  - `BetaAPIError object`20612062    - `type: "api_error"`20632064      default: api_error20652066    - `message: string`20672068      default: Internal server error20692070  - `BetaOverloadedError object`20712072    - `type: "overloaded_error"`20732074      default: overloaded_error20752076    - `message: string`20772078      default: Overloaded20792080  - `BetaTargetStoreHeldError object`20812082    The `output_behavior.memory_store_id` target is still held by a prior `{type: "update_existing"}` dream — one that is `pending` or `running`, or was canceled with its final writes still landing. Rarely the named dream has just finished (`completed`/`failed`) and its execution is still closing; an immediate retry then almost always succeeds. The message names the holding dream when the server can identify it (rarely omitted); poll it to a terminal state or cancel it, then retry. Carried with `x-should-retry: false`.20832084    - `type: "conflict_error"`20852086    - `message: optional string`20872088      Human-readable description of the conflict, naming the dream that holds the target store when the server can identify it.20892090### Beta Output Behavior20912092- `BetaOutputBehavior = BetaOutputBehaviorCreateNew or BetaOutputBehaviorUpdateExisting`20932094  - `BetaOutputBehaviorCreateNew object`20952096    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.20972098    - `type: "create_new"`20992100  - `BetaOutputBehaviorUpdateExisting object`21012102    The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.21032104    - `type: "update_existing"`21052106    - `memory_store_id: string`21072108      minLength: 121092110### Beta Output Behavior Create New21112112- `BetaOutputBehaviorCreateNew object`21132114  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.21152116  - `type: "create_new"`21172118### Beta Output Behavior Update Existing21192120- `BetaOutputBehaviorUpdateExisting object`21212122  The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.21232124  - `type: "update_existing"`21252126  - `memory_store_id: string`21272128    minLength: 121292130### Beta Target Store Held Error21312132- `BetaTargetStoreHeldError object`21332134  The `output_behavior.memory_store_id` target is still held by a prior `{type: "update_existing"}` dream — one that is `pending` or `running`, or was canceled with its final writes still landing. Rarely the named dream has just finished (`completed`/`failed`) and its execution is still closing; an immediate retry then almost always succeeds. The message names the holding dream when the server can identify it (rarely omitted); poll it to a terminal state or cancel it, then retry. Carried with `x-should-retry: false`.21352136  - `type: "conflict_error"`21372138  - `message: optional string`21392140    Human-readable description of the conflict, naming the dream that holds the target store when the server can identify it.2141
Files main
Menu

Theme