SearchAPI documentation

This documentation explains how to build, deploy and use REST APIs on Elasticsearch with SearchAPI.

What is SearchAPI?

SearchAPI is a no-code REST API builder on top of Elasticsearch. You connect an Elasticsearch cluster (your own or one hosted by SearchAPI), define data models and fields, configure endpoints, and SearchAPI generates a fully documented REST API — ready to integrate into any frontend or backend project.

Normally, querying Elasticsearch requires writing complex JSON queries by hand (called Query DSL). SearchAPI eliminates that — you define your data structure once, and SearchAPI handles all query generation, authentication, and API documentation automatically.

Who this documentation is for

This documentation is for workspace members who build and manage APIs in the SearchAPI dashboard, and for developers who call those APIs from their applications. Some pages require the Owner or Manager role; this is noted in each page's Prerequisites.

What does SearchAPI support?

Elasticsearch

Use your own Elasticsearch cluster or let SearchAPI host one for you. Both cloud and self-managed clusters are supported.

Auto-generated Swagger Docs

Every deployed API version can generate an OpenAPI (Swagger) document. Share it with your team or test it directly in the browser.

REST API Builder

Define models, fields, and endpoints with no code. SearchAPI generates and hosts the REST API for you automatically.

Navigate the dashboard

After logging in you'll see the main sidebar on the left. All pages are under Menu:

Dashboard, Models, APIs, Data UI, Data Import, Data Export
My Account (expandable) — Profile, API Keys, MCP Access, Subscription, Company, Elasticsearch Clusters, Team Members

Subscription, Company, Elasticsearch Clusters and Team Members are visible only to the Owner and Managers.

Quick start

Follow these steps to go from zero to a live, documented REST API.

Prerequisites

A SearchAPI account. See Account and registration.

Steps

Set up your subdomain
Set up your API subdomain before creating an API — this cannot be changed later.
Create your first API
Give it a name and a path. This becomes the base URL of your API.

SearchAPI's hosted Elasticsearch is used by default. To use your own cluster, toggle Use your own cluster in the form (see Elasticsearch cluster).
Define a model
A model maps to an Elasticsearch index. Add fields to describe your data.
Configure endpoints
Set up GET, POST, and other endpoints for your model.
Generate an API key
Secure your API with a key.
Deploy your API
Deploy your API version to make it live and create the Elasticsearch index.

Result

Your API is live and ready to receive search requests. To start making requests, see Using your API.

Last updated: October 30, 2026