Search & metadata

Start Typesense reindex

Copy an existing database into Typesense.

POST/search/reindex

Start a reindex to populate Typesense with data from your existing database. Use when you spin up a new Typesense instance alongside a database that already contains records.

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

Response

statusstring

Current state: in_progress or completed.

phasestring

Current phase (e.g. indexing_transactions) or done when complete.

total_recordsinteger

Total number of records to index.

processed_recordsinteger

Number of records processed so far.

started_atstring

ISO 8601 timestamp when reindex began.

completed_atstring

ISO 8601 timestamp when reindex finished. Only present when status is completed.

errorsarray

Array of error messages. Only present when an error occurs during reindex.

curl -X POST "http://localhost:5001/search/reindex" \
  -H "X-blnk-key: <api-key>"

{
    "status": "in_progress",
    "phase": "indexing_transactions",
    "total_records": 2145709,
    "processed_records": 2145709,
    "started_at": "2026-02-12T12:13:10.448612096Z"
}

{
  "error": "A reindex operation is already in progress",
  "error_detail": {
    "code": "SRCH_REINDEX_IN_PROGRESS",
    "message": "A reindex operation is already in progress",
    "details": {
      "status": "in_progress",
      "phase": "create_collections",
      "total_records": 0,
      "processed_records": 0,
      "started_at": "2026-06-13T00:36:38.149512Z"
    }
  }
}