Machine API reference

• OpenAPI 3.1
• llms.txt
• RFC 9727 API catalog
• Webhook payload v2 schema
• Live pricing and catalog

The operation list is generated from the same registry as OpenAPI, rather than copied from the old documentation. Method, path, Scope, conditional Scope and idempotency support follow the registry; explanations come from a translated dictionary keyed by operationId. An unrecognized operation requires a translation in every language instead of silently showing English.

OpenAPI currently uses generic request/response objects for many operations. Its generic wallet request example is not a valid payload for every POST. Use the checked examples on authentication, topups and Watchdog for those workflows. The document is a discovery reference, not an assertion that every route shares the same response status or fields.

This module covers x402 machine billing and Watchdog automation. The metered data routes use their existing APIs and are listed separately. MCP is a read-only tool interface with a separate OAuth account flow; its implementation is not changed by this module. Credits and MCP user guides are separate documentation slices.

• GET /api/x402/account — Scope: read; Get credit balance and ledger.
• GET /api/x402/account/terms — Scope: read; Get terms acceptance.
• POST /api/x402/account/terms — Scope: write; Accept current terms.
• GET /api/x402/alerts — Scope: read; List alert history.
• DELETE /api/x402/alerts — Scope: write; Delete selected alert history.
• DELETE /api/x402/alerts/{id} — Scope: write; Delete one alert.
• GET /api/x402/alerts/export — Scope: read; Export alert history as CSV.
• POST /api/x402/auth/challenge — Scope: No authentication; Create a scoped SIWE challenge.
• POST /api/x402/auth/token — Scope: No authentication; Exchange signed SIWE for a bearer token.
• GET /api/x402/auth/tokens — Scope: read; List wallet API tokens.
• DELETE /api/x402/auth/tokens/{id} — Scope: write; Revoke an API token.
• GET /api/x402/channels — Scope: read; List channel status.
• PUT /api/x402/channels/{key} — Scope: write; Configure an input channel; Idempotency-Key supported.
• DELETE /api/x402/channels/{key} — Scope: write; Remove a channel target.
• POST /api/x402/channels/{key}/test — Scope: write; Send a channel test.
• POST /api/x402/message-preview — Scope: read; Preview a localized message.
• GET /api/x402/openapi.json — Scope: No authentication; Get this OpenAPI document.
• GET /api/x402/pricing — Scope: No authentication; Discover pricing, products, watches, signals and help.
• GET /api/x402/provider-fsp — Scope: read; Get provider FSP view.
• GET /api/x402/recipients — Scope: read; List named recipients.
• POST /api/x402/recipients — Scope: write; Create an input recipient; Idempotency-Key supported.
• PATCH /api/x402/recipients/{id} — Scope: write; Update a recipient.
• DELETE /api/x402/recipients/{id} — Scope: write; Delete a recipient.
• POST /api/x402/recipients/{id}/test — Scope: write; Test a recipient.
• POST /api/x402/recipients/telegram-link — Scope: write; Create a Telegram recipient link.
• GET /api/x402/settings — Scope: read; Get notification settings.
• PUT /api/x402/settings — Scope: write; Replace notification settings.
• GET /api/x402/stats — Scope: No authentication; Get public billing aggregates.
• GET /api/x402/subscriptions — Scope: read; List subscriptions and capacity.
• POST /api/x402/subscriptions — Scope: spend; Purchase subscription capacity; Idempotency-Key supported.
• PATCH /api/x402/subscriptions — Scope: write (spend when autoRenew is true); Update auto-renew.
• GET /api/x402/subscriptions/quote — Scope: read; Quote subscription capacity.
• POST /api/x402/subscriptions/trial — Scope: write; Start the one-time trial.
• POST /api/x402/topup — Scope: write; Create a topup draft; Idempotency-Key supported.
• GET /api/x402/topup/{handle} — Scope: read; Get topup status.
• POST /api/x402/topup/{handle}/confirm — Scope: write; Confirm a topup transaction.
• GET /api/x402/watches — Scope: read; List watches.
• POST /api/x402/watches — Scope: write; Create a watch; Idempotency-Key supported.
• GET /api/x402/watches/{id} — Scope: read; Get a watch.
• PATCH /api/x402/watches/{id} — Scope: write; Update a watch.
• DELETE /api/x402/watches/{id} — Scope: write; Delete a watch.