Get Records

GET

https://acme.captain.dev/v1/indexes/:index/records

GET

/v1/indexes/:index/records

import json
import requests
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_search_key"
INDEX = "products"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v1/indexes/{INDEX}/records",
    headers=headers,
    params={"ids": ["sku-10482", "sku-10517", "sku-99999"]},
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

200Retrieved

{
  "records": [
    {
      "id": "sku-10482",
      "title": "Moab 3 Mid Waterproof Hiking Boot",
      "description": "Waterproof leather and mesh mid boot with a Vibram TC5+ outsole and a breathable membrane.",
      "brand": "Merrell",
      "category": "Hiking Boots",
      "price": 139,
      "rating": 4.6,
      "image_url": "https://cdn.acme.example/img/sku-10482.jpg"
    },
    {
      "id": "sku-10517",
      "title": "X Ultra 4 Mid GTX Hiking Boot",
      "description": "GORE-TEX mid boot with a Contagrip outsole, built for rocky trails.",
      "brand": "Salomon",
      "category": "Hiking Boots",
      "price": 165,
      "rating": 4.5,
      "image_url": "https://cdn.acme.example/img/sku-10517.jpg"
    }
  ],
  "missing": [
    "sku-99999"
  ]
}

Get up to 100 records by id. Repeat ids once per record. Ids that do not exist, or that the key may not see, come back under missing.

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>.

Path parameters

indexstringRequiredformat: "^[a-z0-9][a-z0-9_-]{0,47}$"

index name

Query parameters

idslist of stringsRequired

record ids, 1 to 100: repeat the parameter for each id (?ids=a&ids=b)

Response headers

X-Captain-Applied-Seqinteger

the last update seq search had applied when this request started; the answer reflects at least that much (GET …/updates applied_seq). Not on 401 or 403, nor for an index this server does not have

X-Captain-Index-IncarnationstringOptional

the index’s incarnation, an opaque string: it changes only when the index is deleted and created again (whose seqs start again at 1), or restored from a backup (whose seqs continue from the backup’s). Sent with X-Captain-Applied-Seq

Response

records

recordslist of objectsOptional

missinglist of stringsOptional

ids not returned: missing, or hidden from this key (the two are not told apart)