Qdrant (read: quadrant) is a vector similarity search engine. Use our documentation to develop a production-ready service with a convenient API to store, search, and manage vectors with an additional payload. Qdrant's expanding features allow for all sorts of neural network or semantic-based matching, faceted search, and other applications.
{
"paths": {
"/collections/{collection_name}/shards": {
"put": {
"tags": [
"Distributed"
],
"summary": "Create shard key",
"operationId": "create_shard_key",
"requestBody": {
"description": "Shard key configuration",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateShardingKey"
}
}
}
},
"parameters": [
{
"name": "collection_name",
"in": "path",
"description": "Name of the collection to create shards for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "timeout",
"in": "query",
"description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n",
"schema": {
"type": "integer"
}
}
],
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"type": "boolean"
}
}
}
}
}
}
}
},
"get": {
"tags": [
"Distributed"
],
"summary": "List shard keys",
"operationId": "list_shard_keys",
"parameters": [
{
"name": "collection_name",
"in": "path",
"description": "Name of the collection to list shard keys for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"$ref": "#/components/schemas/ShardKeysResponse"
}
}
}
}
}
}
}
}
},
"/collections/{collection_name}/shards/delete": {
"post": {
"tags": [
"Distributed"
],
"summary": "Delete shard key",
"operationId": "delete_shard_key",
"requestBody": {
"description": "Select shard key to delete",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DropShardingKey"
}
}
}
},
"parameters": [
{
"name": "collection_name",
"in": "path",
"description": "Name of the collection to create shards for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "timeout",
"in": "query",
"description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n",
"schema": {
"type": "integer"
}
}
],
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"/": {
"get": {
"summary": "Returns information about the running Qdrant instance",
"description": "Returns information about the running Qdrant instance like version and commit id",
"operationId": "root",
"tags": [
"Service"
],
"responses": {
"200": {
"description": "Qdrant server version information",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionInfo"
}
}
}
},
"4XX": {
"description": "error"
}
}
}
},
"/telemetry": {
"get": {
"summary": "Collect telemetry data",
"description": "Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics",
"operationId": "telemetry",
"tags": [
"Service"
],
"parameters": [
{
"name": "anonymize",
"in": "query",
"description": "If true, anonymize result",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "details_level",
"in": "query",
"description": "Level of details in telemetry data. Minimal level is 0, maximal is infinity",
"required": false,
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_collection",
"in": "query",
"description": "If true, include per-collection request statistics in the response",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "timeout",
"in": "query",
"description": "Timeout for this request",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 60
}
}
],
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"$ref": "#/components/schemas/TelemetryData"
}
}
}
}
}
}
}
}
},
"/metrics": {
"get": {
"summary": "Collect Prometheus metrics data",
"description": "Collect metrics data including app info, collections info, cluster info and statistics",
"operationId": "metrics",
"tags": [
"Service"
],
"parameters": [
{
"name": "anonymize",
"in": "query",
"description": "If true, anonymize result",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "per_collection",
"in": "query",
"description": "If true, include per-collection request metrics with a collection label instead of global request metrics",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "timeout",
"in": "query",
"description": "Timeout for this request",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 60
}
}
],
"responses": {
"200": {
"description": "Metrics data in Prometheus format",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "# HELP app_info information about qdrant server\n# TYPE app_info gauge\napp_info{name=\"qdrant\",version=\"0.11.1\"} 1\n# HELP cluster_enabled is cluster support enabled\n# TYPE cluster_enabled gauge\ncluster_enabled 0\n# HELP collections_total number of collections\n# TYPE collections_total gauge\ncollections_total 1\n"
}
}
}
},
"4XX": {
"description": "error"
}
}
}
},
"/healthz": {
"get": {
"summary": "Kubernetes healthz endpoint",
"description": "An endpoint for health checking used in Kubernetes.",
"operationId": "healthz",
"tags": [
"Service"
],
"responses": {
"200": {
"description": "Healthz response",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "healthz check passed"
}
}
}
},
"4XX": {
"description": "error"
}
}
}
},
"/livez": {
"get": {
"summary": "Kubernetes livez endpoint",
"description": "An endpoint for health checking used in Kubernetes.",
"operationId": "livez",
"tags": [
"Service"
],
"responses": {
"200": {
"description": "Healthz response",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "healthz check passed"
}
}
}
},
"4XX": {
"description": "error"
}
}
}
},
"/readyz": {
"get": {
"summary": "Kubernetes readyz endpoint",
"description": "An endpoint for health checking used in Kubernetes.",
"operationId": "readyz",
"tags": [
"Service"
],
"responses": {
"200": {
"description": "Healthz response",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "healthz check passed"
}
}
}
},
"4XX": {
"description": "error"
}
}
}
},
"/issues": {
"get": {
"summary": "Get issues",
"description": "Get a report of performance issues and configuration suggestions",
"operationId": "get_issues",
"tags": [
"Beta"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"4XX": {
"description": "error"
}
}
},
"delete": {
"summary": "Clear issues",
"description": "Removes all issues reported so far",
"operationId": "clear_issues",
"tags": [
"Beta"
],
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"/cluster": {
"get": {
"tags": [
"Distributed"
],
"summary": "Get cluster status info",
"description": "Get information about the current state and composition of the cluster",
"operationId": "cluster_status",
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"$ref": "#/components/schemas/ClusterStatus"
}
}
}
}
}
}
}
}
},
"/cluster/telemetry": {
"get": {
"tags": [
"Distributed"
],
"summary": "Collect cluster telemetry data",
"description": "Get telemetry data, from the point of view of the cluster. This includes peers info, collections info, shard transfers, and resharding status",
"operationId": "cluster_telemetry",
"parameters": [
{
"name": "details_level",
"in": "query",
"description": "The level of detail to include in the response",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "timeout",
"in": "query",
"description": "Timeout for this request",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 60
}
}
],
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"$ref": "#/components/schemas/DistributedTelemetryData"
}
}
}
}
}
}
}
}
},
"/cluster/recover": {
"post": {
"tags": [
"Distributed"
],
"summary": "Tries to recover current peer Raft state.",
"operationId": "recover_current_peer",
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"/cluster/peer/{peer_id}": {
"delete": {
"tags": [
"Distributed"
],
"summary": "Remove peer from the cluster",
"description": "Tries to remove peer from the cluster. Will return an error if peer has shards on it.",
"operationId": "remove_peer",
"parameters": [
{
"name": "peer_id",
"in": "path",
"description": "Id of the peer",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "timeout",
"in": "query",
"description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n",
"schema": {
"type": "integer"
}
},
{
"name": "force",
"in": "query",
"description": "If true - removes peer even if it has shards/replicas on it.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"/collections": {
"get": {
"tags": [
"Collections"
],
"summary": "List collections",
"description": "Get list name of all existing collections",
"operationId": "get_collections",
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"$ref": "#/components/schemas/CollectionsResponse"
}
}
}
}
}
}
}
}
},
"/collections/{collection_name}": {
"get": {
"tags": [
"Collections"
],
"summary": "Collection info",
"description": "Get detailed information about specified existing collection",
"operationId": "get_collection",
"parameters": [
{
"name": "collection_name",
"in": "path",
"description": "Name of the collection to retrieve",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"4XX": {
"description": "error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"usage": {
"default": null,
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"nullable": true
}
]
},
"time": {
"type": "number",
"format": "float",
"description": "Time spent to process this request",
"example": 0.002
},
"status": {
"type": "string",
"example": "ok"
},
"result": {
"$ref": "#/components/schemas/CollectionInfo"
}
}
}
}
}
}
}
},
"put": {
"tags": [
"Collections"
],
"summary": "Create collection",
"description": "Create new collection with given parameters",
"operationId": "create_collection",
"requestBody": {
"description": "Parameters of a new collection",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCollection"
}
}
}
},
"parameters": [
{
"name": "collection_name",
"in": "path",
"description": "Name of the new collection",
"required": true,
# --- truncated at 32 KB (508 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qdrant/refs/heads/main/openapi/qdrant-openapi-original.json