Skip to main content
POST
/
store
/
items
/
search
Search or list items within a namespace prefix.
curl --request POST \
  --url https://api.example.com/store/items/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "namespace_prefix": [
    "<string>"
  ],
  "filter": {},
  "limit": 10,
  "offset": 0,
  "query": "<string>",
  "refresh_ttl": null
}
'
import requests

url = "https://api.example.com/store/items/search"

payload = {
    "namespace_prefix": ["<string>"],
    "filter": {},
    "limit": 10,
    "offset": 0,
    "query": "<string>",
    "refresh_ttl": None
}
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({
    namespace_prefix: ['<string>'],
    filter: {},
    limit: 10,
    offset: 0,
    query: '<string>',
    refresh_ttl: null
  })
};

fetch('https://api.example.com/store/items/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.example.com/store/items/search",
  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([
    'namespace_prefix' => [
        '<string>'
    ],
    'filter' => [
        
    ],
    'limit' => 10,
    'offset' => 0,
    'query' => '<string>',
    'refresh_ttl' => null
  ]),
  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/store/items/search"

	payload := strings.NewReader("{\n  \"namespace_prefix\": [\n    \"<string>\"\n  ],\n  \"filter\": {},\n  \"limit\": 10,\n  \"offset\": 0,\n  \"query\": \"<string>\",\n  \"refresh_ttl\": null\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/store/items/search")
  .header("Content-Type", "application/json")
  .body("{\n  \"namespace_prefix\": [\n    \"<string>\"\n  ],\n  \"filter\": {},\n  \"limit\": 10,\n  \"offset\": 0,\n  \"query\": \"<string>\",\n  \"refresh_ttl\": null\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/store/items/search")

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  \"namespace_prefix\": [\n    \"<string>\"\n  ],\n  \"filter\": {},\n  \"limit\": 10,\n  \"offset\": 0,\n  \"query\": \"<string>\",\n  \"refresh_ttl\": null\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "namespace": [
        "<string>"
      ],
      "key": "<string>",
      "value": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}
{
  "detail": "<string>"
}

Body

application/json

Request to list or search for items within a namespace prefix. Without a query, lists items by last updated time. With a query, performs natural language search.

namespace_prefix
string[] | null

List of strings representing the namespace prefix.

filter
Filter · object | null

Optional dictionary of key-value pairs to filter results.

limit
integer
default:10

Maximum number of items to return (default is 10).

offset
integer
default:0

Number of items to skip before returning results (default is 0).

query
string | null

Optional natural language search query. If not provided, items are returned ordered by last updated time (listing mode). If provided, performs a natural language search over item contents.

refresh_ttl
boolean | null

Whether to refresh the TTL on items returned by this search. If null, uses the store's default behavior.

Response

Success

items
object[]
required