Ax402Docs
PLATFORM

Control plane API

REST contract, auth, API keys

The control plane is the seller-facing REST API behind this dashboard. SDKs, CLI, and MCP tools are thin wrappers over the same routes defined in the OpenAPI contract.

OpenAPI contract

Machine-readable spec: openapi/control-plane.yaml . Agents should load this file for exact request/response shapes.

Authentication

  • Seller JWT — from POST /auth/login or signup; used by the dashboard BFF
    • API keyX-API-Key: ax402_live_... from POST /auth/api-keys; scoped for automation
    • Email verification required before write operations

Core resources

  • /apis — register upstream base URL, slug, pay-to mode
    • /apis/{"{id}"}/endpoints — per-route x402 accept options
    • /apis/{"{id}"}/domains — custom hostnames + DNS verification
    • /openapi/parse, /openapi/import — bulk endpoint creation
    • /stats/overview, /settlements — analytics
    • /config/platform — public platform metadata

Gateway vs control plane

Buyers pay gateway hostnames (e.g. https://myapi.example.com/v1/data), not the control plane URL. Use buyer SDKs, React paywall, or ax402 pay url for gateway URLs only.

Client libraries

  • TypeScript — Ax402Client with auth, apis, endpoints, domains, openapi, stats, settlements, config
    • Go — github.com/AxLabs/ax402-sdk/go
    • Python — ax402_sdk.Ax402Client
    • CLI and MCP — same surface for agents

On this page