Skip to content

API reference

Generated from openapi.yaml. For the concepts behind these endpoints — how grants stay live, how the trust chain is walked, what a callback delivers — start with the guides alongside this section.

Group Covers
Encrypted records Experimental end-to-end encrypted entries. The server stores opaque bytes and cannot read them; clients do all the cryptography.
Discovery Unauthenticated endpoints describing the server itself. These anchor the DNS trust chain: a verifier reads _revoked.<domain> from DNS,…
Identity Identity material and, more importantly, whether the issuer still stands behind it. A certificate is minted for ten years and its parent…
Shares Reading a share by slug. The probe reports gates without revealing data; the resolve returns data and consumes a view.
Requests Submitting data to a request by slug.
Invites Previewing and accepting a workspace invitation.
Workspaces Membership and account-level operations.
Records The vault. Records hold the values that shares resolve at read time.
Grants Shares and requests as owned resources.
Webhooks A workspace's webhook endpoints, the events they hear about, and every delivery and attempt, with resend, replay and test. Events name…
Contacts Handing a grant to a counterparty the workspace keeps in its address book. The grant is always minted in the caller's own workspace, so…
Peers Calls one server makes to another when an answer to a request lives on the responder's own server. The responder's server holds the…
Sign-in People sign in with a passkey and nothing else; there are no passwords. A passkey is bound to the address it was made at, so the…
OpenID Connect Sign in with Revoked. A service signs people in with an ordinary OpenID Connect client library: the authorization code flow with PKCE,…
Attestations Statements one domain signs about an identity, usually one issued by another domain. An attestation is created as an offer; its subject…
Vault The vault as an API key or a connected tool reaches it. Each holds permissions from the catalogue (GET /api/permissions) and a reach:…
Connections Tools the owner connected. A tool proposes shares (revoked://p) and, once connected, reads the status of the links its proposals…
Schemas Shapes shared across more than one endpoint.

Machine-readable spec

The OpenAPI document is the source these pages are generated from. Point a client generator or an HTTP client at it directly rather than transcribing from here.