GET /api/v1/health — service health check - BoardPulse AI

The health endpoint confirms that the BoardPulse AI API is running and returns the name of the active environment. It requires no authentication and no request body.

Request

Method: GET
Path: /api/v1/health No query parameters or request body.

Response

Field	Type	Description
`status`	string	Always `"ok"` when the service is running
`environment`	string	The active environment name (e.g., `development`, `production`)

Example

curl http://localhost:8000/api/v1/health

{
  "status": "ok",
  "environment": "development"
}

The environment value reflects the APP_ENVIRONMENT environment variable, which defaults to development.

Powered by Mintlify

Auto-generate your docs