Skip to main content

Publisher Guide

Registering a listing also puts a payment check in front of your endpoint: the gateway returns 402 to unpaid callers and only forwards paid requests to your origin. If your goal is to gate a skill, download, or service behind payment, see Payment Checks.

Signed wallet headers

Management routes use signed wallet headers:
  • x-wallet-address
  • x-wallet-signature
  • x-wallet-timestamp
  • x-wallet-nonce
The public signature message format is:

Register a listing

Use POST /v1/apis/register to publish a community API.
The gateway performs a public health check against the HTTPS endpoint, then saves the listing as pending. Publishing is gated on operator review. A provider cannot put a listing straight into active: any provider-initiated transition to active is rewritten to pending, submitted_for_review_at is stamped, and the listing stays hidden from the catalog and serves no traffic until an Apiosk admin approves it. See Publisher Lifecycle.

Manage your listings

Use these routes after registration:
  • GET /v1/apis/mine?wallet=<0x...> to list your APIs and earnings summary
  • POST /v1/apis/:slug to update price, description, endpoint URL, activation state, or listing metadata
  • DELETE /v1/apis/:slug?wallet=<0x...> to deactivate a listing
  • PUT /v1/apis/:slug/endpoints/docs to attach public endpoint docs and schema hints

Listing metadata

Use listing_metadata for agent-facing discovery fields such as:
  • input and output schemas
  • operation hints
  • tags
  • default operation
  • price and latency metadata
Keep this metadata public-safe. Do not place secrets, private infrastructure details, or internal operational notes inside it.