Skip to main content
GET
/
v1
/
health
Health Check
curl --request GET \
  --url http://localhost:8080/v1/health
{
  "api": "bread-api",
  "status": "healthy",
  "version": "0.1.0"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.com.ai/llms.txt

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

Response

200 - application/json

API is healthy and operational

Health check response

​
status
string
required

API health status: 'healthy' or 'degraded'

​
api
string
required

API name

​
version
string
required

API version