OpenPermit API
Generated endpoint reference from the current OpenAPI contract.
The generated operation pages below are sourced from apps/api/openapi.json. Regenerate that file from apps/api when the API contract changes, then rebuild this docs app.
Auth
Sessions, organization context, invitations, and service accounts.
Agent
Quote and place OpenPermit-compatible storefront orders for HTTP-capable agents.
Mandates
Draft, approve, activate, pause, resume, revoke, and rotate delegates.
Payments
Normalize challenges, authorize policy, execute payments, and record receipts.
Sellers
Manage seller profiles, paid resources, challenges, verification, refunds, and settlement records.
Receipts
List and inspect receipts produced by OpenPermit payment flows.
Webhooks
Create and list subscriptions for operational delivery.
Onchain
Plan mandate registration, payment execution, and settlement reconciliation.
Audit
Read and export append-only audit evidence.
Emergency
Fail-closed pause and revoke controls.
Platform
Staff operations for users, organizations, sellers, billing, audit, and emergency controls.
Health
Read service metadata, liveness, readiness, and system health.
Current Tags
| Area | Representative endpoints |
|---|---|
| Auth | getAuthSession, createServiceAccount |
| Agent | quoteAgentCommerceOrder, placeAgentCommerceOrder |
| Mandates | createMandateDraft, listMandates, approveMandate |
| Payments | normalizePaymentIntent, authorizePayment, executePayment |
| Sellers | listSellers, createSeller, getSeller |
| Seller resources | createSellerResource, createSellerChallenge, verifySellerPayment |
| Receipts | listReceipts, getReceipt |
| Webhooks | createWebhookSubscription, listWebhookSubscriptions |
| Onchain | createOnchainMandateRegistrationPlan, createOnchainPaymentExecutionPlan |
| Audit | listAuditEvents, exportAuditEvents |
| Emergency | emergencyPause, emergencyRevoke |
| Platform | listPlatformUsers, updatePlatformUserRoles, listPlatformOrganizations, exportPlatformAuditEvents |
| Health | getApiInfo, getReadiness |
These pages are the public integration reference. Do not import generated web dashboard hooks or Kubb files from applications integrating with OpenPermit.