Publish your first API
Prerequisites
- An account with at least Starter plan access.
- An existing HTTP service reachable from the internet.
Step 1 — Register the API Product
From the dashboard, go to API Products → New Product.
| Field | Example |
|---|---|
| Name | Payments API |
| Upstream URL | https://api.example.com |
| Description | Handles payment intent lifecycle. |
Click Create product.
Step 2 — Add proxy routes
Open the product and click Add route. Configure:
GET /v1/paymentsPOST /v1/paymentsGET /v1/payments/:idStep 3 — Generate OpenAPI spec
In the product view, click Generate OAS to trigger AI Recognition. The system samples live traffic or a provided collection and returns a ready-to-use OpenAPI 3.1 spec.
Step 4 — Publish developer portal
Go to Portals → New Portal, link it to your product, and click Publish. The portal is live in under 60 seconds.