API Products

An API Product is a self-contained, reusable data or service asset designed to deliver consistent, reliable, and secure functionality to internal or external consumers. API Products are defined, versioned, and published from API Products, then discovered and subscribed to from the API Catalog.

Product Types

A Kafka API Product is backed by an AsyncAPI specification over the Kafka protocol, and is the only type available today. REST, gRPC, and MCP-backed products are marked "coming soon."

Finding and Managing Products

Filter the product list to All, Team, or Mine, or search by name. Each card shows its publish status, category and protocol tags, owning team, version count, and subscriber count. From a product, open Details to manage it, or toggle its published state directly from the list.

API Products list showing publish status, category, protocol, and subscriber count

Create an API Product

1. From API Products, select New API Product.
2. Enter the details:
   • Display Name: a unique name for the API Product.
   • Category: pick a curated value (for example Payments) or type your own; curated values match the API Catalog's browse filter.
   • Description (optional): a short summary of what the API Product exposes.
   • Owner Team: the team responsible for the product.
3. Under AsyncAPI Specification, choose how to start the spec:
   • Extract from Kafka: select a cluster and one or more topics, then select Extract to auto-generate the spec from live topic and schema metadata.
   • Blank spec: start from a minimal AsyncAPI template.
   • Import File: upload an existing AsyncAPI YAML file.
4. Select a Gateway Group: its Kafka coordinates (bootstrap server and cluster ID) are derived automatically from the group you pick.
5. Select Create API Product.

New API Product dialog with display name, category, AsyncAPI specification source, and Gateway Group fields

The new product opens on its Definition tab, where you can preview the AsyncAPI spec, edit it as raw YAML, and inspect its channels, operations, and components.

Definition tab showing an API Product's AsyncAPI specification

Publishing

A product's Publishing tab lists every environment and Gateway Group it's currently published to, along with the release and status of each. Select Publish to make a version available:

• Version and Environment: which version of the product, and which environment, to publish to.
• Gateway Group and Kafka Cluster: the Gateway Group that will serve the product, and the cluster backing it.
• Display Name and Server Name: a human-readable label and the hostname alias consumers connect to (for example orders-api-v0.staging.platform.net).
• Release Strategy: New Release creates a new release without affecting existing subscribers, while Replace Existing Release overwrites the current release and may impact them.

Publish dialog with version, environment, Gateway Group, and release strategy fields

Publishing tab listing active publications by environment, Gateway Group, release, and status

Unpublish a release from the same tab to stop serving it without deleting the product itself.

Plans and Details

A product's Details tab holds its metadata (name, category, owner team, description, thumbnail), the Gateway Groups it's deployed to, and its Plan: the rate limit, security (for example API key authentication), quota, approval mode, and SLA consumers get when they subscribe.

Next Steps

• Applications covers how a consumer subscribes to a plan on this API Product and receives generated credentials.
• Gateways covers the runtime component that serves the published API Product.