Create an API

An API groups the endpoints that expose your models to the outside world.

What is an API?

In SearchAPI, an API is the top-level container for your endpoints. It has a name and a path — the path becomes part of every URL your consumers will call:

yoursubdomain.searchapi.net / your-api-path

Prerequisites

Create an API

  1. In the sidebar, click APIs.
  2. Click the + New API button.
  3. Fill in the form:
    • Name — a display name for your API (max 250 bytes)
    • Path — the URL path segment for this API (see rules below)
    • Elasticsearch Cluster — SearchAPI's hosted Elasticsearch is used by default; toggle Use your own cluster to connect your own cluster

    Clusters can be added or edited directly from this form. For detailed setup, see Elasticsearch cluster.

    New API form screenshot New API form
  4. Click Save.

Result: the API is created and version v1 is automatically created for it. For more information on how versions work, see API versioning.

Manage APIs

All your APIs are listed on the APIs page. From there you can:

  • Edit — update the name or path of an API
  • View versions — see all published and draft versions
  • View endpoints — jump directly to the endpoint list for this API
  • Delete — remove an API; deleted APIs can be recovered within 30 days
API list screenshot API list

Recover a deleted API

A deleted API stays on the APIs page with a countdown that shows how many days are left to recover it.

Important: A deleted API can be recovered within 30 days. After that, it no longer appears on the APIs page and cannot be recovered.
  1. In the sidebar, click APIs.
  2. On the deleted API's row, click the Recover API button.
  3. In the confirmation dialog, click Yes, Recover It!.

Result: the API is restored together with its versions, endpoints and API key assignments.

Reference

Path rules

The API path must follow these rules:

  • Only a–z, 0–9, - and _ are allowed
  • Must start with a lowercase letter or number
  • Cannot consist of only numbers
  • An optional leading / is accepted
  • Maximum 80 bytes

Locking

Important: Once at least one version of an API is published, the API is locked — its name and path can no longer be edited. To make changes you would need to delete the API and create a new one.

Last updated: October 30, 2026