Creating an API listing

Creating the API

In Studio, click New API (or Publish your first API). Fill in:

• Name: what developers will see, for example "Weather Forecast API". The name can't be changed after creation, so choose carefully. (If it really needs correcting, contact support.)
• Slug: the URL-friendly identifier, generated from the name. It becomes part of your listing's address (apihiver.com/apis/<slug>) and your gateway address (https://<slug>.p.apihiver.com).
• Category: where your API appears in the marketplace.
• Owner: your personal account, or one of your organizations.
• Short description: one line that sums up what the API does. It's shown on cards and in search.
• Description: a longer pitch, with Markdown supported.

Click Create API. The API starts as a private Draft; nobody else can see it until you publish.

The General tab

Branding

Upload a logo. A square image of at least 512 × 512 pixels looks best. It appears on your listing and on every card in the marketplace.

Basics

• Category: change it at any time.
• Visibility:
  • Public: listed in the marketplace and search.
  • Unlisted: reachable by direct link only, not listed.
  • Private: hidden, visible to you only.

Listing details

Refine the short description (a counter shows the length limit) and the description. Use the description to answer: what does the API do, what do you get, and who is it for?

Gateway

The Base URL is where the gateway sends traffic, for example https://api.example.com or http://203.0.113.10:8080/v1. Endpoint paths are added to it, so a base URL of http://host:8080/v1 and an endpoint path of /weather sends calls to http://host:8080/v1/weather. It's required before you can publish. See Gateway and security.

Links & legal

Optional, but they build trust: your website, a contact email, and links to your terms of use and privacy policy. They appear under Resources on your listing.

Spotlights

Spotlights are featured cards near the top of your public Overview: a link to an article or video, or an uploaded image, each with a title and description. Use them for tutorials, demos or announcements. Toggle Published to show or hide each one.

Listing completeness and preview

The panel on the right tracks what's still missing before you can publish (category, short description, base URL, at least one endpoint, and documentation) and previews your marketplace card.