Iris is an intelligent AI assistant platform providing conversational AI capabilities with advanced memory, context management, and multi-provider model support.
Architecture#
text
apps/iris/
├── api/ # REST/WebSocket API service
│ ├── src/
│ │ ├── routes/ # API route handlers
│ │ ├── middleware/ # Request middleware
│ │ └── services/ # Business logic
│ └── ...
└── docs/ # Documentation
Services#
API Service (@iris/api)#
The main API service providing:
- Conversation Management: Create, read, update, delete conversations
- Message Handling: Send messages, receive AI responses
- Streaming: Server-Sent Events for real-time response streaming
- Health Checks: Kubernetes-compatible health endpoints
Getting Started#
Prerequisites#
- Node.js 20+
- pnpm 8+
- Docker (for local infrastructure)
Development#
bash
# Start local infrastructure
docker compose -f docker/docker-compose.dev.yml up -d
# Install dependencies
pnpm install
# Start the API in development mode
pnpm nx serve @iris/api
The API will be available at http://localhost:3100.
Building#
bash
# Build the API
pnpm nx build @iris/api
# Run production build
pnpm nx start @iris/api
Testing#
bash
# Run tests
pnpm nx test @iris/api
# Run with coverage
pnpm nx test @iris/api --coverage
API Endpoints#
Health#
GET /health- Basic health checkGET /health/live- Kubernetes liveness probeGET /health/ready- Kubernetes readiness probeGET /health/detailed- Detailed health with metrics
Conversations#
GET /api/v1/conversations- List conversationsPOST /api/v1/conversations- Create conversationGET /api/v1/conversations/:id- Get conversationDELETE /api/v1/conversations/:id- Delete conversationPOST /api/v1/conversations/:id/messages- Send messageGET /api/v1/conversations/:id/messages- Get messagesPOST /api/v1/conversations/:id/stream- Stream response (SSE)
Related Libraries#
@iris/core- Core functionality and utilities@iris/types- TypeScript type definitions@iris/config- Configuration management@iris/testing- Testing utilities@iris/contracts- API contracts and schemas
Environment Variables#
| Variable | Description | Default |
|---|---|---|
PORT |
API server port | 3100 |
NODE_ENV |
Environment | development |
CORS_ORIGINS |
Allowed CORS origins | http://localhost:3000 |
DATABASE_URL |
PostgreSQL connection | - |
REDIS_URL |
Redis connection | - |