---
title: "Commit Index"
method: PATCH
path: "/api/v1/index/{index_id}"
tags: ["Index"]
---

# Commit Index

`PATCH /api/v1/index/{index_id}`

Commit moves indexed documents from the intermediate uncompressed data structure (array lists/HashMap, queryable by realtime search) in RAM
to the final compressed data structure (roaring bitmap) on Mmap or disk -
which is persistent, more compact, with lower query latency and allows search with realtime=false.
Commit is invoked automatically each time 64K documents are newly indexed **per shard** as well as on close_index (e.g. server quit).
There is no way to prevent this automatic commit by not manually invoking it.
But commit can also be invoked manually at any time at any number of newly indexed documents.
commit is a **hard commit** for persistence on disk. A **soft commit** for searchability
is invoked implicitly with every index_doc,
i.e. the document can immediately searched and included in the search results
if it matches the query AND the query parameter realtime=true is enabled.
**Use commit with caution, as it is an expensive operation**.
**Usually, there is no need to invoke it manually**, as it is invoked automatically every 64k documents **per shard** and when the index is closed with close_index.
Before terminating the program, always call close_index (commit), otherwise all documents indexed since last (manual or automatic) commit are lost.
There are only 2 reasons that justify a manual commit:
1. if you want to search newly indexed documents without using realtime=true for search performance reasons or
2. if after indexing new documents there won't be more documents indexed (for some time),
   so there won't be (soon) a commit invoked automatically at the next 64k threshold **per shard** or close_index,
   but you still need immediate persistence guarantees on disk to protect against data loss in the event of a crash.

## Path parameters

- `index_id` integer, required

## Headers

- `apikey` string, required

## Response `200`

Index committed, returns the number of committed documents

## Other responses

- `400` — Index id invalid or missing
- `401` — api_key missing
- `404` — API key does not exist

---

[API](https://skmtc.net/seekstorm/apis/seekstorm-rest-api-documentation.md) · [All operations](https://skmtc.net/seekstorm/apis/seekstorm-rest-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/seekstorm/seekstorm-rest-api-documentation/versions/e27c994d79ce/schema)