Skip to main content

​
Health API

The health endpoint is useful for both basic uptime checks and authenticated debugging.

​
Endpoints

  • GET /health
  • GET /v1/health
Both return the same payload. The SDK uses /v1/health.

​
Unauthenticated response

Without credentials, health returns service metadata: 
{
  "status": "healthy",
  "timestamp": "2026-03-15T00:00:00.000Z",
  "environment": "production",
  "version": "1.0.0",
  "services": {
    "api": "operational"
  }
}

​
Authenticated response

When you send an API key or JWT, the response also includes auth and workspace context when available: 
{
  "authenticated": true,
  "workspace_id": "workspace-uuid",
  "workspace_slug": "my-workspace",
  "user_id": "user-uuid",
  "brain_id": "brain-uuid",
  "default_brain_id": "brain-uuid"
}

​
Example

const health = await auvy.health.check()
console.log(health.status)

​
Notes

  • X-Brain-Id can be sent to inspect a specific brain context
  • Use this endpoint when diagnosing auth, workspace scoping, or deployment routing issues
  • createAUVYClient.fromApiKey() uses GET /v1/session/context for bootstrap, not the health endpoint