← Back to Home
API Status: Operational

Heady Systems API

Complete API Reference & Interactive Explorer

🔧

System

GET /health
Basic health check endpoint. Returns 200 OK if the system is operational.
Auth: None
Response: { status: "ok" }
Response:
GET /api/system/status
Get comprehensive system status including all subsystems, resource usage, and operational metrics.
Auth: Optional
Response: JSON Object
Response:
GET /api/nodes
List all active nodes in the system with their status, resource metrics, and capabilities.
Auth: Optional
Response: Array of nodes
Response:
GET /api/pulse
Get real-time system heartbeat with active metrics, throughput, and latency data.
Auth: None
Response: Metrics object
Response:
🔐

Authentication

POST /api/auth/login
Authenticate a user and receive an access token for subsequent API calls.
Body: { email, password }
Response: { token, user }
POST /api/auth/register
Register a new user account in the system.
Body: { email, password, name }
Response: { user, token }
GET /api/auth/me
Get information about the currently authenticated user.
Auth: Required
Response: User object
Response:
POST /api/auth/logout
Invalidate the current authentication token and logout the user.
Auth: Required
Response: { status: "logged_out" }
Response:
⚙️

Pipeline

POST /api/pipeline/run
Trigger a new pipeline execution with optional configuration overrides.
Body: { stages, config }
Response: { runId, status }
Response:
GET /api/pipeline/state
Get the current state of the last pipeline execution including completed and pending stages.
Auth: Optional
Response: Pipeline state object
Response:
GET /api/pipeline/config
Retrieve the current pipeline configuration including all stage definitions and parameters.
Auth: Optional
Response: Configuration object
Response:
🧠

Brain

GET /api/brain/status
Get the current status of the System Brain including operational readiness score and active patterns.
Auth: Optional
Response: Brain status object
Response:
POST /api/brain/tune
Manually tune system parameters like concurrency, error thresholds, and resource allocation.
Body: { concurrency, errorRate, ... }
Response: Updated configuration
💬

Buddy (Chat)

POST /api/buddy/chat
Send a message to the Buddy AI assistant and receive intelligent, context-aware responses.
Body: { message, context }
Response: { reply, metadata }
GET /api/buddy/health
Check the health and availability status of the Buddy service.
Auth: None
Response: Health status
Response:
GET /api/buddy/suggestions
Get smart suggestions based on current system state and context.
Auth: Optional
Response: Array of suggestions
Response:
📚

Registry

GET /api/registry
Get the complete registry catalog including all components, services, workflows, and patterns.
Auth: Optional
Response: Registry object
Response:
GET /api/registry/component/:id
Lookup a specific component by ID to get its metadata, endpoints, and dependencies.
Params: id (component ID)
Response: Component details
Response:
🤖

Claude

POST /api/claude
Execute a Claude code generation or analysis task with optional context and constraints.
Body: { prompt, context }
Response: { result, tokens }
POST /api/claude/analyze
Analyze code or files using Claude's code analysis capabilities with detailed insights.
Body: { paths, type }
Response: Analysis results
POST /api/claude/security
Run a comprehensive security audit on the codebase or specific components.
Body: { scope, depth }
Response: Security findings
Response:
✨

Imagination

GET /api/imagination/status
Get the current status of the Imagination engine including active generators and queue depth.
Auth: Optional
Response: Status object
Response:
POST /api/imagination/generate
Generate creative content, configurations, or solutions using the Imagination engine.
Body: { prompt, constraints }
Response: Generated content