aurask/api/README.md

51 lines
1.4 KiB
Markdown

# Aurask API
This directory contains the Python backend package and bridge configuration for:
- PostgreSQL
- PGVector
- Redis
- AnythingLLM
- Langflow
- Frontend-to-backend request contracts
## Runtime modes
Default local mode uses `JsonStore` and simulated bridges:
```bash
uv run aurask demo --reset
uv run aurask serve --reset --host 127.0.0.1 --port 8080
```
Production bridge mode can be enabled with:
```bash
$env:AURASK_USE_EXTERNAL_BRIDGES="true"
$env:AURASK_DATABASE_URL="postgresql://aurask:secret@postgres:5432/aurask"
$env:AURASK_REDIS_URL="redis://redis:6379/0"
$env:AURASK_ANYTHINGLLM_BASE_URL="http://anythingllm.aurask-runtime.svc.cluster.local:3001"
$env:AURASK_ANYTHINGLLM_API_KEY="<secret>"
$env:AURASK_LANGFLOW_BASE_URL="http://langflow-runtime.aurask-runtime.svc.cluster.local:7860"
$env:AURASK_LANGFLOW_API_KEY="<secret>"
uv run aurask serve --host 0.0.0.0 --port 8080
```
## Bridge modules
- `aurask.bridges.config`: environment-driven configuration
- `aurask.bridges.postgres`: PostgreSQL schema contract
- `aurask.bridges.pgvector`: PGVector tenant-filtered collection contract
- `aurask.bridges.redis_bridge`: Redis queue/cache/idempotency key contract
- `aurask.bridges.anythingllm`: AnythingLLM API bridge
- `aurask.bridges.langflow`: Langflow runtime bridge
## Admin bridge status
Authenticated admin status endpoint:
```http
GET /admin/bridge-status
Authorization: Bearer <api_key>
```