AI Search — API Reference

Powerful and configurable search, boosted by Synerise AI

56 endpoints across 8 tags.

Search

• GET /search/v2/indices/{indexId}/query — Full-text items search
• POST /search/v2/indices/{indexId}/query — Full-text items search
• GET /search/v2/indices/{indexId}/query/explain — Explained full-text items search
• POST /search/v2/indices/{indexId}/query/explain — Explained full-text items search
• GET /search/v2/indices/{indexId}/autocomplete — Autocomplete items search
• POST /search/v2/indices/{indexId}/autocomplete — Autocomplete items search
• GET /search/v2/indices/{indexId}/autocomplete/explain — Explained autocomplete items search
• POST /search/v2/indices/{indexId}/autocomplete/explain — Explained autocomplete items search
• GET /search/v2/indices/{indexId}/explain-match — Searchable attributes match
• GET /search/v2/indices/{indexId}/deleted-searches — Get deleted searches
• POST /search/v2/indices/{indexId}/deleted-searches — Soft-delete a recent search
• GET /search/v2/indices/{indexId}/recent-searches — Get recent searches

Visual Search

• GET /search/v2/indices/{indexId}/visual — Visual items search
• POST /search/v2/indices/{indexId}/visual — Visual items search
• GET /search/v2/indices/{indexId}/visual/explain — Explained visual items search
• POST /search/v2/indices/{indexId}/visual/explain — Explained visual items search

Listing

• GET /search/v2/indices/{indexId}/list — Items listing
• POST /search/v2/indices/{indexId}/list — Items listing
• GET /search/v2/indices/{indexId}/list/explain — Explained items listing
• POST /search/v2/indices/{indexId}/list/explain — Explained items listing

Synonyms

• GET /search/v2/indices/{indexId}/synonyms — Get synonyms
• POST /search/v2/indices/{indexId}/synonyms — Create synonym
• POST /search/v2/indices/{indexId}/synonyms/batch — Batch insert synonyms
• POST /search/v2/indices/{indexId}/synonyms/replace-all — Replace all synonyms
• GET /search/v2/indices/{indexId}/synonyms/{synonymId} — Get synonym
• PUT /search/v2/indices/{indexId}/synonyms/{synonymId} — Update synonym
• DELETE /search/v2/indices/{indexId}/synonyms/{synonymId} — Delete synonym

Search Configuration

• GET /search/v2/indices/{indexId}/attributes/filterable/values — Get values of filterable attributes
• GET /search/v2/indices — Get configurations of all indices
• POST /search/v2/indices — Post index configuration
• GET /search/v2/indices/{indexId}/config — Get index configuration
• PUT /search/v2/indices/{indexId}/config — Update index configuration
• DELETE /search/v2/indices/{indexId}/config — Delete index configuration
• GET /search/v2/indices/{indexId}/state — Get index state
• GET /search/v2/supported-languages — Get supported languages
• GET /search/v2/indices/{indexId}/duplicate — Duplicate index

Suggestions Configuration

• GET /search/v2/suggestion-indices — Get suggestion indices
• POST /search/v2/suggestion-indices — Create suggestion index
• GET /search/v2/suggestion-indices/{indexId}/config — Get suggestion index
• PUT /search/v2/suggestion-indices/{indexId}/config — Create/replace suggestion index
• DELETE /search/v2/suggestion-indices/{indexId}/config — Delete suggestion index
• GET /search/v2/suggestion-indices/{indexId}/state — Get suggestion index state

Query Rules

• GET /search/v2/indices/{indexId}/rules — Get rules
• POST /search/v2/indices/{indexId}/rules — Create rule
• GET /search/v2/indices/{indexId}/rules/{ruleId} — Get rule
• PUT /search/v2/indices/{indexId}/rules/{ruleId} — Update query rule
• DELETE /search/v2/indices/{indexId}/rules/{ruleId} — Delete rule
• POST /search/v2/indices/{indexId}/rules/{ruleId}/activate — Activate rule
• POST /search/v2/indices/{indexId}/rules/{ruleId}/pause — Pause rule
• POST /search/v2/indices/{indexId}/rules/{ruleId}/draft — Draft rule
• POST /search/v2/indices/{indexId}/rules/{ruleId}/finish — Finish rule

Search Stats

• GET /search/v2/indices/{indexId}/stats/queries/summary — Get queries stats summary
• GET /search/v2/indices/{indexId}/stats/queries/top — Get top query statistics
• GET /search/v2/indices/{indexId}/stats/filters/summary — Get filters stats
• GET /search/v2/indices/{indexId}/stats/rules/summary — Get rules stats
• GET /search/v2/indices/stats/queries/summary — Get queries summary for multiple indices

Back to all API categories