Get Job

GET

https://acme.captain.dev/v1/jobs/:job_id

GET

/v1/jobs/:job_id

import json
import requests
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_write_key"
JOB_ID = "job_20260928213040_9b27e1"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v1/jobs/{JOB_ID}",
    headers=headers,
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

200Get an import job

{
  "id": "job_20260928213040_9b27e1",
  "type": "index.import",
  "index": "products",
  "status": "succeeded",
  "created_at": 1759095040,
  "started_at": 1759095040,
  "finished_at": 1759095161,
  "stages": [
    {
      "name": "pull",
      "status": "done",
      "records": 12840,
      "synonyms": 46,
      "rules": 6,
      "notes": []
    },
    {
      "name": "map",
      "status": "done",
      "fields": 14,
      "facets": [
        "brand",
        "category",
        "color"
      ],
      "counts": {
        "settings": {
          "mapped": 9,
          "approximated": 2,
          "not_mapped": 1
        },
        "synonyms": {
          "mapped": 46,
          "approximated": 0,
          "not_mapped": 0
        },
        "rules": {
          "mapped": 5,
          "approximated": 0,
          "not_mapped": 1
        },
        "records": 12840
      }
    },
    {
      "name": "add",
      "status": "done",
      "documents": 12840,
      "synonyms_saved": 46,
      "rules_saved": 5
    }
  ],
  "error": null,
  "result": {
    "records": 12840,
    "build_job": "job_20260928213301_4c8d2e",
    "documents": 12840,
    "counts": {
      "settings": {
        "mapped": 9,
        "approximated": 2,
        "not_mapped": 1
      },
      "synonyms": {
        "mapped": 46,
        "approximated": 0,
        "not_mapped": 0
      },
      "rules": {
        "mapped": 5,
        "approximated": 0,
        "not_mapped": 1
      },
      "records": 12840
    }
  }
}

Get a job’s status and stages, and a build’s progress. A write key reads the jobs it started and the automatic builds of its indexes, the ones Get Update Status names. Any other job answers 404 JOB_NOT_FOUND.

Authentication

AuthorizationBearer

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

Path parameters

job_idstringRequired

Response

job

idstringOptional

typeenumOptional

index.write: record updates and deletes through the ordered update log, one job per burst

Allowed values:

indexstringOptional

seq_fromintegerOptional

index.write: the first update this job carries

seq_tointegerOptional

index.write: the last update this job carries

recordsintegerOptional

index.write: records written

statusenumOptional

Allowed values:

created_atintegerOptional

started_atinteger or nullOptional

finished_atinteger or nullOptional

stageslist of objectsOptional

progressobjectOptional

index.build: how far the build has got. records_done counts the records the running step has done; a step that doesn’t count records (tables, verify, publish) reports every record done

build_idstringOptional

errorstring or nullOptional

error_codestringOptional

why a failed job failed; error says it in words to show. A build: BAD_VALUES (more than half of a field’s values don’t fit its declared type; see bad_values), BUILD_QUALITY (the build’s checks refused it; the previous build keeps serving), NO_RECORDS (every record was deleted or cleared before the build read them), CANCELLED (the index is being deleted), ENGINE_ERROR (a fault on Captain’s side, in the build or in running the job; the index keeps serving its previous build; retry). An index delete: DELETE_FAILED (Captain couldn’t delete the index; retry). An Algolia import: the Algolia code (ALGOLIA_APP_NOT_FOUND, ALGOLIA_UNREACHABLE, ALGOLIA_INDEX_NOT_FOUND, ALGOLIA_FORBIDDEN, ALGOLIA_TIMEOUT, ALGOLIA_ERROR, INDEX_TOO_LARGE, VALIDATION_ERROR) or IMPORT_FAILED (a fault on Captain’s side; nothing was changed; retry)

bad_valueslist of objectsOptional

with error_code BAD_VALUES: per field, count of bad values, of how many, and up to 3 examples

warningslist of objectsOptional

{code, message}. Settings resolved by a rule (the same warnings GET settings shows). Any build: SETTLE_TIMEOUT (the build is live, but its search results are still settling and may shift for a few minutes; no action needed)

facet_reportlist of objectsOptional

per number or date facet, whether it has value counts and why

resultobject or nullOptional