Algolia Multi-Query

POST

https://acme.captain.dev/1/indexes/*/queries

POST

/1/indexes/*/queries

import json
import requests
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_search_key"
headers = {
    "x-algolia-api-key": API_KEY,
    "x-algolia-application-id": "acme",
    "Content-Type": "application/json",
}
response = requests.post(
    f"{BASE_URL}/1/indexes/*/queries",
    headers=headers,
    json={
        "requests": [
            {"indexName": "products", "params": "query=hiking%20boots&hitsPerPage=2"},
        ],
    },
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

200Successful

{
  "results": [
    {
      "hits": [
        {
          "objectID": "sku-10482",
          "_highlightResult": {
            "title": {
              "value": "Moab 3 Mid Waterproof <em>Hiking</em> <em>Boot</em>",
              "matchLevel": "full",
              "matchedWords": [
                "hiking",
                "boots"
              ],
              "fullyHighlighted": false
            }
          },
          "title": "Moab 3 Mid Waterproof Hiking Boot",
          "brand": "Merrell",
          "category": "Hiking Boots",
          "price": 139
        },
        {
          "objectID": "sku-10517",
          "_highlightResult": {
            "title": {
              "value": "X Ultra 4 Mid GTX <em>Hiking</em> <em>Boot</em>",
              "matchLevel": "full",
              "matchedWords": [
                "hiking",
                "boots"
              ],
              "fullyHighlighted": false
            }
          },
          "title": "X Ultra 4 Mid GTX Hiking Boot",
          "brand": "Salomon",
          "category": "Hiking Boots",
          "price": 165
        }
      ],
      "nbHits": 42,
      "page": 0,
      "hitsPerPage": 2,
      "nbPages": 21,
      "exhaustiveNbHits": true,
      "exhaustiveFacetsCount": true,
      "exhaustive": {
        "nbHits": true,
        "facetsCount": true
      },
      "facets": {},
      "query": "hiking boots",
      "params": "query=hiking%20boots&hitsPerPage=2",
      "index": "products",
      "processingTimeMS": 14,
      "queryID": "c97e0b2a4f6d41e3a58b1c7d2e9f0a36",
      "renderingContent": {}
    }
  ]
}

Algolia’s multi-query endpoint, answered from the Captain index of the same name.

Authentication

x-algolia-api-keystring

A Captain key, as Algolia clients send it: a search key for queries, a write key for writes.

x-algolia-application-idstring

Any value; the hostname selects the tenant.

Request

This endpoint expects an object.

requestslist of objectsOptional

Response

one result per query

resultslist of objectsOptional