APIs

An API resource holds an OpenAPI document and its published versions.

Create an API

In the console: APIs → New. Choose a name and slug.

Via the API:

POST /v1/apis
Authorization: Bearer sk_…
Content-Type: application/json

{ "name": "Payments", "slug": "payments" }

Upload a specification

POST /v1/apis/{api}/spec
Authorization: Bearer sk_…
Content-Type: application/json

{ "document": "openapi: 3.1.0\ninfo:\n  title: Payments\n  version: 1.0.0\npaths: {}\n" }

You can also paste or upload YAML/JSON in the console. Uploads are validated. If a Spectral ruleset is attached, failing rules can block the publish.

Attach to products

Once published:

• Embed the API in a docs site for interactive reference

• Point an SDK or CLI at the API for generation

Git-backed OpenAPI

Connect GitHub or GitLab on the API’s Integrations page and set the path to your OpenAPI file. Webhooks and manual sync keep the registry current. See Git sync.

Visibility

PATCH /v1/apis/{api}
Authorization: Bearer sk_…
Content-Type: application/json

{ "visibility": "public" }

Public APIs are suitable for open developer platforms; private APIs stay inside the organization.