Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Quickwit Search API

Query documents across indexes using full-text and aggregation queries

Quickwit Search API is one of 7 APIs that Quickwit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Search. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 0.8.2.

Requests are made against a single base URL, http://localhost:7280/api/v1.

2 operations 1 paths 3 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.8.2
Base URL
https://your-quickwit-node/api/v1
License
Resource Areas
1

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Search 2

Query documents across indexes using full-text and aggregation queries

GET
/indexes/{index_id}/search
Search an index (GET)
searchIndexGet 10 params → 200400404500
POST
/indexes/{index_id}/search
Search an index (POST)
searchIndexPost 1 param body → 200400404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are SearchRequest (10 properties), SearchResponse (5 properties), ApiError (1 property). Each schema is shown below with its type and property counts.

SearchRequest
object
10 properties 1 required
SearchResponse
object
5 properties
ApiError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quickwit-search-api-openapi.yml Raw ↑

Other APIs Quickwit publishes across the network.

Quickwit Cluster API
Quickwit Delete Tasks API
Quickwit Index Templates API
Quickwit Indexes API
Quickwit Ingest API
Quickwit Sources API