search mobile facets autocomplete spellcheck crawler rankings weights synonyms analytics engage api customize documentation install setup technology content domains user history info home business cart chart contact email activate analyticsalt analytics autocomplete cart contact content crawling custom documentation domains email engage faceted history info install mobile person querybuilder search setup spellcheck synonyms weights engage_search_term engage_related_content engage_next_results engage_personalized_results engage_recent_results success add arrow-down arrow-left arrow-right arrow-up caret-down caret-left caret-right caret-up check close content conversions-small conversions details edit grid help small-info error live magento minus move photo pin plus preview refresh search settings small-home stat subtract text trash unpin wordpress x alert case_deflection
Swiftype Documentation / api: Autocomplete

Autocomplete

The Autocomplete endpoint supports the same options as the search endpoint, but performs prefix matches on fields rather than token matching. See the Searching documentation for details on search options.

Note: The search-related API endpoints accept both the GET and POST verbs in order to accommodate HTTP clients that do not allow request bodies to be sent with GET requests. If your client will not send a request body on GET, then simply POST the request instead and the API will respond identically.

Autocomplete within an Engine (across all Document_types)

GET /api/v1/engines/{engine_id}/suggest.json?q={query}
POST /api/v1/engines/{engine_id}/suggest.json

Autocomplete within a Document_Type

GET /api/v1/engines/{engine_id}/document_types/{document_type_id}/documents/suggest.json?q={query}
POST /api/v1/engines/{engine_id}/document_types/{document_type_id}/documents/suggest.json

Example - Get autocomplete suggestions from the bookstore Engine for the prefix query "act"
curl -X GET 'https://api.swiftype.com/api/v1/engines/bookstore/suggest?q=act&auth_token=YOUR_API_KEY'
  
Example - Get autocomplete suggestions from the books DocumentType for the prefix query "act"
curl -X GET 'https://api.swiftype.com/api/v1/engines/bookstore/document_types/books/suggest?q=action&auth_token=YOUR_API_KEY'