Core Concepts
| Concept | Description |
|---|---|
| Dream | An asynchronous memory consolidation job |
| Input Memory Store | The data source — never modified |
| Output Memory Store | An automatically cloned copy where consolidation results are written |
| Dreaming Session | An internal Session created during Dream execution; hidden from normal Session lists |
Workflow
API Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /dreams | Create a Dream |
| GET | /dreams | List Dreams |
| GET | /dreams/{id} | Get a Dream |
| POST | /dreams/{id}/cancel | Cancel a running Dream |
| POST | /dreams/{id}/archive | Archive a completed Dream |
Quick Start
1. Trigger memory consolidation
2. Check progress
3. View results
Once completed, theoutputs field contains the consolidated Memory Store ID:
Optional Parameters
| Parameter | Description |
|---|---|
model | Model selection: auto (default), lite, ultimate |
instructions | Custom instructions (e.g. “Focus on Python project conventions”), max 4096 characters |
inputs[].type: "sessions" | Specify Session IDs to prioritize (up to 100) |
Safety Design
- Copy-on-Write: The input Memory Store is never modified; all writes target the cloned output
- Least Privilege: The Dreaming Agent can only use
memory,session_list, andsession_readtools — no code execution or network access - Single-flight: Only one active Dream per user (pending or running); duplicate creation returns 409