Vtex Intelligent Search API
Browse all Vtex APIs62
AI ReadinessAI-Aware (B-)62/100
HR recruitingOnboardingnone7 EndpointsREST
For Agents
Programmatically get list of the 10 most searched terms, get list of suggested terms and attributes similar to the search term. Covers 7 operations.
Use for: I need to list of the 10 most searched terms, I want to list of suggested terms and attributes similar to the search term, Search for attempt of correction of a misspelled term, Find all list of banners registered for query
Not supported: Does not handle payments, communications, or crm - use for hr and recruiting only.
>ℹ️ Onboarding guide > > Check the new [Search onboarding guide](https://developers.vtex.com/docs/guides/search-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Search and is organized by focusing on the developer's journey. [VTEX Intelligent Search](https://help.vtex.com/en/tracks/vtex-intell. The API exposes 7 endpoints.
Install Jentic One Beta
Connect the Intelligent Search API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Intelligent Search API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvtex.local%2Fintelligent-search-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvtex.local%2Fintelligent-search-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Intelligent Search API.
Get list of the 10 most searched terms
Manage hr recruiting data programmatically
Integrate Intelligent Search API into automated workflows
Query and filter Intelligent Search API records by parameters
Monitor Intelligent Search API operational status and events
Use Cases
Patterns agents use Intelligent Search API for, with concrete tasks.
★ HR and Recruiting Operations
Use the Intelligent Search API to perform hr recruiting operations programmatically. The API provides 7 endpoints covering core functionality including get list of the 10 most searched terms, get list of suggested terms and attributes similar to the search term, get attempt of correction of a misspelled term.
Call GET /top_searches to get list of the 10 most searched terms
Automated Autocomplete Management
Automate autocomplete operations by combining multiple Intelligent Search API endpoints. Agents can get list of suggested terms and attributes similar to the search term and then get attempt of correction of a misspelled term in a single workflow.
Call GET /autocomplete_suggestions to get list of suggested terms and attributes similar to the search term, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Intelligent Search API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.
Search Jentic for 'get list of the 10 most searched terms', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
7 endpoints — >ℹ️ onboarding guide > > check the new [search onboarding guide](https://developers.
METHOD
PATH
DESCRIPTION
GET
/top_searches
Get list of the 10 most searched terms
GET
/autocomplete_suggestions
Get list of suggested terms and attributes similar to the search term
GET
/correction_search
Get attempt of correction of a misspelled term
GET
/banners/{facets}
Get list of banners registered for query
GET
/search_suggestions
Get list of suggested terms similar to the search term
GET
/product_search/{facets}
Get list of products for a query
GET
/facets/{facets}
Get list of the possible facets for a given query
GET
/top_searches
Get list of the 10 most searched terms
GET
/autocomplete_suggestions
Get list of suggested terms and attributes similar to the search term
GET
/correction_search
Get attempt of correction of a misspelled term
GET
/banners/{facets}
Get list of banners registered for query
GET
/search_suggestions
Get list of suggested terms similar to the search term
GET
/product_search/{facets}
Get list of products for a query
GET
/facets/{facets}
Get list of the possible facets for a given query
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
I
Intelligent Search API
- AI-Aware (B-)62/100
99
Foundational Compliance58
Developer Experience & Jentic Compatibility36
AI-Readiness & Agent Experience94
Agent Usability100
Security77
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
99
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
58
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: C+Signals: 4
5%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
29%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
36
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
93%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
100
Security
Trust, risk posture, and security compliance.
Grade: A+Signals: 1
100%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
77
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A-Signals: 1
77%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the VTEX Intelligent Search API by hand means templating the {accountName} and {environment} host with the intelligent-search path prefix and shaping each facet query yourself. Through Jentic you install once, import the Intelligent Search API from the API Directory, and your agent calls it.
Permission scoping
The Intelligent Search API targets each query through request parameters rather than a resource id in the path, so limit the agent to the operations it needs, such as autocomplete suggestions or product search. Every operation here reads search data, so no writes are possible.
Credential isolation
This Intelligent Search API endpoint set is public and needs no credential, so there is no secret for your agent to hold. Any configuration your Jentic One instance stores is kept encrypted and injected at execution time, never entering the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'get the top searched terms' or 'fetch autocomplete suggestions', and Jentic returns the matching Intelligent Search API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Intelligent Search API through Jentic.
What authentication does the Intelligent Search API use?
The Intelligent Search API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I get list of the 10 most searched terms with the Intelligent Search API?
Yes. Use the GET /top_searches endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Intelligent Search API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I get list of the 10 most searched terms through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get list of the 10 most searched terms'. Jentic returns the matching Intelligent Search API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Intelligent Search API have?
The Intelligent Search API exposes 7 endpoints covering autocomplete, product list page operations.
Can I limit what my agent is allowed to do with the Intelligent Search API?
Yes. Because you run Jentic One yourself, your own rules decide which of this API's operations the agent may call, so you can allow only what a task needs, such as GET /autocomplete_suggestions and GET /search_suggestions, while withholding GET /product_search/{facets} or GET /top_searches. Every operation here reads search data and targets each query through request parameters rather than a resource id in the path, so the agent can only retrieve results and can never write or delete. This lets the operator keep an agent scoped to exactly the search reads it is meant to perform.
GET STARTED