Skip to main content

GET /api/health

Returns the health status of the API server and availability of integrated services.

Request

No parameters required.
curl http://localhost:3001/api/health

Response

status
string
Overall API status. Always returns "ok" if server is running.
availableProviders
object
Status of integrated services

Response Example

{
  "status": "ok",
  "availableProviders": {
    "claude": true,
    "supabase": true
  }
}

Use Cases

  • Verify API server is running
  • Check which AI providers are available before making requests
  • Monitor service configuration in production
  • Implement client-side feature flags based on available services

Integration Example

const checkHealth = async () => {
  const response = await fetch('http://localhost:3001/api/health');
  const data = await response.json();
  
  if (data.availableProviders.claude) {
    console.log('Claude AI is available');
  } else {
    console.warn('Claude AI is not configured');
  }
  
  return data;
};

Build docs developers (and LLMs) love