Sign in

v1

latestOpenAPI 3.1.1MIT License2026-07-122354100.9 KB
Search

Search a namespace

Search a namespace for a query.

post/v1/namespace/{namespaceId}/search

Path parameters

namespaceIdstring required

The id of the namespace (prefixed with ns_)

Example:ns_123

The id of the namespace (prefixed with ns_)

Headers

x-tenant-idstring

Optional tenant id to use for the request. If not provided, the namespace will be used directly. Must be alphanumeric and up to 64 characters.

Optional tenant id to use for the request. If not provided, the namespace will be used directly. Must be alphanumeric and up to 64 characters.

Request body

querystring required

The query to search for.

topKnumber

The number of results to fetch from the vector store. Defaults to 10.

rerankboolean

Whether to rerank the results. Defaults to true.

rerankLimitnumber

The number of results to return after reranking. Defaults to topK.

rerankModel'cohere:rerank-v4.0-pro' | 'cohere:rerank-v4.0-fast' | 'cohere:rerank-v3.5' | 'cohere:rerank-english-v3.0' | 'cohere:rerank-multilingual-v3.0' | 'zeroentropy:zerank-2' | 'zeroentropy:zerank-1' | 'zeroentropy:zerank-1-small'

The reranking model to use.

filterobject

A filter to apply to the results.

minScorenumber

The minimum score to return.

includeRelationshipsboolean

Whether to include relationships in the results. Defaults to false.

includeMetadataboolean

Whether to include metadata in the results. Defaults to true.

keywordFilterstring
mode'semantic' | 'keyword'

Response

The retrieved namespace

successtrue required