Skip to main content
POST
Query a namespace

Authorizations

Authorization
string
header
required

An API key from conare.ai/console/keys. It can read and write every namespace in its organization.

Path Parameters

namespace
string
required

The namespace name. 1-64 characters of a-z 0-9 _ -, starting with a letter or digit.

Pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
Examples:

"docs"

"user-42"

Body

application/json
query
string
required

What to search for, in plain language.

Minimum string length: 1
top_k
integer
default:10

How many results to return.

Required range: 1 <= x <= 100
filter
object

A metadata filter. {"key": value} means equals. Operators: $eq $ne $gt $gte $lt $lte $in $nin. Combine filters with $and and $or arrays.

Examples:
rerank
boolean
default:true

Rerank the candidates with the reranking model.

Response

Results, best first.

results
object[]
required
took_ms
integer
required

Time spent in Conare, in milliseconds.