Interfaces
Note: If you are using a language that is not listed here, you can use the REST API directly or generate a client for your language using OpenAPI or protobuf definitions.
Client Libraries
Client Repository | Installation | Version | |
---|---|---|---|
![]() | Python | pip install qdrant-client[fastembed] | Latest Release, API Docs |
![]() | Typescript | npm install @qdrant/js-client-rest | Latest Release |
![]() | Rust | cargo add qdrant-client | Latest Release |
![]() | Go | go get github.com/qdrant/go-client | Latest Release |
![]() | .NET | dotnet add package Qdrant.Client | Latest Release |
API Reference
All interaction with Qdrant takes place via the REST API. We recommend using REST API if you are using Qdrant for the first time or if you are working on a prototype.
API | Documentation |
---|---|
REST API | OpenAPI Specification |
gRPC API | gRPC Documentation |
gRPC Interface
The gRPC methods follow the same principles as REST. For each REST endpoint, there is a corresponding gRPC method.
As per the configuration file, the gRPC interface is available on the specified port.
service:
grpc_port: 6334
Running the service inside of Docker will look like this:
docker run -p 6333:6333 -p 6334:6334 \
-v $(pwd)/qdrant_storage:/qdrant/storage:z \
qdrant/qdrant
When to use gRPC: The choice between gRPC and the REST API is a trade-off between convenience and speed. gRPC is a binary protocol and can be more challenging to debug. We recommend using gRPC if you are already familiar with Qdrant and are trying to optimize the performance of your application.
Qdrant Web UI
Qdrant’s Web UI is an intuitive and efficient graphic interface for your Qdrant Collections, REST API and data points.
In the Console, you may use the REST API to interact with Qdrant, while in Collections, you can manage all the collections and upload Snapshots.
Accessing the Web UI
First, run the Docker container:
docker run -p 6333:6333 -p 6334:6334 \
-v $(pwd)/qdrant_storage:/qdrant/storage:z \
qdrant/qdrant
The GUI is available at http://localhost:6333/dashboard