Liveness probe

GET

/v1/health

const url = 'https://api.cotes.ai/v1/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.cotes.ai/v1/health

Reports whether the API is up and which build is running. It needs no API key and is exempt from rate limiting, so use it for uptime checks and status pages instead of polling a contest endpoint.

The response is always 200 while the process is serving. ok and db tell you whether it can reach its database: ok: false with db: down means contest and stream requests will fail until the database is back, so treat it as degraded and back off. version, commit and model_version identify the release and the signal model it serves, which is useful when you report an issue.

Responses

200

Service is up

application/json

object

required

boolean

string

Allowed values: up down

version

Release of the service currently running.

string

commit

Short git commit of the running build; null when the deploy environment does not expose one.

string | null

model_version

Version tag of the model shipped in this service’s build. This service does not run the model; a signal’s own model_version is authoritative for what produced it, and the two can differ while a deploy is in flight.

string | null

Example

{
  "db": "up",
  "version": "1.4.0",
  "commit": "a1b2c3d4e5f6",
  "model_version": "c5456da6"
}