# Apiosk Gateway

> Public integration docs for discovering, paying for, executing, and publishing APIs through the Apiosk gateway.

## Docs

- [Gateway Overview](https://docs.apiosk.com/index.md): Public integration docs for the Apiosk gateway.
- [Quickstart](https://docs.apiosk.com/overview/quickstart.md): Fastest path to discover an API, handle payment, and execute a request through the gateway.
- [Payment Model](https://docs.apiosk.com/overview/payment-model.md): Public explanation of how paid and unpaid gateway routes work without exposing gateway internals.
- [Terminology](https://docs.apiosk.com/overview/terminology.md): Shared definitions for the public gateway, dashboard, and payment docs.
- [FAQ](https://docs.apiosk.com/overview/faq.md): Short answers to the most common public gateway and dashboard questions.
- [Changelog](https://docs.apiosk.com/overview/changelog.md): Public-facing record of notable Apiosk gateway changes.
- [Dashboard Overview](https://docs.apiosk.com/dashboard/overview.md): Public-safe guide to the provider portal at dashboard.apiosk.com and the sections it actually contains.
- [Workflow Map](https://docs.apiosk.com/dashboard/workflow.md): The recommended public-safe provider portal workflow from onboarding through live payments.
- [Publishing APIs](https://docs.apiosk.com/dashboard/publishing.md): How the provider portal helps you publish and configure APIs without documenting any private platform internals.
- [Agent Wallets](https://docs.apiosk.com/dashboard/agent-wallets.md): Public-safe explanation of managed agent wallets, what still works, and why creating a new one is currently unavailable.
- [Manual Payments](https://docs.apiosk.com/dashboard/manual-payments.md): How to reason about the raw manual payment path from the dashboard context without exposing internal implementation details.
- [Payments And Usage](https://docs.apiosk.com/dashboard/payments-and-usage.md): Public-safe overview of what operators can monitor in the provider portal after APIs go live.
- [Gateway Testing](https://docs.apiosk.com/dashboard/gateway-testing.md): How to use the dashboard's gateway section and public contract to validate that an API is charging and forwarding correctly.
- [Consumer Guide](https://docs.apiosk.com/guides/consumers.md): How agents and applications discover APIs, inspect metadata, attach payment, and execute requests through the gateway.
- [Bazaar Discovery](https://docs.apiosk.com/guides/bazaar-discovery.md): How Apiosk gateway routes become discoverable to agents through Coinbase's CDP x402 Bazaar after their first settled payment.
- [MCP Clients](https://docs.apiosk.com/guides/mcp-clients.md): Connect Apiosk to ChatGPT, Claude Code, Codex, and other MCP clients.
- [JavaScript SDK](https://docs.apiosk.com/guides/sdk.md): Use @apiosk/sdk to discover, pay for, and execute gateway APIs from Node backends with typed 402 handling and automatic x402 retries.
- [Gateway Skill](https://docs.apiosk.com/guides/gateway-skill.md): Install the Apiosk gateway skill so coding agents like Claude Code and Codex can run paid gateway requests from a shell.
- [Preflight (Dry Run)](https://docs.apiosk.com/guides/preflight.md): Ask the gateway what a paid call would do, which rail, which wallet, whether it would succeed, without spending anything.
- [Execute Contract](https://docs.apiosk.com/guides/execute.md): How to use the public /execute surface correctly for both default and explicit operations.
- [Execute Capabilities](https://docs.apiosk.com/guides/execute-capabilities.md): What /execute is best at, what it can represent safely, and when passthrough is the better choice.
- [Payment Options](https://docs.apiosk.com/guides/payment-options.md): Public-safe overview of the supported payment paths: managed wallet, raw x402, and unpaid routes.
- [x402 v1 and v2](https://docs.apiosk.com/guides/x402-versions.md): Every paid 402 is served in both x402 dialects at once, and the gateway accepts a payment proof in either header. What that means for your client.
- [Multi-chain Settlement](https://docs.apiosk.com/guides/multichain.md): The gateway settles USDC on more than one network, how the multi-accept 402 works, how buyers pick a chain, and how publishers configure per-chain payout wallets.
- [Payment Mode Comparison](https://docs.apiosk.com/guides/payment-mode-comparison.md): Side-by-side comparison of managed wallet mode, raw x402 mode, and free routes.
- [Errors And Retries](https://docs.apiosk.com/guides/errors-and-retries.md): How clients should interpret common public gateway errors and what retry behavior is appropriate.
- [Examples](https://docs.apiosk.com/guides/examples.md): Minimal copy-paste examples for discovery, metadata, execute, and publisher management.
- [Publisher Guide](https://docs.apiosk.com/guides/publishers.md): How to register, inspect, update, and manage community API listings through the gateway.
- [Provider SDK Keys](https://docs.apiosk.com/guides/provider-sdk.md): Use a long-lived sk_live_ key to publish and manage listings, and make paid calls, headlessly, without a browser session or per-request wallet signature.
- [Publisher MCP](https://docs.apiosk.com/guides/publisher-mcp.md): Publish paid x402 routes straight from a coding agent, Claude Code, Cursor, Codex, through the hosted Apiosk MCP server.
- [Payment Checks (Gate a Skill or Service)](https://docs.apiosk.com/guides/payment-check.md): How to gate access to a paid skill, download, or execution behind an Apiosk payment check so unpaid requests get 402 Payment Required and paid ones are served.
- [Publisher Lifecycle](https://docs.apiosk.com/guides/publisher-lifecycle.md): What happens to a listing from creation through Apiosk review, activation, and ongoing updates.
- [Listing Metadata](https://docs.apiosk.com/guides/listing-metadata.md): How to structure public listing metadata so agents can discover and use your API without exposing private details.
- [Apiosk Connect (Marketplace)](https://docs.apiosk.com/guides/connect-marketplace.md): Let a marketplace onboard its own merchants and bill their APIs as skills over x402, with the payment split between merchant, marketplace, and Apiosk.
- [Public Boundaries](https://docs.apiosk.com/guides/boundaries.md): What the gateway docs include, what they exclude, and how to document the public contract safely.
- [Apiosk Pay (Hosted Checkout)](https://docs.apiosk.com/pay/overview.md): A marketplace hands off a payment to pay.apiosk.com and gets the buyer back with a result. The buyer's own wallet pays the seller, the marketplace, and Apiosk in one transaction.
- [Pay quickstart](https://docs.apiosk.com/pay/quickstart.md): One authenticated call creates a checkout and returns a URL to redirect the buyer to. Read the payment back before you release the goods.
- [Naming a seller](https://docs.apiosk.com/pay/sellers.md): A checkout names a seller by ID, never by name and never by wallet address. Either your own external_seller_id or the Connect merchant UUID works, always scoped to your marketplace.
- [Checkout API reference](https://docs.apiosk.com/pay/checkout-api.md): Every endpoint on pay.apiosk.com: the two you call with your secret key, and the payer-facing ones the hosted page uses.
- [Checkout lifecycle](https://docs.apiosk.com/pay/lifecycle.md): The six statuses a checkout moves through, the two clocks that bound it, and why the on-chain receipt decides the outcome rather than the transaction hash.
- [Payment webhooks](https://docs.apiosk.com/pay/webhooks.md): Signed payment.* events with a timestamped HMAC. Verify over the raw bytes, reject stale timestamps, and never treat the webhook as authoritative.
- [Payment links](https://docs.apiosk.com/pay/payment-links.md): A one-recipient payment link, created in the provider portal and payable by any wallet. No split, no fee, no checkout session.
- [API Reference Overview](https://docs.apiosk.com/reference/overview.md): How the generated Mintlify API reference is structured for the Apiosk gateway.
- [Gateway health](https://docs.apiosk.com/api-reference/discovery/health.md)
- [List listing groups](https://docs.apiosk.com/api-reference/discovery/listing-groups.md)
- [Browse listings by type](https://docs.apiosk.com/api-reference/discovery/listings-by-type.md)
- [List public APIs](https://docs.apiosk.com/api-reference/discovery/list-apis.md)
- [Get API listing detail](https://docs.apiosk.com/api-reference/discovery/api-detail.md)
- [Get agent metadata](https://docs.apiosk.com/api-reference/execution/agent-metadata.md)
- [Execute API via /execute](https://docs.apiosk.com/api-reference/execution/execute-api.md)
- [Register community API](https://docs.apiosk.com/api-reference/publishing/register-api.md)
- [List wallet-owned APIs](https://docs.apiosk.com/api-reference/publishing/my-apis.md)
- [Update API listing](https://docs.apiosk.com/api-reference/publishing/update-listing.md)
- [Deactivate API listing](https://docs.apiosk.com/api-reference/publishing/deactivate-listing.md)
- [Update endpoint docs](https://docs.apiosk.com/api-reference/publishing/endpoint-docs.md)
- [Get wallet spend summary](https://docs.apiosk.com/api-reference/metrics/wallet-balance.md)
- [Get wallet usage statistics](https://docs.apiosk.com/api-reference/metrics/wallet-usage.md)

## OpenAPI Specs

- [public-gateway](https://docs.apiosk.com/openapi/public-gateway.json)
- [openapi](https://docs.apiosk.com/api-reference/openapi.json)