Skip to main content

​
Apiosk Gateway

The Apiosk gateway is a pay-per-call API surface for agents and applications. Consumers discover APIs, inspect machine-readable metadata, receive an HTTP 402 payment challenge when required, attach an x-payment proof, and execute calls through a uniform contract.

​
At a glance

The gateway acts as a public x402 payment boundary. A client requests execution, receives pricing in a 402 Payment Required response when the route is paid, settles in USDC, retries with a proof, and then receives the upstream result through the same public surface. x402 crypto rail flow This is the fastest way to understand the model:
  1. The agent makes a normal request to the gateway.
  2. The gateway returns HTTP 402 plus pricing when payment is required.
  3. The client settles on-chain and attaches the proof in x-payment.
  4. The gateway verifies the proof, forwards the call, and returns data.

​
Public routes that matter

RoutePurpose
GET /typesDiscover listing groups.
GET /v1/apisSearch and paginate public listings.
GET /v1/apis/:slugInspect one public listing and its endpoint docs.
GET /:api_slug/metadataFetch MCP-style metadata and operation hints.
POST /:api_slug/executeExecute through the agent-native contract.
POST /v1/apis/registerPublish a community API listing.

​
How the public flow works

  1. Discover an API from the catalog.
  2. Read /:api_slug/metadata to understand the default operation, schemas, price, and tags.
  3. Call /:api_slug/execute.
  4. If the route is paid, handle the 402 Payment Required response and attach an x-payment proof.
  5. Receive a normalized response envelope with result, cost, latency, and status.

​
What these docs do not expose

  • settlement and payout topology
  • operator controls
  • replay and anti-abuse implementation details
  • managed wallet or session internals
  • internal forwarding behavior that is not part of the public contract
Use the guides for integration patterns and the API reference for the route-level contract.