v6

OpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-011951192.5 KB
Document

Index Document(s)

Index a JSON document or an array of JSON documents (bulk), each consisting of arbitrary key-value pairs to the index with the specified apikey and index_id, and return the number of indexed docs. Index documents enables true real-time search (as opposed to near realtime.search): When in query_index the parameter realtime is set to true then indexed, but uncommitted documents are immediately included in the search results, without requiring a commit or refresh. Therefore a explicit commit_index is almost never required, as it is invoked automatically after 64k documents are indexed per shard or on close_index for persistence.

post/api/v1/index/{index_id}/doc

Path parameters

index_idinteger required

index id

Headers

apikeystring required

YOUR_SECRET_API_KEY

Request body

object required

Response

Document indexed, returns the number of indexed documents