Import From Algolia

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",
        "object_search": True,
    },
    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
  }
}

Copy an Algolia index into this index: send an export of it, or read access to it. Importing into an index that already has records deletes all of them and adds the Algolia records in their place. Read access answers 202 with an import job that builds the index when it ends. An export answers 200 with what was mapped; send build: true to start the build too. Importing into a new index takes a write key for every index. 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 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

An export: the records were added, with what was mapped. The build starts only with build: true (build_job).

schemaobjectOptional

flexible schema: one entry per (dotted) field

facetslist of stringsOptional

reportobjectOptional

countsobjectOptional

per section {mapped, approximated, not_mapped}, and records

fieldsmap from strings to objectsOptional

noteslist of stringsOptional

what could not be read (for example no settings ACL)

sourcestringOptional

recordsintegerOptional

build_jobstring or nullOptional

build_notestringOptional

object_searchbooleanOptional

true: an import sent with object_search true (settings and effective instead of schema)

dry_runbooleanOptional

true: a preview. Nothing was stored; records counts the records that would be added

settingsobjectOptional

with object_search: the settings the Algolia settings mapped to

effectiveobjectOptional

object_search: the field table the next build uses

Authentication

Path parameters

Headers

Request

Response headers

Response