Index Documents

Endpoint

POST https://api-indexly.ripplefy.net/model/index

Payload

Parameter	Type	Description
data	array	An array of documents matching the index schema.

Example

curl --location 'https://api-indexly.ripplefy.net/model/index' \
--header 'Content-Type: application/json' \
--data '{
  "data": [
    {
      "id": "{id}",
      "name": "{name}",
      other fields...
    },
    ...
  ]
}'

Search Documents

Endpoint

POST https://api-indexly.ripplefy.net/index/{index_name}/search

Payload

Parameter	Type	Description
query	object	JSON object with search criteria.
sort	array	Sort criteria for search results.
limit	number	Maximum number of search results to return.
fields	array	Fields to be returned in the search results.
next_cursor	string	Cursor for pagination.

Example

curl --location 'https://api-indexly.ripplefy.net/index/{index_name}/search' \
--header 'Content-Type: application/json' \
--data '{
  "query": {
    "name": ["{name1}", "{name2}"],
    ...
  },
  "sort": [{"created_at": "desc"}],
  ...
}'

Metrics and Aggregation Request Endpoint

URL: /index/{index_name}/search HTTP Method: POST Headers: Content-Type: application/json Payload

Parameter Type Description query object JSON object with search criteria. sort array Sort criteria for search results. aggregate object Aggregation metrics for certain fields. Response Returns a 200 OK with metrics and aggregated data.

Example cURL Command

bash Copy code curl --location 'http://localhost:8080/index/nfts/search' \ --header 'Content-Type: application/json' \ --data '{ "query": { "Name": ["CryptoArt", "SuperRare NFT"], ... }, "sort": [{"Name": "asc"}, {"Price": "desc"}], "aggregate": { "Price": ["avg", "min", "max", "count"], ... }, ... }'