Skip to content

Healthcheck ​

Check if Hack Club AI is working and ready to serve requests.

Endpoint ​

GET /up

Example Request ​

bash
curl https://ai.hackclub.com/up

Response 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 NameDescription
statusup if every check below passed, otherwise down.
postgresWhether the database is reachable.
clickhouseWhether the analytics database is reachable.
openRouterWhether OpenRouter (chat, embeddings, images) is reachable.
mistralWhether Mistral (OCR) is reachable.
exaWhether Exa (web search) is reachable.
balanceRemainingCredit remaining in Hack Club AI's OpenRouter account, in USD.
dailyKeyUsageRemainingSpend remaining on Hack Club AI's OpenRouter key, in USD. Subject to change.
keyLimitRemainingSame as dailyKeyUsageRemaining.
keyUsageTotal spend on Hack Club AI's OpenRouter key, in USD.
replicateUnusedCreditCredit remaining in Hack Club AI's Replicate account, in USD. May be missing.
timestampWhen the result was generated, in milliseconds since the Unix epoch. Results may be up to 30 seconds old.