Healthcheck
Check if Hack Club AI is working and ready to serve requests.
Endpoint
GET /upExample Request
bash
curl https://ai.hackclub.com/upResponse Format
json
{
"status": "up",
"postgres": true,
"clickhouse": true,
"openRouter": true,
"mistral": true,
"exa": true,
"balanceRemaining": 100.466965531,
"dailyKeyUsageRemaining": 42.247146656,
"keyLimitRemaining": 42.247146656,
"keyUsage": 3177.113867455,
"replicateUnusedCredit": 14.33175,
"timestamp": 1790263354649
}The response status is 200 when everything is up and 503 when anything is down.
| Field Name | Description |
|---|---|
status | up if every check below passed, otherwise down. |
postgres | Whether the database is reachable. |
clickhouse | Whether the analytics database is reachable. |
openRouter | Whether OpenRouter (chat, embeddings, images) is reachable. |
mistral | Whether Mistral (OCR) is reachable. |
exa | Whether Exa (web search) is reachable. |
balanceRemaining | Credit remaining in Hack Club AI's OpenRouter account, in USD. |
dailyKeyUsageRemaining | Spend remaining on Hack Club AI's OpenRouter key, in USD. Subject to change. |
keyLimitRemaining | Same as dailyKeyUsageRemaining. |
keyUsage | Total spend on Hack Club AI's OpenRouter key, in USD. |
replicateUnusedCredit | Credit remaining in Hack Club AI's Replicate account, in USD. May be missing. |
timestamp | When the result was generated, in milliseconds since the Unix epoch. Results may be up to 30 seconds old. |