Skip to main content
GET
Health Check

Overview

The /health endpoint provides real-time status information about the Stratus API, loaded models, LLM provider availability, and vault connectivity.
No authentication required - This endpoint is publicly accessible for monitoring and debugging.

Use Cases

Monitoring

Monitor API availability and model status

Service Discovery

Discover available models and providers

Debugging

Troubleshoot connection and availability issues

Health Checks

Integrate with load balancers and monitoring tools

Request

No parameters required. Simple GET request:

Response

Response Fields

string
Overall API health status. Returns "healthy" when the service is running.
string[]
Array of loaded Stratus world model sizes (e.g., ["base"]).
string[]
Array of registered LLM provider names. Current providers: openai, anthropic, google, openrouter.
string
Supabase Vault connection status for encrypted LLM key storage: "connected" or "disabled".
object
Policy head and world model status.
string
API version string.
string
Git commit SHA of the deployed build.

Status Interpretation

Overall Status

Vault Status

Examples

Check API Health

Check Provider Registration

Integration with Load Balancer

Monitoring Dashboard

Performance

Use in Production

Health Check Polling

Circuit Breaker Pattern

Troubleshooting

Endpoint Not Responding

Symptoms: Timeout or connection refused Possible Causes:
  • Network connectivity issues
  • DNS resolution problems
  • Firewall blocking HTTPS traffic
Solution:

No Models Loaded

Symptoms: stratus_models_loaded is empty [] Meaning: No Stratus world model is loaded — all chat/messages/rollout/embeddings requests will fail Action:
  1. Check stratus_models_loaded array
  2. Contact support if models are not loading
  3. Monitor for recovery

Vault Disabled

Symptoms: vault: "disabled" Impact: Cannot use /v1/account/llm-keys endpoints for encrypted key storage Workaround: Pass LLM provider keys directly in requests (less secure but functional)

Integration Examples

With Prometheus

With Datadog

  • Models - List available model combinations
  • LLM Keys - Manage encrypted LLM keys (requires vault connection)

Best Practices

  • Poll health endpoint every 30-60 seconds for production monitoring
  • Implement circuit breaker pattern to handle degraded states gracefully
  • Monitor vault connection if using LLM key management features
  • Set appropriate timeouts (5s recommended) to avoid blocking on health checks