Skip to main content
GET
/
v1
/
health
Health Check
curl --request GET \
  --url https://api.vizapi.ai/v1/health
{
  "status": "<string>"
}

Documentation Index

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

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

The /health endpoint allows you to check the health status of the VizAPI.ai API. This endpoint is useful for monitoring and ensuring that the API is operational.

​
Request

This endpoint doesn’t require any parameters or authentication.

​
Response

​
status
string
The health status of the API. Returns “healthy” when the API is operational.

​
Examples

​
Example Request

curl -X GET https://api.vizapi.ai/v1/health

​
Example Response

{
  "status": "healthy"
}

​
Error Codes

Status CodeDescription
500Internal Server Error - The API is experiencing issues
503Service Unavailable - The API is temporarily unavailable