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
}
'
{
  "items": [
    {
      "namespace": [
        "<string>"
      ],
      "key": "<string>",
      "value": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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

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