Health Check
Check API health and verify authentication status
The health endpoint provides a quick way to verify that:
- The API is operational
- Your API key is valid
- Your authentication is working properly
This is typically the first endpoint you should test when integrating with the Buena.ai API.
This endpoint does not require any specific permissions and does not count heavily against rate limits.
Request
Your API key for authentication
Response
Current API version (e.g., “2.0”)
API health status (“healthy” or “degraded”)
Authentication type (“user” for valid API key)
Information about the authenticated user
Information about the API key used
ISO 8601 timestamp of the response
Use Cases
1. Integration Testing
Use the health endpoint to verify your integration setup:
2. Permission Verification
Check if your API key has the required permissions:
3. Monitoring and Alerting
Use for uptime monitoring and health checks:
Error Responses
Invalid API Key (401)
Rate Limited (429)
Service Issues (5xx)
Status Indicators
The status
field in the response can be:
Status | Description | Action |
---|---|---|
healthy | All systems operational | Continue normal operations |
degraded | Partial functionality | Monitor closely, some features may be slower |
maintenance | Scheduled maintenance | Retry after maintenance window |
Pro Tip: Set up automated health checks in your monitoring system to detect API issues early. We recommend checking every 5-10 minutes for production applications.
Next Steps
Once your health check passes: