Algolia single query | Captain Docs

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

{
  "hits": [
    {
      "objectID": "sku-20311",
      "_highlightResult": {
        "title": {
          "value": "Torrentshell 3L <em>Rain</em> <em>Jacket</em>",
          "matchLevel": "full",
          "matchedWords": [
            "rain",
            "jacket"
          ],
          "fullyHighlighted": false
        }
      },
      "title": "Torrentshell 3L Rain Jacket",
      "brand": "Patagonia",
      "category": "Rain Jackets",
      "price": 179
    }
  ],
  "nbHits": 18,
  "page": 0,
  "hitsPerPage": 1,
  "nbPages": 18,
  "exhaustiveNbHits": true,
  "exhaustiveFacetsCount": true,
  "exhaustive": {
    "nbHits": true,
    "facetsCount": true
  },
  "facets": {},
  "query": "rain jacket",
  "params": "query=rain%20jacket&hitsPerPage=1",
  "index": "products",
  "processingTimeMS": 11,
  "queryID": "4b8d2f0e6a1c43b79e5d3a2c8f7b6e10",
  "renderingContent": {}
}

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

Authentication

x-algolia-api-keystring

A search key issued by Captain, as Algolia clients send it.

x-algolia-application-idstring

Any value; the hostname selects the tenant.

Path parameters

indexstringRequired

Request

This endpoint expects an object.

paramsstringOptional

Response

the query's result

hitslist of objectsOptional

nbHitsintegerOptional

pageintegerOptional

hitsPerPageintegerOptional

nbPagesintegerOptional

exhaustiveNbHitsbooleanOptional

exhaustiveFacetsCountbooleanOptional

exhaustiveobjectOptional

facetsobjectOptional

facets_statsobjectOptional

querystringOptional

paramsstringOptional

indexstringOptional

processingTimeMSintegerOptional

queryIDstringOptional

send it back on Insights events for this search

renderingContentobjectOptional

captainobjectOptional

Captain’s own details: mode, engine_ms and the like