Vertical Autocomplete
AI-generatedSummary
Fetch autocompletion suggestions for a specified vertical in a Yext Answers search experience using a partial user input term.
Inputs
- Account Id (required) — The identification string of the Yext account.
- V (required) — The API version date in YYYYMMDD format.
- Experience Key (required) — The unique string key identifying the Search experience.
- Vertical Key (required) — The unique string key identifying the vertical to search within.
- Locale (required) — The locale code of the experience, e.g., 'en_GB'.
- Input — The partial search term input from the user for which autocomplete suggestions are fetched.
- Version — Optional label or version number of the experience configuration to use; either 'STAGING' for the latest or 'PRODUCTION' as default.
Output shape
a single response object containing autocomplete suggestion results from the Yext Answers API
The results correspond to the partial input filtered by specified keys and locale. The response structure follows the Yext Answers API schema for vertical autocomplete requests. Optional request parameters (e.g., Version) affect which configuration is used but do not alter the output shape.