API Reference
Reference docs for the SuggestAPI platform.
Full interactive docs are on the roadmap. For now, this page outlines the initial API surface, the kinds of endpoints private beta users can expect, and the developer resources planned for launch.
Planned endpoints
GET /v1/predict
Returns ranked suggestions based on lexical and semantic intent signals.
POST /v1/indexes
Creates and configures a search index for your project data.
POST /v1/events/click
Captures first-party engagement events used for relevance tuning and analytics.
What private beta includes
- Authentication and environment setup guidance
- Request and response examples
- Rate limit and quota details
- Integration support for early customers
Reference scope
The SuggestAPI API reference will cover authentication, request structure, response formats, indexing workflows, relevance events, and integration guidance for customer applications. It is being designed to support developer teams that need fast search suggestions, intent-aware query handling, and practical examples for implementation.
As the product moves through private beta, this page will expand into a fuller reference hub with endpoint details, parameter documentation, sample payloads, error responses, and usage guidance for production-ready integrations.
The goal is to make the reference useful both for technical evaluators comparing search infrastructure options and for engineering teams that want a clear implementation path from first request to full production rollout.