Overview#
The Domain Agents API provides specialized AI agents for meditation, knowledge management, and learning tasks. The system includes 7 default agents (Librarian, Curator, Scholar, Socratic Coach, Persona Engine, Safety Moderator, Narrator) with distinct capabilities, tool access, and personality configurations. Each agent can execute tasks, use tools, and collaborate with other agents in multi-agent workflows.
Base URL#
http://localhost:3007/v1/ai
Authentication#
All endpoints require authentication via Bearer token in the Authorization header.
Endpoints#
List All Agents#
GET /agents
Retrieve all registered domain agents in the system.
Response: 200 OK
Example:
curl -X GET "http://localhost:3007/v1/ai/agents" \
-H "Authorization: Bearer YOUR_TOKEN"
{
"agents": [
{
"id": "agent_1730000000000_abc123",
"role": "librarian",
"name": "Knowledge Librarian",
"description": "Discovers, organizes, and retrieves knowledge from vast collections",
"capabilities": ["knowledge_search", "cataloging", "metadata_extraction"],
"toolAccess": [
{
"toolName": "search",
"permissions": ["search.execute"],
"rateLimit": { "calls": 100, "period": "minute" }
},
{
"toolName": "kg_query",
"permissions": ["kg.read"],
"rateLimit": { "calls": 50, "period": "minute" }
}
],
"personality": {
"tone": "helpful",
"style": "precise",
"expertise": ["cataloging", "information_retrieval", "taxonomy"]
},
"status": "idle",
"metrics": {
"tasksCompleted": 0,
"toolsUsed": 0,
"successRate": 0,
"averageResponseTime": 0
},
"createdAt": "2025-10-03T10:00:00.000Z"
}
],
"count": 7
}
Get Agent by ID#
GET /agents/:agentId
Retrieve a specific agent by ID.
Path Parameters:
agentId(required): Agent ID
Response: 200 OK or 404 Not Found
Example:
curl -X GET "http://localhost:3007/v1/ai/agents/agent_123" \
-H "Authorization: Bearer YOUR_TOKEN"
{
"agent": {
"id": "agent_123",
"role": "scholar",
"name": "Academic Scholar",
"description": "Conducts deep research and provides scholarly analysis",
"capabilities": ["research", "analysis", "citation", "synthesis"],
"toolAccess": [
{
"toolName": "search",
"permissions": ["search.execute"],
"rateLimit": { "calls": 200, "period": "hour" }
},
{
"toolName": "kg_query",
"permissions": ["kg.read", "kg.traverse"],
"rateLimit": { "calls": 100, "period": "hour" }
},
{
"toolName": "calc",
"permissions": ["calc.execute"]
}
],
"personality": {
"tone": "academic",
"style": "analytical",
"expertise": ["research", "analysis", "synthesis", "critical_thinking"]
},
"status": "idle",
"metrics": {
"tasksCompleted": 42,
"toolsUsed": 156,
"successRate": 0.98,
"averageResponseTime": 1250
},
"createdAt": "2025-10-01T08:00:00.000Z"
}
}
Error Response: 404 Not Found
{
"error": "Agent not found",
"code": "agents.not_found"
}
Get Agents by Role#
GET /agents/role/:role
Retrieve all agents with a specific role.
Path Parameters:
role(required): Agent role (librarian, curator, scholar, socratic_coach, persona_engine, safety_moderator, narrator)
Response: 200 OK
Example: Get all librarians
curl -X GET "http://localhost:3007/v1/ai/agents/role/librarian" \
-H "Authorization: Bearer YOUR_TOKEN"
{
"role": "librarian",
"agents": [
{
"id": "agent_abc",
"role": "librarian",
"name": "Knowledge Librarian",
"capabilities": ["knowledge_search", "cataloging", "metadata_extraction"],
...
}
],
"count": 1
}
Get Agents by Capability#
GET /agents/capability/:capability
Find all agents with a specific capability.
Path Parameters:
capability(required): Capability name (e.g., research, narration, knowledge_search)
Response: 200 OK
Example: Find research-capable agents
curl -X GET "http://localhost:3007/v1/ai/agents/capability/research" \
-H "Authorization: Bearer YOUR_TOKEN"
{
"capability": "research",
"agents": [
{
"id": "agent_scholar_123",
"role": "scholar",
"name": "Academic Scholar",
"capabilities": ["research", "analysis", "citation", "synthesis"],
...
}
],
"count": 1
}
Get Agents by Tool Access#
GET /agents/tool/:toolName
Find all agents with access to a specific tool.
Path Parameters:
toolName(required): Tool name (search, kg_query, calc, tts, stt, scheduler)
Response: 200 OK
Example: Find agents with search tool
curl -X GET "http://localhost:3007/v1/ai/agents/tool/search" \
-H "Authorization: Bearer YOUR_TOKEN"
{
"toolName": "search",
"agents": [
{
"id": "agent_librarian_123",
"role": "librarian",
"name": "Knowledge Librarian",
"toolAccess": [
{
"toolName": "search",
"permissions": ["search.execute"],
"rateLimit": { "calls": 100, "period": "minute" }
}
],
...
},
{
"id": "agent_scholar_456",
"role": "scholar",
"name": "Academic Scholar",
"toolAccess": [
{
"toolName": "search",
"permissions": ["search.execute"],
"rateLimit": { "calls": 200, "period": "hour" }
}
],
...
}
],
"count": 5
}
Create Agent Task#
POST /agents/:agentId/tasks
Create a new task for a specific agent.
Path Parameters:
agentId(required): Agent ID
Request Body:
{
type: string; // Required: Task type
input: Record<string, unknown>; // Required: Task input data
}
Response: 201 Created
Example: Create search task
curl -X POST http://localhost:3007/v1/ai/agents/agent_librarian_123/tasks \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "knowledge_search",
"input": {
"query": "mindfulness meditation techniques",
"limit": 10,
"filters": {
"tradition": "buddhist",
"language": "en"
}
}
}'
{
"success": true,
"task": {
"id": "task_1730000123456_xyz",
"agentId": "agent_librarian_123",
"type": "knowledge_search",
"input": {
"query": "mindfulness meditation techniques",
"limit": 10,
"filters": {
"tradition": "buddhist",
"language": "en"
}
},
"status": "pending",
"toolsUsed": [],
"createdAt": "2025-10-03T14:30:00.000Z"
}
}
Error Response: 400 Bad Request
{
"error": "Missing required field: type",
"code": "validation.missing_field"
}
Error Response: 404 Not Found
{
"error": "Agent not found",
"code": "agents.not_found"
}
Execute Agent Task#
POST /tasks/:taskId/execute
Execute a pending task.
Path Parameters:
taskId(required): Task ID
Response: 200 OK
Example:
curl -X POST http://localhost:3007/v1/ai/tasks/task_123/execute \
-H "Authorization: Bearer YOUR_TOKEN"
{
"success": true,
"task": {
"id": "task_123",
"agentId": "agent_librarian_456",
"type": "knowledge_search",
"input": {
"query": "mindfulness meditation"
},
"status": "completed",
"result": {
"success": true,
"output": "Agent Knowledge Librarian completed task: knowledge_search",
"data": {
"results": [...],
"count": 10
}
},
"toolsUsed": ["search", "kg_query"],
"startedAt": "2025-10-03T14:30:00.000Z",
"completedAt": "2025-10-03T14:30:01.250Z",
"duration": 1250
}
}
Error Response: 404 Not Found
{
"error": "Task not found",
"code": "tasks.not_found"
}
Get Agent Tool History#
GET /agents/:agentId/tool-history
Retrieve tool execution history for an agent.
Path Parameters:
agentId(required): Agent ID
Response: 200 OK
Example:
curl -X GET "http://localhost:3007/v1/ai/agents/agent_scholar_123/tool-history" \
-H "Authorization: Bearer YOUR_TOKEN"
{
"agentId": "agent_scholar_123",
"executions": [
{
"agentId": "agent_scholar_123",
"toolName": "search",
"input": {
"query": "Zen meditation",
"limit": 20
},
"output": {
"results": [...],
"count": 18
},
"success": true,
"duration": 245,
"timestamp": "2025-10-03T14:25:00.000Z"
},
{
"agentId": "agent_scholar_123",
"toolName": "kg_query",
"input": {
"query": "MATCH (n:Tradition {name: 'Zen'}) RETURN n",
"queryType": "cypher"
},
"output": {
"bindings": [...],
"count": 5
},
"success": true,
"duration": 180,
"timestamp": "2025-10-03T14:26:00.000Z"
}
],
"count": 2
}
Default Agents#
1. Librarian (knowledge_search, cataloging)#
{
role: "librarian",
capabilities: [
"knowledge_search",
"cataloging",
"metadata_extraction"
],
toolAccess: [
{
toolName: "search",
permissions: ["search.execute"],
rateLimit: { calls: 100, period: "minute" }
},
{
toolName: "kg_query",
permissions: ["kg.read"],
rateLimit: { calls: 50, period: "minute" }
}
],
personality: {
tone: "helpful",
style: "precise",
expertise: ["cataloging", "information_retrieval", "taxonomy"]
}
}
2. Curator (content_evaluation, quality_assessment)#
{
role: "curator",
capabilities: [
"content_evaluation",
"quality_assessment",
"relevance_scoring"
],
toolAccess: [
{ toolName: "search", permissions: ["search.execute"] },
{ toolName: "kg_query", permissions: ["kg.read"] }
],
personality: {
tone: "discerning",
style: "evaluative",
expertise: ["quality_assessment", "content_selection", "relevance"]
}
}
3. Scholar (research, analysis, synthesis)#
{
role: "scholar",
capabilities: [
"research",
"analysis",
"citation",
"synthesis"
],
toolAccess: [
{
toolName: "search",
permissions: ["search.execute"],
rateLimit: { calls: 200, period: "hour" }
},
{
toolName: "kg_query",
permissions: ["kg.read", "kg.traverse"],
rateLimit: { calls: 100, period: "hour" }
},
{ toolName: "calc", permissions: ["calc.execute"] }
],
personality: {
tone: "academic",
style: "analytical",
expertise: ["research", "analysis", "synthesis", "critical_thinking"]
}
}
4. Socratic Coach (guided_inquiry, learning_facilitation)#
{
role: "socratic_coach",
capabilities: [
"questioning",
"guided_inquiry",
"learning_facilitation"
],
toolAccess: [
{ toolName: "search", permissions: ["search.execute"] },
{
toolName: "scheduler",
permissions: ["scheduler.create", "scheduler.read"]
}
],
personality: {
tone: "questioning",
style: "socratic",
expertise: ["pedagogy", "inquiry", "facilitation"]
}
}
5. Persona Engine (persona_selection, style_adaptation)#
{
role: "persona_engine",
capabilities: [
"persona_selection",
"style_adaptation",
"tone_matching"
],
toolAccess: [
{ toolName: "search", permissions: ["search.execute"] }
],
personality: {
tone: "adaptive",
style: "contextual",
expertise: ["persona_modeling", "style_adaptation", "context_awareness"]
}
}
6. Safety Moderator (safety_checking, moderation)#
{
role: "safety_moderator",
capabilities: [
"safety_checking",
"moderation",
"cultural_sensitivity"
],
toolAccess: [], // No tool access - focuses on content analysis
personality: {
tone: "protective",
style: "careful",
expertise: ["safety", "moderation", "cultural_awareness"]
}
}
7. Narrator (narration, voice_synthesis, audio_guidance)#
{
role: "narrator",
capabilities: [
"narration",
"voice_synthesis",
"audio_guidance"
],
toolAccess: [
{
toolName: "tts",
permissions: ["tts.generate"],
rateLimit: { calls: 100, period: "hour" }
},
{
toolName: "stt",
permissions: ["stt.transcribe"],
rateLimit: { calls: 50, period: "hour" }
}
],
personality: {
tone: "calming",
style: "narrative",
expertise: ["narration", "voice", "guidance"]
}
}
Data Models#
DomainAgent#
interface DomainAgent {
id: string; // Unique agent ID
role: AgentRole; // Agent role
name: string; // Human-readable name
description: string; // Agent description
capabilities: string[]; // Agent capabilities
toolAccess: AgentToolAccess[]; // Tools the agent can use
personality: {
tone: string; // Communication tone
style: string; // Interaction style
expertise: string[]; // Areas of expertise
};
status: 'idle' | 'busy' | 'error'; // Current status
metrics: {
tasksCompleted: number; // Total tasks completed
toolsUsed: number; // Total tools used
successRate: number; // Task success rate (0-1)
averageResponseTime: number; // Avg response time in ms
};
createdAt: Date; // Creation timestamp
}
AgentTask#
interface AgentTask {
id: string; // Unique task ID
agentId: string; // Agent ID
type: string; // Task type
input: Record<string, unknown>; // Task input
status: 'pending' | 'running' | 'completed' | 'failed';
result?: unknown; // Task result
error?: string; // Error message if failed
toolsUsed: string[]; // Tools used during execution
startedAt?: Date; // Execution start time
completedAt?: Date; // Execution completion time
duration?: number; // Execution duration in ms
}
AgentToolExecution#
interface AgentToolExecution {
agentId: string; // Agent ID
toolName: ToolCapability; // Tool name
input: Record<string, unknown>; // Tool input
output?: unknown; // Tool output
success: boolean; // Execution success
duration: number; // Duration in ms
timestamp: Date; // Execution timestamp
}
AgentToolAccess#
interface AgentToolAccess {
toolName: ToolCapability; // Tool name
permissions: string[]; // Required permissions
rateLimit?: {
calls: number; // Max calls
period: 'minute' | 'hour' | 'day'; // Time period
};
}
Multi-Agent Workflows#
Workflow 1: Complete Meditation Content Creation#
# 1. Librarian searches for meditation content
curl -X POST http://localhost:3007/v1/ai/agents/librarian_123/tasks \
-d '{"type": "search_content", "input": {"query": "mindfulness meditation"}}'
# Response: { "task": { "id": "task_1" } }
# 2. Scholar analyzes and structures content
curl -X POST http://localhost:3007/v1/ai/agents/scholar_456/tasks \
-d '{"type": "analyze_structure", "input": {"source": "task_1"}}'
# Response: { "task": { "id": "task_2" } }
# 3. Safety Moderator reviews for appropriateness
curl -X POST http://localhost:3007/v1/ai/agents/moderator_789/tasks \
-d '{"type": "safety_check", "input": {"content": "task_2"}}'
# Response: { "task": { "id": "task_3" } }
# 4. Narrator creates audio narration
curl -X POST http://localhost:3007/v1/ai/agents/narrator_012/tasks \
-d '{"type": "create_narration", "input": {"script": "task_2", "approved": "task_3"}}'
# Response: { "task": { "id": "task_4" } }
# Execute all tasks
curl -X POST http://localhost:3007/v1/ai/tasks/task_1/execute
curl -X POST http://localhost:3007/v1/ai/tasks/task_2/execute
curl -X POST http://localhost:3007/v1/ai/tasks/task_3/execute
curl -X POST http://localhost:3007/v1/ai/tasks/task_4/execute
Workflow 2: Adaptive Learning Journey#
# 1. Socratic Coach creates learning plan
curl -X POST http://localhost:3007/v1/ai/agents/coach_123/tasks \
-d '{"type": "create_learning_plan", "input": {"topic": "Buddhist philosophy", "level": "beginner"}}'
# 2. Librarian provides resources
curl -X POST http://localhost:3007/v1/ai/agents/librarian_456/tasks \
-d '{"type": "find_resources", "input": {"plan": "task_1"}}'
# 3. Coach schedules learning sessions
curl -X POST http://localhost:3007/v1/ai/agents/coach_123/tasks \
-d '{"type": "schedule_sessions", "input": {"resources": "task_2", "frequency": "weekly"}}'
Workflow 3: Research Collaboration#
# 1. Scholar conducts deep research
curl -X POST http://localhost:3007/v1/ai/agents/scholar_123/tasks \
-d '{"type": "deep_research", "input": {"topic": "Zen meditation lineages"}}'
# 2. Curator evaluates quality
curl -X POST http://localhost:3007/v1/ai/agents/curator_456/tasks \
-d '{"type": "evaluate_research", "input": {"research": "task_1", "criteria": ["accuracy", "comprehensiveness"]}}'
# 3. Scholar refines based on feedback
curl -X POST http://localhost:3007/v1/ai/agents/scholar_123/tasks \
-d '{"type": "refine_research", "input": {"original": "task_1", "feedback": "task_2"}}'
Agent Discovery Patterns#
Find the Right Agent for a Task#
// Pattern 1: Find by capability
const searchAgents = await fetch('/v1/ai/agents/capability/knowledge_search');
const bestAgent = searchAgents.agents[0]; // Librarian
// Pattern 2: Find by tool access
const ttsAgents = await fetch('/v1/ai/agents/tool/tts');
const narrator = ttsAgents.agents.find((a) => a.role === 'narrator');
// Pattern 3: Find by role
const scholars = await fetch('/v1/ai/agents/role/scholar');
const researchAgent = scholars.agents[0];
// Pattern 4: Find by multiple criteria
const allAgents = await fetch('/v1/ai/agents');
const researchWithCalc = allAgents.agents.filter(
(a) =>
a.capabilities.includes('research') &&
a.toolAccess.some((t) => t.toolName === 'calc')
);
Error Handling#
Common Error Codes#
Agent Not Found
{
"error": "Agent not found",
"code": "agents.not_found",
"statusCode": 404
}
Task Not Found
{
"error": "Task not found",
"code": "tasks.not_found",
"statusCode": 404
}
Missing Required Field
{
"error": "Missing required field: type",
"code": "validation.missing_field",
"statusCode": 400
}
Agent Busy
{
"error": "Agent is currently busy",
"code": "agents.busy",
"statusCode": 409
}
Test Coverage#
The Domain Agents feature has comprehensive test coverage:
- Unit Tests: 44 tests (100% code coverage)
- Integration Tests: 20 tests (all HTTP endpoints)
- Multi-Agent Workflow Tests: 100 tests (autonomous agent scenarios)
- E2E Tests: 15 Playwright tests
- Total: 179 tests passing
Multi-Agent Test Scenarios (100 tests)#
- Agent Discovery & Registration (10 tests): Finding agents, registration, capability queries
- Task Creation & Management (10 tests): Creating, executing, tracking tasks
- Tool Access & Permissions (10 tests): Tool usage, permissions, execution history
- Multi-Agent Coordination (10 tests): Agent collaboration, delegation, workflows
- Agent Metrics & Monitoring (10 tests): Performance tracking, success rates
- Agent Capabilities & Specialization (10 tests): Capability-specific behaviors
- Error Handling & Resilience (10 tests): Graceful degradation, error recovery
- Performance & Scalability (10 tests): High-volume operations, concurrent execution
- Agent Lifecycle & State Management (10 tests): Status transitions, state preservation
- Integration & Real-World Scenarios (10 tests): Complete workflows, production scenarios
Implementation#
- Language: TypeScript with strict type safety
- File:
apps/lilith/svc-ai/src/domain-agents.ts - Lines of Code: 484
- Dependencies: None (in-memory storage)
- Default Agents: 7 specialized agents
Performance Characteristics#
- Agent Registration: O(1) insertion
- Agent Query by ID: O(1) lookup
- Agent Query by Role: O(n) filtering with indexing
- Agent Query by Capability: O(n) filtering
- Task Creation: O(1) insertion
- Task Execution: O(1) + task duration
- Tool History Query: O(n) filtering
Recommendations:
- Suitable for 100s of agents and 1000s of tasks
- Add pagination for large result sets
- Consider database persistence for production
Limitations#
- In-Memory Storage: Data lost on service restart (not persisted)
- No Pagination: All results returned in single response
- No Real-Time Updates: No WebSocket notifications for task updates
- No Task Cancellation: Once started, tasks cannot be cancelled
- No Agent Load Balancing: Manual task distribution required
Future Enhancements#
High Priority:
- Database persistence (PostgreSQL with agent/task tables)
- Real-time task notifications via WebSocket
- Task cancellation and timeout support
- Automatic agent load balancing
Medium Priority: 5. Agent performance analytics dashboard 6. ML-based agent recommendation for tasks 7. Cross-agent knowledge sharing 8. Agent learning from task outcomes
Low Priority: 9. Dynamic agent creation via API 10. Agent personality customization 11. Multi-tenant agent isolation 12. Agent federation across services
Best Practices#
Agent Selection#
// ✅ Good: Select agent by specific capability
const agents = await fetch('/v1/ai/agents/capability/research');
const scholar = agents.agents.find((a) => a.role === 'scholar');
// ❌ Bad: Assume agent ID or position
const agent = allAgents[0]; // Don't assume array order
Task Management#
// ✅ Good: Create task, then execute separately
const taskResponse = await createTask(agentId, 'research', input);
const result = await executeTask(taskResponse.task.id);
// ❌ Bad: Assume immediate execution
const result = await createTask(agentId, 'research', input);
// Task is created but not executed
Multi-Agent Workflows#
// ✅ Good: Sequential execution with dependency tracking
const task1 = await createAndExecute(librarian, 'search', {});
const task2 = await createAndExecute(scholar, 'analyze', { source: task1.id });
const task3 = await createAndExecute(narrator, 'narrate', { script: task2.id });
// ❌ Bad: Parallel execution without dependencies
Promise.all([
createAndExecute(librarian, 'search', {}),
createAndExecute(scholar, 'analyze', {}), // Missing source!
createAndExecute(narrator, 'narrate', {}), // Missing script!
]);
Tool Access Verification#
// ✅ Good: Verify agent has tool access before creating task
const agent = await getAgent(agentId);
const hasSearchTool = agent.toolAccess.some((t) => t.toolName === 'search');
if (hasSearchTool) {
await createTask(agentId, 'search_task', {});
}
// ❌ Bad: Assume agent has tool access
await createTask(agentId, 'search_task', {}); // May fail if no access
Generated: 2025-10-03 API Version: 1.0.0 Test Coverage: 179 tests passing Multi-Agent Tests: 100/100 passing