BitPlan API

The public read surface is API v1 at /api/v1. The OpenAPI document is at /openapi.json. Publishing and decrypting stay in the npm CLI bitplan, not this HTTP API.

Versioning

Breaking changes increment the URL path from /api/v1 to /api/v2. Additive fields and new operations can land in v1. Machine-readable policy is at /api/v1/version.

Compatibility

GET /ordfs/content/{pointer} remains the same envelope bytes as GET /api/v1/content/{pointer}.

Deprecation

Deprecated operations send a Deprecation header (RFC 9745). Nothing is deprecated today.

Sunset

When an operation is removed, responses include a Sunset header at least 90 days before the removal date. That window is the notice agents can rely on.

Envelope reads: envelope spec. CLI: BitPlan CLI.