▸ Relocation Scout Documentation Project Docs Architecture & Security Decisions (ADRs) ADR Decision 001 SQLite-first persistence 002 Explicit workflow controller 003 Human approval gateway 004 Agent framework isolation
Operational API Endpoints Searches Method Endpoint Description POST/api/searchesCreate a new search GET/api/searchesList all searches GET/api/searches/{id}Get search details POST/api/searches/{id}/startStart workflow execution POST/api/searches/{id}/resumeResume failed workflow
Listings & Workflow Method Endpoint Description GET/api/searches/{id}/listingsGet listings (with filters) GET/api/searches/{id}/shortlistGet ranked shortlist GET/api/searches/{id}/workflowWorkflow status GET/api/searches/{id}/workflow/stepsStep execution details
Actions Method Endpoint Description GET/api/actions/{id}Action detail PUT/api/actions/{id}/editEdit action payload POST/api/actions/{id}/approveApprove action POST/api/actions/{id}/executeExecute approved action
Audit & Health Method Endpoint Description GET/api/auditQuery audit log GET/api/searches/{id}/audit/exportExport full audit trail (JSON) GET/api/healthHealth check + runtime info
Makefile Commands make install # Install all dependencies
make dev # Start backend + frontend
make test # Run all backend tests
make lint # Ruff check + format check
make seed # Seed demo data
make reset # Reset database
make demo # Reset + seed + start
make verify # Full verification
make clean # Remove venv, node_modules, DBEnvironment Variable Default Description DATABASE_URLsqlite+aiosqlite:///./data/relocation_scout.dbSQLite for local dev AGENT_RUNTIMEmockmock or adk (Gemini)MAX_CONCURRENT_ENRICHMENTS4Parallel step concurrency LOG_LEVELINFODEBUG for verbose
View full source on GitHub →