Query a namespace
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"
}
}
'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)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));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.conare.ai/namespaces/{namespace}/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => 'how do refunds work?',
'top_k' => 5,
'filter' => [
'team' => 'support'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.conare.ai/namespaces/{namespace}/query"
payload := strings.NewReader("{\n \"query\": \"how do refunds work?\",\n \"top_k\": 5,\n \"filter\": {\n \"team\": \"support\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.conare.ai/namespaces/{namespace}/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"how do refunds work?\",\n \"top_k\": 5,\n \"filter\": {\n \"team\": \"support\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conare.ai/namespaces/{namespace}/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"how do refunds work?\",\n \"top_k\": 5,\n \"filter\": {\n \"team\": \"support\"\n }\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "refunds",
"text": "Refunds are available for 30 days after purchase.",
"score": 0.91,
"metadata": {
"team": "support"
}
}
],
"took_ms": 42
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "req_8f3a2c"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "req_8f3a2c"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "req_8f3a2c"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "req_8f3a2c"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "req_8f3a2c"
}
}Query
Query a namespace
Hybrid search (vector and keyword) over one namespace, optionally filtered by metadata, reranked. Returns one result per document: its best matching passage.
POST
/
namespaces
/
{namespace}
/
query
Query a namespace
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"
}
}
'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)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));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.conare.ai/namespaces/{namespace}/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => 'how do refunds work?',
'top_k' => 5,
'filter' => [
'team' => 'support'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.conare.ai/namespaces/{namespace}/query"
payload := strings.NewReader("{\n \"query\": \"how do refunds work?\",\n \"top_k\": 5,\n \"filter\": {\n \"team\": \"support\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.conare.ai/namespaces/{namespace}/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"how do refunds work?\",\n \"top_k\": 5,\n \"filter\": {\n \"team\": \"support\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conare.ai/namespaces/{namespace}/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"how do refunds work?\",\n \"top_k\": 5,\n \"filter\": {\n \"team\": \"support\"\n }\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "refunds",
"text": "Refunds are available for 30 days after purchase.",
"score": 0.91,
"metadata": {
"team": "support"
}
}
],
"took_ms": 42
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "req_8f3a2c"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "req_8f3a2c"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "req_8f3a2c"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "req_8f3a2c"
}
}{
"error": {
"code": "invalid_request",
"message": "text is required",
"request_id": "req_8f3a2c"
}
}Authorizations
An API key from conare.ai/console/keys. It can read and write every namespace in its organization.
Path Parameters
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
What to search for, in plain language.
Minimum string length:
1How many results to return.
Required range:
1 <= x <= 100A metadata filter. {"key": value} means equals. Operators: $eq $ne $gt $gte $lt $lte $in $nin. Combine filters with $and and $or arrays.
Show child attributes
Show child attributes
Examples:
{ "team": "support" }
{
"$or": [
{ "team": "support" },
{ "year": { "$gte": 2024 } }
]
}
Rerank the candidates with the reranking model.