Query suggestions (typeahead)
Suggestion service for autocomplete-style queries. Path matches search, but use the dedicated suggest host.
API overview
| Method | POST |
|---|---|
| Path | /1/indexes/{indexName}/query |
| Base URL example | https://suggest.prophetes.ai |
| Full URL example |
https://suggest.prophetes.ai/1/indexes/{indexName}/query
|
Demo Download
Download our official Demos to quickly integrate Insight Search into your application:
Python Demo
Uses standard library urllib with no additional dependencies
Download Demo
Java Demo
Uses java.net.http.HttpClient with no third-party dependencies
Download Demo
Authentication
| Header | Description |
|---|---|
x-insight-application-id |
Application ID |
x-insight-api-key |
API Key |
Content-Type |
application/json |
Request body format
{
"query": "so",
"params": "hitsPerPage=10"
}Request parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query |
string | No | "" |
Search keyword |
params |
string | No | "" |
Extra controls as a query string |
Response structure
Returns hits suggestion entries plus metadata such as
nbHits, page, hitsPerPage, and
processingTimeMS. Each hit may include query,
objectID, nbWords, popularity,
and _highlightResult.
Example
curl -X POST "https://suggest.prophetes.ai/1/indexes/INSIGHT_INDEX_NAME/query" \
-H "x-insight-application-id: YOUR_APPLICATION_ID" \
-H "x-insight-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"so","params":"hitsPerPage=10"}'