For the complete documentation index, see llms.txt. This page is also available as Markdown.

Health

Service health checks. No authentication required.

Endpoints

Method
Path
Description

GET

/v1/health

Basic health status

GET

/v1/health/detailed

Health status with dependency checks


Basic Health

GET /v1/health
curl https://api.tokenbot.com/v1/health

Response:

{
  "status": "healthy",
  "timestamp": "2026-06-28T12:00:00.000Z",
  "version": "0.1.0",
  "uptime": 3825.21
}
Field
Type
Description

status

string

healthy, degraded, or unhealthy

timestamp

string

ISO-8601 timestamp of the check

version

string

Running API version

uptime

number

Process uptime in seconds

Detailed Health

Adds a dependencies block reporting the status of downstream services. Use this for monitoring; the basic endpoint is best for cheap liveness probes.

Response:

Field
Type
Description

dependencies.graphql

string

up or down — GraphQL API reachability

dependencies.redis

string

up or down — cache reachability (optional)

Status Values

Status
Meaning

healthy

All checked dependencies are up

degraded

Some dependencies are down; partial functionality

unhealthy

All checked dependencies are down

Last updated

Was this helpful?