v16

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-032765158.3 KB
Queries

Top Pages

Get the top K pages that match the given query

post/queries/top-pages

Request body

collection_namestring required

The name of the collection.

querystring required

The natural language query to search with. This cannot exceed 4096 UTF-8 bytes.

kinteger required

The number of pages to return. If there are not enough pages matching your filters, then fewer may be returned. This number must be between 1 and 1024, inclusive.

filterStrJson
include_contentboolean

If set to true, then the content of all pages will be returned.

include_metadataboolean

Whether or not to include the document metadata in the response. If not provided, then the default will be False.

latency_mode'low' | 'high'

This option selects between our two latency modes. The higher latency mode takes longer, but can allow for more accurate responses. If desired, test both to customize your search experience for your particular use-case, or use the default of "low" and only swap if you need an additional improvement in search result quality.

Response

Successful Response