Agency Documentation
This is the documentation for the Agency Project. The agency-workspace repository is an umbrella repository for the other repositories:
agency-django — Python package for the Agency Django Project.
agency-server — Compose, Django settings, Celery/ASGI, and example apps (
boe,bopv,chat).agency-ui — TypeScript frontend, built and published into agency-django static files.
Framework
- Start Guide
- Concepts
- Architecture
- Veronica — built-in secretary
- Agency Display
- Tutorials
- RAG
- Deployment
- Development
- Change log
Reference
- Models
- Agent runtime (module)
- Tasks
- Tools
- Miner
- Channels
- API
serializer()provider_serializer()model_serializer()agent_serializer()agent_view_set()mission_serializer()mission_view_set()execution_serializer()task_view_set()execution_view_set()SystemInfoVersionMePrefsMeMediaview_set()agent_test()mission_dispatch()interruption_view_set()tool_serializer()tool_view_set()photo_serializer()photo_view_set()tool_sync()provider_sync()workspace_serializer()document_serializer()workspace_view_set()document_view_set()document_reindex()document_extraction()workspace_search()workspace_ask()user_serializer()user_view_set()group_serializer()group_view_set()UserPrefsStaffapi_index()router
- Module Index
- Index
Stack
Django — HTTP, admin, product SPA at
/PostgreSQL — primary DB
Redis — broker / Channels
ChromaDB — embeddings (reference host)
Ollama — local LLM (reference host)
Voice — STT/TTS at
/api/voice/(optional GPU)Celery — background tasks
Nginx — reverse proxy +
/static/
Gateways: WSGI (agency_django) and ASGI (agency_asgi, /channel/).
Product SPA: / after /login/. Sphinx HTML: /static/documentation/
(./dev doc html). One-file HTML: ./dev doc
→ /static/documentation-single/. In-container: bash run document.
See also
Concepts — short glossary
Architecture — product vs host vs umbrella
Tutorials — first agent, mission, HITL
Change log — shipped work log (newest first)
Django Admin Doc — models / views / tags in admin
Package narrative — sibling
agency-django/README.mdWorkspace backlog —
agency-workspace/todo/README.md