Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/FloxTBoTyy/BoardPulse-AI/llms.txt

Use this file to discover all available pages before exploring further.

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

FieldTypeDescription
statusstringAlways "ok" when the service is running
environmentstringThe 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.

Build docs developers (and LLMs) love

Get started for freeTalk to us