Service health

GET/health

In the SDKs: ping

Authentication

Every call carries your API key in an X-API-Key header. Keys are created in the console.

Request body

None. This call takes no JSON body.

Returns

The 200 body. Fields nested one level are shown as parent.child.

ok boolean

service string

ts string

Example

curl -X GET https://api.wontopos.com/health \
  -H "X-API-Key: $WOS_API_KEY"

Status codes

Rate limits per tier and the full status list are in Errors & limits.

Notes

No API key. This is the one call you can make before you have an account, which makes it the right probe for a load balancer or an uptime check.

It answers for the API itself. It does not tell you whether a particular memory model’s engine can serve a given call — a model whose engine does not implement an endpoint answers 501 on that call, not here. Per-service status is published at status.wontopos.com.

Treat a 200 here as "the front door is open", not as "the call you are about to make will work". Watching only this endpoint is how an outage stays invisible.

In the SDKs

The Python, TypeScript, and Rust SDKs wrap this endpoint so you do not build the request by hand — pip install wontopos, npm i wontopos, or cargo add wontopos, then the method list is on the SDK reference. A coding agent can take the whole API in one file at llms.txt, or over MCP with npx -y wontopos-mcp.

Related

• List models