REST API
The REST API is the easiest way to get started with Qdrant. It provides a simple HTTP interface with JSON payloads, making it compatible with any programming language or tool that can make HTTP requests.Base URL
By default, the REST API is available at:protocol:http(default) orhttps(when TLS is enabled)hostname:localhost(default) or your server hostnameport:6333(default HTTP port)
For production deployments, always use HTTPS with proper authentication. See the authentication guide for details.
Request Format
All REST API requests use standard HTTP methods:GET- Retrieve resourcesPOST- Create resources or perform searchesPUT- Update or insert resourcesDELETE- Remove resourcesPATCH- Partially update resources
Content-Type: application/json header.
Example request:
Response Format
All REST API responses return JSON with a consistent structure:result: The actual response data (varies by endpoint)status: Either"ok"for success or contains error informationtime: Request processing time in seconds
Query Parameters
Many endpoints support common query parameters:consistency- Define read consistency guarantees (see distributed deployment)timeout- Override global timeout for the request (in seconds, minimum 1)wait- Wait for operation to complete before returning (trueorfalse)
gRPC API
The gRPC API provides a high-performance alternative to REST, ideal for production workloads requiring low latency and high throughput.Base URL
By default, the gRPC API is available at:6334 by default. You can configure this in your config.yaml:
gRPC is optional and can be disabled by commenting out or setting
grpc_port: null in the configuration.Performance Benefits
gRPC offers several advantages over REST:- Binary protocol - More efficient than JSON for large payloads
- HTTP/2 multiplexing - Multiple concurrent requests over a single connection
- Streaming support - Efficient for batch operations
- Lower latency - Reduced serialization overhead
Protocol Buffers
The gRPC API is defined using Protocol Buffers. You can find the.proto definitions in the Qdrant repository:
- qdrant.proto - Main service definition
- collections.proto - Collections operations
- points.proto - Points operations
Using gRPC
Most Qdrant client libraries support both REST and gRPC:API Versioning
Qdrant follows semantic versioning. The API version is tied to the Qdrant version you’re running:- Major version changes may include breaking API changes
- Minor version changes add new features while maintaining backward compatibility
- Patch version changes contain bug fixes and non-breaking improvements
OpenAPI Specification
Qdrant provides a complete OpenAPI 3.0 specification for the REST API:- Interactive documentation: https://api.qdrant.tech/
- OpenAPI JSON: Download specification
- Generate client libraries for any language
- Import into API testing tools (Postman, Insomnia, etc.)
- Validate request and response schemas
- Generate documentation automatically
Health Check Endpoints
Qdrant provides several health check endpoints, useful for monitoring and orchestration:Root Endpoint
Kubernetes Health Checks
Qdrant provides dedicated endpoints for Kubernetes:/healthz- General health check/livez- Liveness probe (checks if the service is running)/readyz- Readiness probe (checks if the service can accept traffic)
Next: Authentication
Learn how to secure your Qdrant instance with API keys and TLS certificates
Additional Resources
Collections API
Create and manage collections
Points API
Insert, update, and delete vectors
Search API
Perform vector similarity searches
Client Libraries
Use official client SDKs