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 Ingest API

Add documents to indexes via NDJSON format

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

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

This API exposes 1 operation across 1 path, and defines 2 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.

1 operations 1 paths 2 schemas 1 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 1

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

Ingest 1

Add documents to indexes via NDJSON format

POST
/indexes/{index_id}/ingest
Ingest documents
ingestDocuments 3 params body → 200400404500

Schemas 2

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

ApiError
object
1 property 1 required
IngestResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quickwit-ingest-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 Search API
Quickwit Sources API