DEVELOPERS

Zone Healthy developer portal

Public, unauthenticated endpoints for site metadata and agent discovery. Customer accounts, checkout, and orders stay on the website session and are not part of this public API.

Quickstart

curl -sS -H 'Accept: text/markdown' https://www.zonehealthy.com/
curl -sS https://www.zonehealthy.com/api/v1/health
curl -sS https://www.zonehealthy.com/api/v1/site
curl -fsSL https://www.zonehealthy.com/cli/zh -o zh && chmod +x zh
./zh site

Official CLI

The official CLI is the zh script at /cli/zh. Installer and usage live on /cli. Commands: zh health, zh site, zh markdown [path].

Errors and rate limits

4xx and 5xx responses use RFC 9457 application/problem+json with a machine-readable code and human-readable detail. Successful and error responses include IETF RateLimit and RateLimit-Policy headers (60 requests per 60 seconds). HTTP 429 also includes Retry-After.

API keys

Read-only public routes do not require a key. If your client must send one, use zh-public as X-Api-Key. There is no paid partner key portal yet.

Endpoints

GET /api/v1/healthliveness
GET /api/v1/siteorganization profile and canonical links
GET /api/openapi.jsonOpenAPI 3.0
GET /llms.txtagent site index

Markdown

Public HTML pages also negotiate Accept: text/markdown. Missing URLs keep HTTP 404 and return a Markdown error body for that Accept header.

Sandbox

Public GET endpoints do not require an API key. Optional header X-Api-Key: zh-public is accepted for tooling that always sends a key.