SPB Git

Repository Public

list.md 7.3 KB 359 lines markdown

1---2title: List Dreams3url: https://platform.claude.com/docs/en/api/beta/dreams/list4---56# List Dreams78**GET** `/v1/dreams`910List Dreams1112## Query parameters1314- `"created_at[gt]": optional string`1516  Return dreams with `created_at` strictly after this timestamp (exclusive lower bound, RFC 3339). Unset applies no lower bound.1718  format: date-time1920- `"created_at[lt]": optional string`2122  Return dreams with `created_at` strictly before this timestamp (exclusive upper bound, RFC 3339). Unset applies no upper bound.2324  format: date-time2526- `include_archived: optional boolean`2728  Query parameter for include_archived2930- `limit: optional number`3132  Query parameter for limit3334  format: int323536- `page: optional string`3738  Query parameter for page3940- `statuses: optional array of BetaDreamStatus`4142  Filter by lifecycle status. Repeat the parameter to match any of multiple statuses. Empty applies no status filter.4344  - `"pending"`4546  - `"running"`4748  - `"completed"`4950  - `"failed"`5152  - `"canceled"`5354## Headers5556- `"anthropic-beta": optional array of AnthropicBeta`5758  Optional header to specify the beta version(s) you want to use.5960  - `string`6162  - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`6364    - `"message-batches-2024-09-24"`6566    - `"prompt-caching-2024-07-31"`6768    - `"computer-use-2024-10-22"`6970    - `"computer-use-2025-01-24"`7172    - `"pdfs-2024-09-25"`7374    - `"token-counting-2024-11-01"`7576    - `"token-efficient-tools-2025-02-19"`7778    - `"output-128k-2025-02-19"`7980    - `"files-api-2025-04-14"`8182    - `"mcp-client-2025-04-04"`8384    - `"mcp-client-2025-11-20"`8586    - `"dev-full-thinking-2025-05-14"`8788    - `"interleaved-thinking-2025-05-14"`8990    - `"code-execution-2025-05-22"`9192    - `"extended-cache-ttl-2025-04-11"`9394    - `"context-1m-2025-08-07"`9596    - `"context-management-2025-06-27"`9798    - `"model-context-window-exceeded-2025-08-26"`99100    - `"skills-2025-10-02"`101102    - `"fast-mode-2026-02-01"`103104    - `"output-300k-2026-03-24"`105106    - `"user-profiles-2026-03-24"`107108    - `"user-profiles-2026-08-18"`109110    - `"user-profiles-2026-09-04"`111112    - `"advisor-tool-2026-03-01"`113114    - `"managed-agents-2026-04-01"`115116    - `"cache-diagnosis-2026-04-07"`117118    - `"dreaming-2026-04-21"`119120    - `"thinking-token-count-2026-05-13"`121122    - `"server-side-fallback-2026-06-01"`123124    - `"server-side-fallback-2026-07-01"`125126    - `"fallback-credit-2026-06-01"`127128    - `"fallback-credit-2026-07-01"`129130    - `"agent-memory-2026-07-22"`131132    - `"mid-conversation-tool-changes-2026-07-01"`133134    - `"compact-2026-01-12"`135136    - `"computer-use-2025-11-24"`137138    - `"mcp-tunnels-2026-06-22"`139140    - `"structured-outputs-2025-11-13"`141142    - `"task-budgets-2026-03-13"`143144    - `"thinking-display-updates-2026-08-18"`145146    - `"ce-user-management-2026-07-13"`147148    - `"mid-conversation-output-config-2026-07-01"`149150    - `"thinking-binding-controls-2026-08-01"`151152    - `"mid-conversation-system-clear-at-2026-08-21"`153154    - `"compact-2026-09-04"`155156- `"anthropic-workspace-id": optional string`157158## Returns159160- `data: array of BetaDream`161162  - `type: "dream"`163164  - `id: string`165166  - `archived_at: string or null`167168    A timestamp in RFC 3339 format169170    format: date-time171172  - `created_at: string`173174    A timestamp in RFC 3339 format175176    format: date-time177178  - `ended_at: string or null`179180    A timestamp in RFC 3339 format181182    format: date-time183184  - `error: BetaDreamError or null`185186    Failure detail for a Dream whose `status` is `failed`.187188    - `type: string`189190    - `message: string`191192  - `inputs: array of BetaDreamInput`193194    - `BetaDreamMemoryStoreInput object`195196      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.197198      - `type: "memory_store"`199200      - `memory_store_id: string`201202        minLength: 1203204    - `BetaDreamSessionsInput object`205206      Input session transcripts the dream reads.207208      - `type: "sessions"`209210      - `session_ids: array of string`211212  - `instructions: string or null`213214  - `model: BetaDreamModelConfig`215216    Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.217218    - `id: string`219220      Model identifier, e.g. "claude-opus-5". 1-256 characters.221222      minLength: 1, maxLength: 256223224    - `speed: optional "standard" or "fast"`225226      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.227228      - `"standard"`229230      - `"fast"`231232  - `output_behavior: BetaOutputBehavior`233234    - `BetaOutputBehaviorCreateNew object`235236      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.237238      - `type: "create_new"`239240    - `BetaOutputBehaviorUpdateExisting object`241242      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.243244      - `type: "update_existing"`245246      - `memory_store_id: string`247248        minLength: 1249250  - `outputs: array of BetaDreamOutput`251252    - `type: "memory_store"`253254    - `memory_store_id: string`255256  - `session_id: string or null`257258  - `status: BetaDreamStatus`259260    Lifecycle status of a Dream.261262    - `"pending"`263264    - `"running"`265266    - `"completed"`267268    - `"failed"`269270    - `"canceled"`271272  - `usage: BetaDreamUsage`273274    Cumulative token usage for the dream across every pipeline stage.275276    - `cache_creation_input_tokens: number`277278      Total tokens used to create prompt-cache entries (sum of all TTL tiers).279280      format: int32281282    - `cache_read_input_tokens: number`283284      Total tokens read from prompt cache.285286      format: int32287288    - `input_tokens: number`289290      Total uncached input tokens consumed across every pipeline stage.291292      format: int32293294    - `output_tokens: number`295296      Total output tokens generated across every pipeline stage.297298      format: int32299300- `next_page: string or null`301302## Example303304```bash305curl https://api.anthropic.com/v1/dreams \306    -H 'anthropic-version: 2023-06-01' \307    -H 'anthropic-beta: dreaming-2026-04-21' \308    -H "X-Api-Key: $ANTHROPIC_API_KEY"309```310311### Response (200)312313```json314{315  "data": [316    {317      "id": "id",318      "archived_at": "2019-12-27T18:11:19.117Z",319      "created_at": "2019-12-27T18:11:19.117Z",320      "ended_at": "2019-12-27T18:11:19.117Z",321      "error": {322        "message": "message",323        "type": "type"324      },325      "inputs": [326        {327          "memory_store_id": "x",328          "type": "memory_store"329        }330      ],331      "instructions": "instructions",332      "model": {333        "id": "x",334        "speed": "standard"335      },336      "output_behavior": {337        "type": "create_new"338      },339      "outputs": [340        {341          "memory_store_id": "memory_store_id",342          "type": "memory_store"343        }344      ],345      "session_id": "session_id",346      "status": "pending",347      "type": "dream",348      "usage": {349        "cache_creation_input_tokens": 0,350        "cache_read_input_tokens": 0,351        "input_tokens": 0,352        "output_tokens": 0353      }354    }355  ],356  "next_page": "next_page"357}358```359
Files main
Menu

Theme