---
title: "Query Index"
method: GET
path: "/api/v1/index/{index_id}/query"
tags: ["Query"]
---

# Query Index

`GET /api/v1/index/{index_id}/query`

Query results from index with index_id.
Query index via GET is a convenience function, that **offers only a limited set of parameters compared to Query Index via POST**.
Always use Query Index via POST for the full set of parameters and maximum flexibility.
Query Index via GET is provided for simple queries and quick testing, and to be easily callable from browser address bar, but it is not intended for production use.

## Path parameters

- `index_id` integer, required

## Query parameters

- `query` string, required
- `offset` integer, required
- `length` integer, required
- `realtime` boolean, required
- `enable_empty_query` boolean, required

## Headers

- `apikey` string, required

## Response `200`

Results found, returns the SearchResultObject

- SearchResultObject — Search result object
  - `time` integer, required — Time taken to execute the search query in nanoseconds
  - `original_query` string, required — Search query string
  - `query` string, required — Search query string after any automatic query correction or completion
  - `offset` integer, required — Offset of the returned search results
  - `length` integer, required — Number of requested search results
  - `count` integer, required — Number of returned search results matching the query
  - `count_total` integer, required — Total number of search results matching the query
  - `query_terms` string[], required — Vector of search query terms. Can be used e.g. for custom highlighting.
  - `results` object[], required — Vector of search result documents
  - `facets` object, required — Facets with their values and corresponding document counts
  - `suggestions` string[], required — Suggestions for query correction or completion

## Other responses

- `400` — No query specified
- `401` — api_key missing
- `404` — API key does not exist

## Changes

- **2026-06-22** `39cce1ef7d95` — 1 info
  - api operation id `query_index_api_get` removed and replaced with `query_index_get`
- **2026-06-21** `4cfd9d95648c` — 1 info
  - api operation id `query_index_get` removed and replaced with `query_index_api_get`

[Change history](https://skmtc.dev/seekstorm/apis/seekstorm-rest-api-documentation/changes/api/v1/index/:index_id/query/get.md)

---

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