← All features
Full Control via REST

# Building Search API

When the JS widget isn't enough, the Keyspider REST API gives you complete control. Query the index, retrieve results with full metadata, build custom result templates, and wire search into any application or platform — with no constraints on how results are displayed or used.

Request a demo
See AI Search platform
RESTful API with JSON responses — integrates with any tech stack
Full query parameter support: pagination, filtering, faceting, boosting
Retrieve titles, URLs, descriptions, custom fields, and relevance scores
Autocomplete and suggestion endpoints for real-time search-as-you-type
Authentication via API key — simple and secure
Detailed API documentation with code examples in multiple languages

## How it works

1

### Get your API key

From the Keyspider admin console, generate an API key scoped to your collection. Keys can be restricted by domain or IP for additional security.

2

### Make a search request

Send a GET or POST request to the search endpoint with your query and parameters. The API returns a structured JSON response with all result fields and metadata.

3

### Build your interface

Consume the response however your application needs. Build a fully custom UI, pipe results into an existing component library, or feed search data into a third-party system.

## Use cases

### Custom search interfaces

Design a results page that matches your brand and UX system exactly — without being constrained by widget templates. Every pixel is yours to control.

### Headless and composable architectures

In a headless CMS or composable DXP, the search API is a first-class content service. Query and display search results anywhere in your stack.

### Mobile applications

Native iOS and Android apps can call the Keyspider search API directly — delivering full-featured search to mobile users without a web dependency.

## Related

Install with JS Library
Highly Customizable API
Low Code Platform

## Ready to give your users better answers?

AI Search, AI Assistant, and Workplace Search. Deployed in days, not months. See it live on your own content.

Book a Demo Talk to Sales

No credit card required · Live in 2 weeks · Cancel anytime