BetaDream

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/anthropic/main/json-schema/anthropic-beta-dream-schema.json",
  "title": "BetaDream",
  "description": "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.",
  "x-generated": "2026-09-23",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/anthropic-dreams-api-openapi.yml#/components/schemas/BetaDream",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "id",
    "inputs",
    "outputs",
    "status",
    "created_at",
    "ended_at",
    "archived_at",
    "error",
    "model",
    "instructions",
    "session_id",
    "usage",
    "output_behavior"
  ],
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "dream"
      ]
    },
    "id": {
      "type": "string"
    },
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/BetaDreamInput"
      }
    },
    "outputs": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/BetaDreamOutput"
      }
    },
    "status": {
      "$ref": "#/$defs/BetaDreamStatus"
    },
    "created_at": {
      "$ref": "#/$defs/BetaTimestamp"
    },
    "ended_at": {
      "anyOf": [
        {
          "$ref": "#/$defs/BetaTimestamp"
        },
        {
          "type": "null"
        }
      ]
    },
    "archived_at": {
      "anyOf": [
        {
          "$ref": "#/$defs/BetaTimestamp"
        },
        {
          "type": "null"
        }
      ]
    },
    "error": {
      "anyOf": [
        {
          "$ref": "#/$defs/BetaDreamError"
        },
        {
          "type": "null"
        }
      ]
    },
    "model": {
      "$ref": "#/$defs/BetaDreamModelConfig"
    },
    "instructions": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "session_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "usage": {
      "$ref": "#/$defs/BetaDreamUsage"
    },
    "output_behavior": {
      "$ref": "#/$defs/BetaOutputBehavior"
    }
  },
  "$defs": {
    "BetaDreamError": {
      "description": "Failure detail for a Dream whose `status` is `failed`.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "message"
      ],
      "properties": {
        "type": {
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      }
    },
    "BetaDreamInput": {
      "type": "object",
      "oneOf": [
        {
          "$ref": "#/$defs/BetaDreamMemoryStoreInput"
        },
        {
          "$ref": "#/$defs/BetaDreamSessionsInput"
        }
      ]
    },
    "BetaDreamMemoryStoreInput": {
      "description": "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.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "memory_store_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "memory_store"
          ]
        },
        "memory_store_id": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "BetaDreamMemoryStoreOutput": {
      "description": "An output memory store the dream writes consolidated memories into.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "memory_store_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "memory_store"
          ]
        },
        "memory_store_id": {
          "type": "string"
        }
      }
    },
    "BetaDreamModelConfig": {
      "description": "Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "description": "Model identifier, e.g. \"claude-opus-5\". 1-256 characters.",
          "type": "string",
          "minLength": 1,
          "maxLength": 256
        },
        "speed": {
          "description": "Inference speed mode. Defaults to `standard`.",
          "allOf": [
            {
              "$ref": "#/$defs/BetaSpeed"
            }
          ],
          "x-anthropic-beta-required": [
            "managed-agents-2026-04-01",
            "fast-mode-2026-02-01"
          ]
        }
      }
    },
    "BetaDreamOutput": {
      "type": "object",
      "oneOf": [
        {
          "$ref": "#/$defs/BetaDreamMemoryStoreOutput"
        }
      ]
    },
    "BetaDreamSessionsInput": {
      "description": "Input session transcripts the dream reads.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "session_ids"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "sessions"
          ]
        },
        "session_ids": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "BetaDreamStatus": {
      "type": "string",
      "description": "Lifecycle status of a Dream.",
      "enum": [
        "pending",
        "running",
        "completed",
        "failed",
        "canceled"
      ]
    },
    "BetaDreamUsage": {
      "description": "Cumulative token usage for the dream across every pipeline stage.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "input_tokens",
        "output_tokens",
        "cache_read_input_tokens",
        "cache_creation_input_tokens"
      ],
      "properties": {
        "input_tokens": {
          "description": "Total uncached input tokens consumed across every pipeline stage.",
          "type": "integer",
          "format": "int32"
        },
        "output_tokens": {
          "description": "Total output tokens generated across every pipeline stage.",
          "type": "integer",
          "format": "int32"
        },
        "cache_read_input_tokens": {
          "description": "Total tokens read from prompt cache.",
          "type": "integer",
          "format": "int32"
        },
        "cache_creation_input_tokens": {
          "description": "Total tokens used to create prompt-cache entries (sum of all TTL tiers).",
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "BetaOutputBehavior": {
      "type": "object",
      "oneOf": [
        {
          "$ref": "#/$defs/BetaOutputBehaviorCreateNew"
        },
        {
          "$ref": "#/$defs/BetaOutputBehaviorUpdateExisting"
        }
      ]
    },
    "BetaOutputBehaviorCreateNew": {
      "description": "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.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "create_new"
          ]
        }
      }
    },
    "BetaOutputBehaviorUpdateExisting": {
      "description": "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.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "memory_store_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "update_existing"
          ]
        },
        "memory_store_id": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "BetaSpeed": {
      "type": "string",
      "description": "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.",
      "enum": [
        "standard",
        "fast"
      ]
    },
    "BetaTimestamp": {
      "description": "A timestamp in RFC 3339 format",
      "type": "string",
      "format": "date-time"
    }
  }
}