The Open API specification for Synapse is now available for download!

Download Open API Spec

SearchAutocompleteRequest

org.sagebionetworks.repo.model.search.table.SearchAutocompleteRequest

Synchronous, type-ahead-only request for the POST /search/autocomplete endpoint. See that endpoint for the autocomplete-vs-async tradeoffs and the allowed inner-clause shapes.

Field Type Description
searchIndexId STRING The ID of the SearchIndex entity to query.
searchQuery SearchAutocompleteBody

Body of an autocomplete request — the OpenSearch _search shape narrowed to the type-ahead subset. The autocomplete endpoint allowlists only query and _source; pagination, sort, aggregations, suggesters, and highlight are not accepted. See the autocomplete REST endpoint for the allowed inner-clause shapes and field-reference rules.