API Reference¶
AXIS exposes a REST API via FastAPI and provides Python and TypeScript libraries for extending the platform.
REST API¶
FastAPI automatically generates interactive API documentation:
- Swagger UI: http://localhost:8500/docs
- ReDoc: http://localhost:8500/redoc
See the REST API overview for endpoint summaries and tag descriptions.
Backend (Python)¶
Auto-generated reference from Python docstrings:
| Module | Description |
|---|---|
| Config | Application settings and constants |
| Data Processor | CSV parsing, format detection, data transformation |
| Database Service | PostgreSQL connection management and queries |
| Eval Runner Service | Batch evaluation execution |
| Human Signals Service | Human signals processing |
| Memory Service | Decision memory and rule extraction |
| Graph Service | FalkorDB knowledge graph operations |
| Schemas | Pydantic data models |
Frontend (TypeScript)¶
Hand-written reference for key frontend modules:
| Module | Description |
|---|---|
| API Client | fetchApi client and endpoint functions |
| Hooks | React Query hooks for data fetching |
| Stores | Zustand state management stores |
| Types | TypeScript type definitions |