reverie-api
The Reverie ingestion backend. FastAPI on top of SQLite, with append-only event storage and a WebSocket fan-out for live subscribers.
Endpoints (Phase 0)
| Method | Path | Purpose |
|---|---|---|
GET |
/health |
Liveness check |
POST |
/api/v1/runs |
Create a run |
GET |
/api/v1/runs |
List runs (paginated) |
GET |
/api/v1/runs/{run_id} |
Get one run |
PATCH |
/api/v1/runs/{run_id} |
Update status / completedAt / goal |
DELETE |
/api/v1/runs/{run_id} |
Delete run + cascade events (refused if pinned) |
PATCH |
/api/v1/runs/{run_id}/pin |
Pin / unpin a run |
GET |
/api/v1/runs/{run_id}/events |
Get all events for a run, in timestamp order |
POST |
/api/v1/events |
Ingest one event |
POST |
/api/v1/events/batch |
Ingest up to 1000 events atomically |
WS |
/stream?runId=<id> |
Live event stream for one run |
Configuration
Environment variables (all optional, prefix REVERIE_):
| Var | Default | Description |
|---|---|---|
REVERIE_DB_PATH |
data/reverie.db |
SQLite file path |
REVERIE_HOST |
127.0.0.1 |
Bind host |
REVERIE_PORT |
8000 |
Bind port |
REVERIE_CORS_ORIGINS |
http://localhost:3000 |
Comma-separated allowed origins |
REVERIE_ENV |
development |
Environment label |
Run
uv pip install --python ../../.venv/Scripts/python.exe -e ".[dev]"
python -m reverie_api
Then visit http://localhost:8000/docs for the OpenAPI UI.
Test
pytest
1 maintainer
Release files for reverie-api 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| reverie_api-0.1.0.tar.gz | 661.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| reverie_api-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.4 MB
Release files / reverie_api-0.1.0.tar.gz
| Download URL | reverie_api-0.1.0.tar.gz |
|---|---|
| Size | 661.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f6fd9ef1b78b5d66b7e4f2cd8017b10d304f83a1748f1924df4a0096df889dd5
|
|
BLAKE2b-256 checksum How to use checksums |
154812f5987d7f9b739310accda160764714a34aaa668fd69e2cf9be2b496cd2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / reverie_api-0.1.0-py3-none-any.whl
| Download URL | reverie_api-0.1.0-py3-none-any.whl |
|---|---|
| Size | 697.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4de583d6b2bec9aa22502886c8f23e25b055ee76a418aea9f6986db2ad38576b
|
|
BLAKE2b-256 checksum How to use checksums |
ddf18ccf1853533a4218b2fb9f2087c4f5c7d72f30182c6d8d9483fccbc586da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
