v1 is additive: entries here add
capability or documentation, they do not break existing v1 calls.
Version and date facts on this page are drawn from the public npm registry and
the live sandbox census. For how versions pin together, see
Versioning. For the SDK packages, see the SDK overview.
New reference pages for the cross-cutting platform contracts, each verified
against the live sandbox:
- Rate limits — the
100 req/mindefault, theX-RateLimit-*+Retry-Afterheaders, and copy-paste backoff in four languages. - Pagination — the two list shapes (offset arrays on the product
plane,
next_cursorenvelopes on the census rails) and how to walk each. - Idempotency — where the key lives (there is no
Idempotency-Keyheader), the200 + OCSS-Replay: originalfaithful-replay contract, and the409 replaypitfall. - Versioning — the API path,
OCSS-v1.0-pre, dated Annex B editions,ETag/If-None-Match, and exact SDK pinning.
@openchildsafety/ocss0.1.3— the OCSS protocol + RFC 9421 request signer (signRequest) used across the signed examples in these docs.@phosra/link0.1.2— parent-facing connect flow.@phosra/gatekeeper0.2.2— tighten-only enforcement overlay.
0.x minors may break) — see SDK versioning.- Self-serve developer orgs — sign up, auto-provision a dev org, and mint a
phosra_test_key with no sales call. See Create an account. @phosra/sdk0.1.0— the first published server SDK line.@phosra/cli0.2.0and@phosra/mcp0.4.0published.- Free-tier orgs default to 100 requests/minute (Rate limits).
- First release of the
@phosra/mcpMCP server, exposing Phosra tools to agents. See the MCP server SDK.
Current platform conventions
These are the standing contracts of thev1 surface, not point-in-time releases.
They are documented and verified on their own pages:
| Convention | Value | Reference |
|---|---|---|
| API version | /api/v1 (in the path) | Versioning |
| OCSS spec version | OCSS-v1.0-pre | Versioning |
| Default rate limit | 100 req / 60 s (free tier) | Rate limits |
| Idempotency marker | OCSS-Replay: original on faithful replays | Idempotency |
| Error classes | closed set of seven | Errors |
Looking for infrastructure status and incidents rather than API changes? That
lives on the status page.