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/openapi.json in the ax402-clients repository. Agents should load this file for exact request/response shapes.
Authentication
- Seller JWT — from
POST /auth/loginor signup; used by the dashboard BFF- API key —
X-API-Key: ax402_live_...fromPOST /auth/api-keys; scoped for automation - Email verification required before write operations
- API key —
Core resources
/apis— register upstream base URL, slug, pay-to mode; optionaldiscovery_guidance,discovery_contact_email,openapi_version/apis/{id}/discovery— computed gateway discovery URLs (apis:read)/apis/{id}/endpoints— per-route x402 accepts; optionalrequest_schema/response_schema/apis/{id}/domains— custom hostnames + DNS verification/openapi/parse,/openapi/import— bulk endpoint creation (schemas preserved when present)/stats/overview,/settlements— analytics/config/platform— public platform metadata
Gateway discovery
Buyers and agents discover payable routes on the gateway host:
GET https://{api-host}/openapi.json— AgentCash OpenAPIGET https://{api-host}/.well-known/x402.json— x402 origin manifest
See API discovery.
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
| Language | Package |
|---|---|
| TypeScript | @ax402/sdk — Ax402Client with auth, apis (incl. discovery), endpoints, domains, openapi, stats, settlements, config |
| Go | github.com/AxLabs/ax402-sdks/go — GetAPIDiscovery, discovery fields on CreateAPIInput |
| Python | ax402_sdk.Ax402Client — apis.discovery; install from ax402-sdks (packages/python/) until PyPI publish |
| CLI | @ax402/cli — apis discovery, discovery urls |
| MCP | @ax402/mcp-server — ax402_discovery_urls, ax402_set_discovery_guidance |
See SDK overview and API discovery.