MoonKeyDocumentation
Reference

API reference

Stable conventions for a future versioned public API. No mutation route is released.

Contract designed
Pre-alpha documentation boundary

Examples describe accepted contracts unless explicitly marked implemented. They do not imply a deployed API, SDK, signer, or production environment.

Examples
Code example format

Availability#

GET /v1/session and GET /v1/wallets are implemented behind default-off activation, application-bound bearer authorization, scope checks, origin enforcement, and forced tenant RLS. Operator configuration uses the separate authenticated internal control plane. Wallet mutation and real-value execution are not released.

  • HTTPS outside local development
  • Resources under /v1
  • The repository OpenAPI contract is authoritative
  • Opaque tenant-bound cursors

Error envelope#

Errors use stable codes, safe messages, a request ID, and non-sensitive details. Cross-tenant authorization failures do not reveal whether a resource exists.

JSON
{
  "error": {
    "code": "ENTITLEMENT_REQUIRED",
    "message": "The requested wallet scope is not enabled.",
    "request_id": "req_...",
    "details": {
      "entitlement": "wallet_scope.ecosystem"
    }
  }
}

Signing contract#

A future signing request accepts a canonical chain payload and separate human intent metadata. The policy and signer decisions bind to the payload; human metadata cannot authorize or change the bytes.

Implementation status

Review the engineering-readiness snapshot for current service boundaries. Contact the team before integrating a capability that remains gated.

Engineering status

Command center

Search page titles and navigate to a console page or documentation article.