curl --request POST \
--url https://api.conare.ai/namespaces/{namespace}/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "how do refunds work?",
"top_k": 5,
"filter": {
"team": "support"
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: 'how do refunds work?', top_k: 5, filter: {team: 'support'}})
};
fetch('https://api.conare.ai/namespaces/{namespace}/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.conare.ai/namespaces/{namespace}/query"
payload = {
"query": "how do refunds work?",
"top_k": 5,
"filter": { "team": "support" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"results": [
{
"id": "refunds",
"text": "Refunds are available for 30 days after purchase.",
"score": 0.91,
"reranked": true,
"metadata": {
"team": "support"
}
}
],
"took_ms": 42
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}Query a namespace
Hybrid search over one namespace, reranked: one result per document, its text the passages of it that answer.
- The body is at most 4 MiB (4,194,304 bytes).
- To page, set
max_resultsabovetop_k, then send{"cursor": next_cursor}until nonext_cursorcomes back. - Pages come from one ranking kept 15 minutes; the search counts as one query, its pages as none.
curl --request POST \
--url https://api.conare.ai/namespaces/{namespace}/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "how do refunds work?",
"top_k": 5,
"filter": {
"team": "support"
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: 'how do refunds work?', top_k: 5, filter: {team: 'support'}})
};
fetch('https://api.conare.ai/namespaces/{namespace}/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.conare.ai/namespaces/{namespace}/query"
payload = {
"query": "how do refunds work?",
"top_k": 5,
"filter": { "team": "support" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"results": [
{
"id": "refunds",
"text": "Refunds are available for 30 days after purchase.",
"score": 0.91,
"reranked": true,
"metadata": {
"team": "support"
}
}
],
"took_ms": 42
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
}
}التفويضات
A key from conare.ai/dashboard/keys with full access, some namespaces, or models only (/embed, /rerank, /v1, /v2/rerank, /parse).
معلمات المسار
The namespace name.
1-64 characters of a-z 0-9 _ -, starting with a letter or digit.
^[a-z0-9][a-z0-9_-]{0,63}$"docs"
"user-42"
الجسم
What to search for, in plain language; required unless cursor is set.
1 - 8000How many results to return; with cursor, the page size.
1 <= x <= 500Rank this many documents and return them top_k at a time; at most 1,000 (5,000 on a custom model's engine).
1 <= x <= 5000A previous page's next_cursor; only top_k may be sent beside it.
Documents no result may be (e.g. ones already seen); a long list can return fewer results.
100001-256 characters of A-Z a-z 0-9 . _ : -, starting with a letter or digit.
^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}${"key": value} matches equal values (or arrays holding it); $eq, $ne, $in, $nin, $gt, $gte, $lt and $lte compare, $and and $or combine.
- A filter holds at most 256 conditions (each value,
$initem, range and join counts one), else 400invalid_filter. - Ranges compare numbers with numbers and strings by UTF-8 bytes: write dates alike (
2025-06-01) to sort them. $neand$ninwork in queries, not deletes, and match documents without the key.
Show child attributes
Show child attributes
{ "team": "support" }
{
"$or": [
{ "team": "support" },
{ "year": { "$in": [2024, 2025] } }
]
}
{ "year": { "$gte": 2020, "$lt": 2025 } }
{ "published_at": { "$gte": "2025-06-01" } }
{ "company": { "$nin": ["acme", "globex"] } }
Rerank the candidates with the reranking model.
How many top passages to rerank (default 100).
1 <= x <= 10002: the best two results seed a second search, for answers that span documents; needs rerank, adds about 0.3 s.
1 <= x <= 2Which retrievers to fuse: vector (embeddings) and keyword (BM25); one the namespace can't run is 400.
1 - 2 elementsvector, keyword Only this user's documents. Combines with filter and user_prefix.
^[A-Za-z0-9][A-Za-z0-9._:@-]{0,127}$"tenant-7:u_42"
Only the documents of users starting with this; it ends in :, e.g. tenant-7:.
^[A-Za-z0-9][A-Za-z0-9._:@-]{0,127}$"tenant-7:"
Also answer query in prose; a language model writes the answer from the best passages, adding about 2 s.
الاستجابة
Results, best first.
هل كانت هذه الصفحة مفيدة؟