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

Qdrant Indexes API

Indexes for payloads associated with points.

Qdrant Indexes API is one of 9 APIs that Qdrant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 36 schemas. It is described by OpenAPI 3.0.1, at version master.

Requests are made against a single base URL, {protocol}://{hostname}:{port}.

2 operations 2 paths 36 schemas 1 DELETE1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
master
Server
{protocol}://{hostname}:{port}
Authentication
API Key, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

Qdrant Indexes API declares 2 security schemes for authenticating requests. An API key is passed in the header as api-key (api-key). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated, though some operations may also be called without credentials.

  • api-key — Authorization key, either read-write or read-only

Paths & Operations 2

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

Indexes 2

Indexes for payloads associated with points.

PUT
/collections/{collection_name}/index
Create index for field in collection
create_field_index 4 params body → default4XX200
DELETE
/collections/{collection_name}/index/{field_name}
Delete index for field in collection
delete_field_index 5 params → default4XX200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are TextIndexParams (11 properties), HardwareUsage (7 properties), IntegerIndexParams (6 properties), DatetimeIndexParams (4 properties). Each schema is shown below with its type and property counts.

HardwareUsage
object
Usage of the hardware resources, spent to process the request
7 properties 7 required
KeywordIndexType
string
TextIndexParams
object
11 properties 1 required
TokenizerType
string
GeoIndexType
string
DatetimeIndexParams
object
4 properties 1 required
Snowball
string
UuidIndexType
string
TextIndexType
string
Usage
object
Usage of the hardware resources, spent to process the request
2 properties
DatetimeIndexType
string
ErrorResponse
object
3 properties
BoolIndexParams
object
3 properties 1 required
InferenceUsage
object
1 property 1 required
KeywordIndexParams
object
4 properties 1 required
StopwordsSet
object
2 properties
SnowballLanguage
string
Languages supported by snowball stemmer.
IntegerIndexType
string
CreateFieldIndex
object
2 properties 1 required
IntegerIndexParams
object
6 properties 1 required
WriteOrdering
string
Defines write ordering guarantees for collection operations weak - write operations may be reordered, works faster, default medium - write operations go throug…
UpdateStatus
string
Acknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting f…
PayloadFieldSchema
PayloadSchemaType
string
All possible names of payload types
UpdateResult
object
2 properties 1 required
StopwordsInterface
UuidIndexParams
object
4 properties 1 required
ModelUsage
object
1 property 1 required
FloatIndexParams
object
4 properties 1 required
GeoIndexParams
object
3 properties 1 required
BoolIndexType
string
PayloadSchemaParams
Payload type with parameters
Language
string
SnowballParams
object
2 properties 2 required
StemmingAlgorithm
Different stemming algorithms with their configs.
FloatIndexType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qdrant-indexes-api-openapi.yml Raw ↑

Other APIs Qdrant publishes across the network.

Qdrant Aliases API
Qdrant Beta API
Qdrant Collections API
Qdrant Distributed API
Qdrant Points API
Qdrant Search API
Qdrant Service API
Qdrant Snapshots API