API Reference

Health Check

A lightweight liveness probe that confirms the API process and the warm-booted browser instance are responsive.

GET/

Description

Returns a small JSON document confirming that the API process is accepting connections and that the headless browser is initialized. Use this for uptime monitoring, Kubernetes liveness probes, or load-balancer health checks.

Response

200 OK with Content-Type: application/json

{
  "status": "active",
  "message": "API is running"
}

Code examples

curl https://api.example.com/

Tip

A successful response confirms only that the process is up. To verify end-to-end rendering, send a real screenshot request against a known URL like https://example.com.