SearchAPI Documentation
Everything you need to build, manage, and integrate your search APIs — all in one place.
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.
How It Works
Follow these steps to go from zero to a live, documented REST API:
API Subdomain
an API
Models
Fields
Endpoints
API Key
API
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 API you build instantly gets 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.
Onboard Steps
Follow these steps to create your API:
-
Create an account
Sign up and log in to the SearchAPI dashboard.
-
Add an Elasticsearch Cluster
Connect your Elasticsearch cluster or use a SearchAPI-hosted one.
-
Add a 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.
-
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 and start making requests.
-
Deploy Your API
Deploy your API version to make it live and create the Elasticsearch index.