Skip to main content
GET
/
health
Check API health
curl --request GET \
  --url https://api.headlessagents.ai/health
{
  "status": "healthy"
}

Documentation Index

Fetch the complete documentation index at: https://headlessagents.mintlify.app/llms.txt

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

Check if the API is up and running. This endpoint does not require authentication.

​
Endpoint

GET /health

​
Response

​
status
string
required
Will return “healthy” if the API is functioning properly
{
  "status": "healthy"
}

Response

200 - application/json

API is healthy

​
status
enum<string>
required
Available options:
healthy