Skip to main content
GET
/
storage
/
kv
/
{bucket}
/
search
Search KV entries
curl --request GET \
  --url https://api.quiva.ai/storage/kv/{bucket}/search \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.quiva.ai/storage/kv/{bucket}/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.quiva.ai/storage/kv/{bucket}/search', 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.quiva.ai/storage/kv/{bucket}/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.quiva.ai/storage/kv/{bucket}/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.quiva.ai/storage/kv/{bucket}/search")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.quiva.ai/storage/kv/{bucket}/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "body": {
    "results": [
      {
        "key": "user123",
        "value": {
          "name": "John Doe",
          "age": 30
        }
      }
    ],
    "results_total": 1
  },
  "metadata": {
    "bucket": "my-bucket",
    "field": "name",
    "search": "John",
    "index_duration": "3ms",
    "index_hits": 1
  }
}
{
  "error": "validation_error"
}
{
  "error": "unauthorized"
}
{
  "error": "not_found"
}
{
  "error": "internal_error"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
bucket
string
required

Name of the bucket

Query Parameters

​
field
string
required

Field to search in

​
search
string
required

Search term

​
search_type
enum<string>

Type of search to perform

Available options:
exact,
fuzzy,
prefix,
range
​
min
number

Minimum value for range searches

​
max
number

Maximum value for range searches

​
limit
integer
default:10

Maximum number of results to return

Required range: 1 <= x <= 1000

Response

Search results

​
body
object
​
metadata
object