Overview#
This directory contains comprehensive API documentation for all Lilith platform services.
Available Services#
- Health - 1 endpoints
- Chat - 1 endpoints
- Conversation - 1 endpoints
- Observability - 7 endpoints
- Lectures - 1 endpoints
- TTS - 1 endpoints
- Ingestion - 1 endpoints
- Notifications - 1 endpoints
Quick Start#
- Authentication: All endpoints require JWT authentication
- Base URL:
http://localhost:3001/api/v1 - Content-Type:
application/jsonfor POST/PUT requests - Rate Limits: 100 requests/minute burst, 1000/hour sustained
Common Patterns#
Error Responses#
All errors follow this format:
json
{
"error": {
"code": "ERROR_CODE",
"message": "Human readable error message",
"details": {}
}
}
Success Responses#
Most successful responses follow this format:
json
{
"success": true,
"data": {},
"meta": {
"timestamp": "2024-01-01T00:00:00Z",
"version": "1.0.0"
}
}
Testing#
Use the provided test scripts or API clients to test endpoints:
bash
# Run API tests
npm run test:api
# Generate API client
npm run generate:client
This documentation is automatically generated from the OpenAPI specification