API Reference
REST API documentation for programmatic access to Neural Commander.
🚧
Coming Soon — Beta Waitlist Goal: 100 signups
The API will be available when our beta waitlist reaches 100 developers. Join the waitlist to get early access.
Base URL
http://localhost:7669
Start the API server with: nc daemon --api
Quick Reference
| Method | Endpoint | Description |
|---|---|---|
| Health | ||
| GET | /health | Returns daemon health status |
| Project | ||
| GET | /api/status | Returns current project monitoring status |
| Sessions | ||
| GET | /api/sessions | List all sessions |
| GET | /api/sessions/:id | Get session by ID |
| GET | /api/sessions/crashed | Get crashed sessions |
| Claude Sessions | ||
| GET | /api/claude-sessions | List Claude Code sessions |
| Alerts | ||
| GET | /api/alerts | List active alerts |
| POST | /api/alerts/dismiss | Dismiss an alert |
| Requirements | ||
| GET | /api/requirements/all | List all requirements |
| GET | /api/requirements/:project | Get project requirements |
| POST | /api/requirements | Create requirement |
| Audit | ||
| GET | /api/audit/:project/latest | Get latest audit |
| GET | /api/audit/:project/markdown | Get audit as markdown |
| POST | /api/audit | Trigger new audit |
| Documentation | ||
| GET | /api/docs/health | Get documentation health |
| GET | /api/docs/search | Search documents |
Health Check
GET
/health Returns daemon health status and version information.
Example Response:
{
"status": "healthy",
"version": "0.99.0",
"uptime": "2h 15m",
"api_port": 7669
}Sessions
GET
/api/sessions Returns a list of all development sessions.
Example Response:
{
"sessions": [
{
"id": "sess_abc123",
"project": "my-project",
"started_at": "2025-01-15T10:30:00Z",
"status": "active",
"ide": "cursor"
}
],
"total": 1
} GET
/api/sessions/:id Returns details for a specific session.
Path Parameters:
id- Session ID
GET
/api/sessions/crashed Returns a list of crashed sessions for recovery.
Alerts
GET
/api/alerts Returns all active alerts.
Example Response:
{
"alerts": [
{
"id": "ALERT-NEU-001",
"severity": "warning",
"title": "Uncommitted Code Detected",
"message": "106 modified files detected",
"created_at": "2025-01-15T10:30:00Z"
}
],
"counts": {
"critical": 0,
"warning": 1,
"info": 0
}
} POST
/api/alerts/dismiss Dismiss an alert.
Request Body:
{
"alert_id": "ALERT-NEU-001"
}Audit
GET
/api/audit/:project/latest Get the latest audit results for a project.
Path Parameters:
project- Project name or path
POST
/api/audit Trigger a new audit.
Request Body:
{
"project_path": "/path/to/project",
"save": true,
"verbose": false
}Documentation
GET
/api/docs/health Get documentation health metrics.
Example Response:
{
"total_documents": 45,
"coverage_score": 78,
"stale_documents": 3,
"missing_areas": [
"API endpoints",
"Configuration options"
]
} GET
/api/docs/search Search documentation.
Query Parameters:
q- Search querytype- Filter by type (md, yaml, etc.)limit- Max results (default: 10)
Error Handling
All errors follow a standard format:
{
"error": true,
"code": "NOT_FOUND",
"message": "Session not found",
"details": {}
}Common Error Codes:
400- Bad Request404- Not Found500- Internal Server Error