GET /healthz) require authentication.
Passing your API key
Pass your API key using one of these methods depending on the endpoint: HTTP header (for/fetch, /usage, /network/*, /debug/pick):
/browser, /ws, and /amqp):
/browser, /ws, and /amqp, the key is read from the JSON body field apiKey (or key), or the X-API-Key header.
Error responses
| Status | Meaning |
|---|---|
401 | Missing API key |
403 | Invalid API key |
Rate limits
Each API key has a configurable rate limit:| Setting | Default |
|---|---|
| Requests per second (RPS) | 10 |
| Burst capacity | Equal to RPS |
429 Too Many Requests with these headers:
Public endpoints
These endpoints do not require authentication:| Endpoint | Description |
|---|---|
GET / | API overview and status |
GET /healthz | Liveness probe ({"ok": true}) |