Query Data
curl --request POST \
--url https://api.example.com/query \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"topK": 123
}
'import requests
url = "https://api.example.com/query"
payload = {
"query": "<string>",
"topK": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({query: '<string>', topK: 123})
};
fetch('https://api.example.com/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.example.com/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' => '<string>',
'topK' => 123
]),
CURLOPT_HTTPHEADER => [
"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.example.com/query"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"topK\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/query")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"topK\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"topK\": 123\n}"
response = http.request(request)
puts response.read_body{
"query": "<string>",
"hits": [
{
"id": "<string>",
"score": 123,
"text": "<string>",
"title": "<string>"
}
]
}Querying
Query Data
Retrieve relevant document chunks based on a query.
POST
/
query
Query Data
curl --request POST \
--url https://api.example.com/query \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"topK": 123
}
'import requests
url = "https://api.example.com/query"
payload = {
"query": "<string>",
"topK": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({query: '<string>', topK: 123})
};
fetch('https://api.example.com/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.example.com/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' => '<string>',
'topK' => 123
]),
CURLOPT_HTTPHEADER => [
"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.example.com/query"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"topK\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/query")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"topK\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"topK\": 123\n}"
response = http.request(request)
puts response.read_body{
"query": "<string>",
"hits": [
{
"id": "<string>",
"score": 123,
"text": "<string>",
"title": "<string>"
}
]
}Body
string
required
The question or text you want to find matches for in the vector store.
number
The maximum number of chunks to return. Defaults to
5.Response
string
The original query.
array
Example Request
{
"query": "How do I configure the RAG server?",
"topK": 3
}
Example Response
{
"query": "How do I configure the RAG server?",
"hits": [
{
"id": "chunk-123",
"score": 0.89,
"text": "The RAG server is configured via the .ragtoolkit workspace...",
"title": "Server Manual"
}
]
}
⌘I

