Import From Algolia | Captain Docs

import json
import requests
import uuid
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_write_key"
INDEX = "products"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json",
    "Idempotency-Key": str(uuid.uuid4()),
}
response = requests.post(
    f"{BASE_URL}/v1/indexes/{INDEX}/import/algolia",
    headers=headers,
    json={
        "app_id": "YOUR_ALGOLIA_APP_ID",
        "api_key": "YOUR_ALGOLIA_READ_KEY",
        "index_name": "prod_products",
    },
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

{
  "job": {
    "id": "job_20260928213040_9b27e1",
    "type": "index.import",
    "index": "products",
    "status": "importing",
    "created_at": 1759095040,
    "started_at": 1759095040,
    "finished_at": null,
    "stages": [],
    "error": null,
    "result": null
  }
}

Send an Algolia export, or read access to an Algolia index. Captain stores the import for review and builds the index after that review. Algolia keys are never stored.

Authentication

AuthorizationBearer

A write key, issued by Captain. Server side only. Sent as Authorization: Bearer <key>.

Path parameters

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

index name

Request

This endpoint expects an object.

exportobjectRequired

pullobjectRequired

Response

The import job. It ends with status landed_for_review once the export is stored for review.

jobobjectOptional

Authentication

Path parameters

Headers

Request

Response