Run Multiple Searches

POST

https://acme.captain.dev/v1/multi_search

POST

/v1/multi_search

import json
import requests
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_search_key"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json",
}
response = requests.post(
    f"{BASE_URL}/v1/multi_search",
    headers=headers,
    json={
        "searches": [
            {"index": "products", "query": "rain jacket", "k": 2},
            {"index": "articles", "query": "rain jacket care", "k": 1},
        ],
    },
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

200Successful

{
  "results": [
    {
      "index": "products",
      "route": "search",
      "status": 200,
      "result": {
        "hits": [
          {
            "id": "sku-20311",
            "title": "Torrentshell 3L Rain Jacket",
            "brand": "Patagonia",
            "category": "Rain Jackets",
            "price": 179,
            "rating": 4.7,
            "image_url": "https://cdn.acme.example/img/sku-20311.jpg",
            "score": 0.931
          },
          {
            "id": "sku-20402",
            "title": "Resolve 2 Rain Jacket",
            "brand": "The North Face",
            "category": "Rain Jackets",
            "price": 110,
            "rating": 4.5,
            "image_url": "https://cdn.acme.example/img/sku-20402.jpg",
            "score": 0.902
          }
        ],
        "total": 18,
        "query_id": "5d9e2b7a1c4f4380b6a2e8f37c1d9a04"
      }
    },
    {
      "index": "articles",
      "route": "search",
      "status": 200,
      "result": {
        "hits": [
          {
            "id": "art-0147",
            "title": "How to wash and re-waterproof a rain jacket",
            "category": "Care guides",
            "score": 0.887
          }
        ],
        "total": 6,
        "query_id": "a0c3f6e91b2d47c58e4a7b96d3f21c08"
      }
    }
  ]
}

Run up to 10 searches in one request, across the indexes the key can read.

Authentication

AuthorizationBearer

A search key, issued by Captain. Sent as Authorization: Bearer <key>.

AuthorizationBearer

A scoped key for one end user, minted from an issuer key that Captain issues. Sent as Authorization: Bearer <key>.

Request

This endpoint expects an object.

searcheslist of objectsRequired

Response

results

resultslist of objectsOptional