Skip to main content
GET
/
storage
/
search
/
{index}
Search an index
curl --request GET \
  --url https://api.quiva.ai/storage/search/{index} \
  --header 'Authorization: Bearer <token>'
{
  "body": {
    "results": [
      {
        "id": "1",
        "fields": {
          "name": "John Doe",
          "age": 30
        },
        "score": 0.95
      }
    ],
    "results_total": 1
  },
  "metadata": {
    "field": "name",
    "search": "John",
    "index_duration": "3ms",
    "index_hits": 1
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

index
string
required

Name of the index to search

Query Parameters

field
string
required

Field to search in

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
sortBy
string

Field to sort results by

Response

Search results

body
object
metadata
object