Traverse

curl --request GET \
  --url https://api.example.com/index/{index_name}/traverse \
  --header 'X-API-Key: <api-key>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

index

{index_name}

traverse

Traverse

curl --request GET \
  --url https://api.example.com/index/{index_name}/traverse \
  --header 'X-API-Key: <api-key>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

X-API-Key

string

header

required

query

string

required

The search query

Successful Response

Documentation Index