API Health Check
Simple health check endpoint to verify API availability and authentication status. Use this endpoint for monitoring and to validate API tokens.
Use Cases
- Monitoring API health
- Validating API tokens
- Testing CORS configuration
- Checking rate limits
Response Times
- Expected: < 100ms
- Warning: > 500ms
- Critical: > 1000ms
Monitoring Guidelines
- Poll every 60 seconds
- Implement circuit breaker pattern
- Track response times
- Monitor error rates
Example Response
{
"message": "🎤 We're humming along!",
"request_status": "ok",
"data": {},
"timestamp": "2024-03-20T23:13:31.179Z"
}
Documentation Index
Fetch the complete documentation index at: https://docs.letshum.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer token authentication using API tokens.
Include the token in the Authorization header as: Authorization: Bearer <token>
Obtain tokens through your Hum API account dashboard or contact support@letshum.com for access.
Response
API is available, and token is valid
A message confirming the API is available.
"🎤 We're humming along!"
A status code summarizing the outcome of this response.
- ok: Request was successful
- warning: Request was processed but with some issues
- error: Request failed
ok, warning, error "ok"
Empty object for this response
A timestamp in ISO 8601 format.
"2024-09-20T23:13:31.179Z"