{
  "opencollection": "1.0.0",
  "info": {
    "name": "Qdrant API",
    "version": "master"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Distributed",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List shard keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to list shard keys for"
              }
            ]
          },
          "docs": "List shard keys"
        },
        {
          "info": {
            "name": "Create shard key",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to create shards for"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create shard key"
        },
        {
          "info": {
            "name": "Delete shard key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards/delete",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to create shards for"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete shard key"
        },
        {
          "info": {
            "name": "Get cluster status info",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/cluster"
          },
          "docs": "Get information about the current state and composition of the cluster"
        },
        {
          "info": {
            "name": "Collect cluster telemetry data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/cluster/telemetry",
            "params": [
              {
                "name": "details_level",
                "value": "",
                "type": "query",
                "description": "The level of detail to include in the response"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for this request"
              }
            ]
          },
          "docs": "Get telemetry data, from the point of view of the cluster. This includes peers info, collections info, shard transfers, and resharding status"
        },
        {
          "info": {
            "name": "Tries to recover current peer Raft state.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/cluster/recover"
          },
          "docs": "Tries to recover current peer Raft state."
        },
        {
          "info": {
            "name": "Remove peer from the cluster",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}/cluster/peer/:peer_id",
            "params": [
              {
                "name": "peer_id",
                "value": "",
                "type": "path",
                "description": "Id of the peer"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "If true - removes peer even if it has shards/replicas on it."
              }
            ]
          },
          "docs": "Tries to remove peer from the cluster. Will return an error if peer has shards on it."
        },
        {
          "info": {
            "name": "Collection cluster info",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/cluster",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to retrieve the cluster info for"
              }
            ]
          },
          "docs": "Get cluster information for a collection"
        },
        {
          "info": {
            "name": "Update collection cluster setup",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/cluster",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection on which to to apply the cluster update operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update collection cluster setup"
        }
      ]
    },
    {
      "info": {
        "name": "Service",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns information about the running Qdrant instance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/"
          },
          "docs": "Returns information about the running Qdrant instance like version and commit id"
        },
        {
          "info": {
            "name": "Collect telemetry data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/telemetry",
            "params": [
              {
                "name": "anonymize",
                "value": "",
                "type": "query",
                "description": "If true, anonymize result"
              },
              {
                "name": "details_level",
                "value": "",
                "type": "query",
                "description": "Level of details in telemetry data. Minimal level is 0, maximal is infinity"
              },
              {
                "name": "per_collection",
                "value": "",
                "type": "query",
                "description": "If true, include per-collection request statistics in the response"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for this request"
              }
            ]
          },
          "docs": "Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics"
        },
        {
          "info": {
            "name": "Collect Prometheus metrics data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/metrics",
            "params": [
              {
                "name": "anonymize",
                "value": "",
                "type": "query",
                "description": "If true, anonymize result"
              },
              {
                "name": "per_collection",
                "value": "",
                "type": "query",
                "description": "If true, include per-collection request metrics with a collection label instead of global request metrics"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for this request"
              }
            ]
          },
          "docs": "Collect metrics data including app info, collections info, cluster info and statistics"
        },
        {
          "info": {
            "name": "Kubernetes healthz endpoint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/healthz"
          },
          "docs": "An endpoint for health checking used in Kubernetes."
        },
        {
          "info": {
            "name": "Kubernetes livez endpoint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/livez"
          },
          "docs": "An endpoint for health checking used in Kubernetes."
        },
        {
          "info": {
            "name": "Kubernetes readyz endpoint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/readyz"
          },
          "docs": "An endpoint for health checking used in Kubernetes."
        }
      ]
    },
    {
      "info": {
        "name": "Beta",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get issues",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/issues"
          },
          "docs": "Get a report of performance issues and configuration suggestions"
        },
        {
          "info": {
            "name": "Clear issues",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}/issues"
          },
          "docs": "Removes all issues reported so far"
        }
      ]
    },
    {
      "info": {
        "name": "Collections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List collections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections"
          },
          "docs": "Get list name of all existing collections"
        },
        {
          "info": {
            "name": "Collection info",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to retrieve"
              }
            ]
          },
          "docs": "Get detailed information about specified existing collection"
        },
        {
          "info": {
            "name": "Create collection",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the new collection"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create new collection with given parameters"
        },
        {
          "info": {
            "name": "Update collection parameters",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to update"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update parameters of the existing collection"
        },
        {
          "info": {
            "name": "Delete collection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to delete"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              }
            ]
          },
          "docs": "Drop collection and all associated data"
        },
        {
          "info": {
            "name": "Check the existence of a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/exists",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              }
            ]
          },
          "docs": "Returns \"true\" if the given collection name exists, and \"false\" otherwise"
        },
        {
          "info": {
            "name": "Get optimization progress",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/optimizations",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "with",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of optional fields to include in the response.\nPossible values: queued, completed, idle_segments."
              },
              {
                "name": "completed_limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of completed optimizations to return.\nIgnored if `completed` is not in the `with` parameter."
              }
            ]
          },
          "docs": "Get progress of ongoing and completed optimizations for a collection"
        }
      ]
    },
    {
      "info": {
        "name": "Aliases",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Update aliases of the collections",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/aliases",
            "params": [
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Wait for operation commit timeout in seconds.\nIf timeout is reached - request will return with service error.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update aliases of the collections"
        },
        {
          "info": {
            "name": "List aliases for collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/aliases",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              }
            ]
          },
          "docs": "Get list of all aliases for a collection"
        },
        {
          "info": {
            "name": "List collections aliases",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/aliases"
          },
          "docs": "Get list of all existing collections aliases"
        }
      ]
    },
    {
      "info": {
        "name": "Indexes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create index for field in collection",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/index",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create index for field in collection"
        },
        {
          "info": {
            "name": "Delete index for field in collection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/index/:field_name",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "field_name",
                "value": "",
                "type": "path",
                "description": "Name of the field where to delete the index"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ]
          },
          "docs": "Delete field index for collection"
        }
      ]
    },
    {
      "info": {
        "name": "Snapshots",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Recover from an uploaded snapshot",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/snapshots/upload",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
              },
              {
                "name": "priority",
                "value": "",
                "type": "query",
                "description": "Defines source of truth for snapshot recovery"
              },
              {
                "name": "checksum",
                "value": "",
                "type": "query",
                "description": "Optional SHA256 checksum to verify snapshot integrity before recovery."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "snapshot",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Recover local collection data from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created."
        },
        {
          "info": {
            "name": "Recover from a snapshot",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/snapshots/recover",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Recover local collection data from a snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created."
        },
        {
          "info": {
            "name": "List collection snapshots",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/snapshots",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              }
            ]
          },
          "docs": "Get list of snapshots for a collection"
        },
        {
          "info": {
            "name": "Create collection snapshot",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/snapshots",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection for which to create a snapshot"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
              }
            ]
          },
          "docs": "Create new snapshot for a collection"
        },
        {
          "info": {
            "name": "Download collection snapshot",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/snapshots/:snapshot_name",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "snapshot_name",
                "value": "",
                "type": "path",
                "description": "Name of the snapshot to download"
              }
            ]
          },
          "docs": "Download specified snapshot from a collection as a file"
        },
        {
          "info": {
            "name": "Delete collection snapshot",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/snapshots/:snapshot_name",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection for which to delete a snapshot"
              },
              {
                "name": "snapshot_name",
                "value": "",
                "type": "path",
                "description": "Name of the snapshot to delete"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
              }
            ]
          },
          "docs": "Delete snapshot for a collection"
        },
        {
          "info": {
            "name": "List of storage snapshots",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/snapshots"
          },
          "docs": "Get list of snapshots of the whole storage"
        },
        {
          "info": {
            "name": "Create storage snapshot",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/snapshots",
            "params": [
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
              }
            ]
          },
          "docs": "Create new snapshot of the whole storage"
        },
        {
          "info": {
            "name": "Download storage snapshot",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/snapshots/:snapshot_name",
            "params": [
              {
                "name": "snapshot_name",
                "value": "",
                "type": "path",
                "description": "Name of the snapshot to download"
              }
            ]
          },
          "docs": "Download specified snapshot of the whole storage as a file"
        },
        {
          "info": {
            "name": "Delete storage snapshot",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}/snapshots/:snapshot_name",
            "params": [
              {
                "name": "snapshot_name",
                "value": "",
                "type": "path",
                "description": "Name of the full snapshot to delete"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
              }
            ]
          },
          "docs": "Delete snapshot of the whole storage"
        },
        {
          "info": {
            "name": "Download shard snapshot",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards/:shard_id/snapshot",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "shard_id",
                "value": "",
                "type": "path",
                "description": "Id of the shard"
              }
            ]
          },
          "docs": "Stream the current state of a shard as a snapshot file"
        },
        {
          "info": {
            "name": "Recover shard from an uploaded snapshot",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards/:shard_id/snapshots/upload",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "shard_id",
                "value": "",
                "type": "path",
                "description": "Id of the shard to recover"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
              },
              {
                "name": "priority",
                "value": "",
                "type": "query",
                "description": "Defines source of truth for snapshot recovery"
              },
              {
                "name": "checksum",
                "value": "",
                "type": "query",
                "description": "Optional SHA256 checksum to verify snapshot integrity before recovery."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "snapshot",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Recover shard of a local collection from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection shard."
        },
        {
          "info": {
            "name": "Recover from a snapshot",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards/:shard_id/snapshots/recover",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "shard_id",
                "value": "",
                "type": "path",
                "description": "Id of the shard to recover"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Recover shard of a local collection data from a snapshot. This will overwrite any data, stored in this shard, for the collection."
        },
        {
          "info": {
            "name": "List shards snapshots for a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards/:shard_id/snapshots",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "shard_id",
                "value": "",
                "type": "path",
                "description": "Id of the shard"
              }
            ]
          },
          "docs": "Get list of snapshots for a shard of a collection"
        },
        {
          "info": {
            "name": "Create shard snapshot",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards/:shard_id/snapshots",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection for which to create a snapshot"
              },
              {
                "name": "shard_id",
                "value": "",
                "type": "path",
                "description": "Id of the shard"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
              }
            ]
          },
          "docs": "Create new snapshot of a shard for a collection"
        },
        {
          "info": {
            "name": "Download collection snapshot",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards/:shard_id/snapshots/:snapshot_name",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection"
              },
              {
                "name": "shard_id",
                "value": "",
                "type": "path",
                "description": "Id of the shard"
              },
              {
                "name": "snapshot_name",
                "value": "",
                "type": "path",
                "description": "Name of the snapshot to download"
              }
            ]
          },
          "docs": "Download specified snapshot of a shard from a collection as a file"
        },
        {
          "info": {
            "name": "Delete shard snapshot",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/shards/:shard_id/snapshots/:snapshot_name",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection for which to delete a snapshot"
              },
              {
                "name": "shard_id",
                "value": "",
                "type": "path",
                "description": "Id of the shard"
              },
              {
                "name": "snapshot_name",
                "value": "",
                "type": "path",
                "description": "Name of the snapshot to delete"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
              }
            ]
          },
          "docs": "Delete snapshot of a shard for a collection"
        }
      ]
    },
    {
      "info": {
        "name": "Points",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get point",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/:id",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to retrieve from"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the point"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              }
            ]
          },
          "docs": "Retrieve full information of single point by id"
        },
        {
          "info": {
            "name": "Get points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to retrieve from"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieve multiple points by specified IDs"
        },
        {
          "info": {
            "name": "Upsert points",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to update from"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Perform insert + updates on points. If point with given ID already exists - it will be overwritten."
        },
        {
          "info": {
            "name": "Delete points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/delete",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to delete from"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete points"
        },
        {
          "info": {
            "name": "Update vectors",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/vectors",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to update from"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update specified named vectors on points, keep unspecified vectors intact."
        },
        {
          "info": {
            "name": "Delete vectors",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/vectors/delete",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to delete from"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete named vectors from the given points."
        },
        {
          "info": {
            "name": "Set payload",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/payload",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to set from"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set payload values for points"
        },
        {
          "info": {
            "name": "Overwrite payload",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/payload",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to set from"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace full payload of points with new one"
        },
        {
          "info": {
            "name": "Delete payload",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/payload/delete",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to delete from"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete specified key payload for points"
        },
        {
          "info": {
            "name": "Clear payload",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/payload/clear",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to clear payload from"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Remove all payload for specified points"
        },
        {
          "info": {
            "name": "Batch update points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/batch",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to apply operations on"
              },
              {
                "name": "wait",
                "value": "",
                "type": "query",
                "description": "If true, wait for changes to actually happen"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "define ordering guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "Timeout for the operation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Apply a series of update operations for points, vectors and payloads"
        },
        {
          "info": {
            "name": "Scroll points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/scroll",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to retrieve from"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Scroll request - paginate over all points which matches given filtering condition"
        },
        {
          "info": {
            "name": "Count points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/count",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to count in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Count points which matches given filtering condition"
        },
        {
          "info": {
            "name": "Facet a payload key with a given filter.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/facet",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to facet in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Count points that satisfy the given filter for each unique value of a payload key."
        }
      ]
    },
    {
      "info": {
        "name": "Search",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/search",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieve closest points based on vector similarity and given filtering conditions"
        },
        {
          "info": {
            "name": "Search batch points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/search/batch",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieve by batch the closest points based on vector similarity and given filtering conditions"
        },
        {
          "info": {
            "name": "Search point groups",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/search/groups",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieve closest points based on vector similarity and given filtering conditions, grouped by a given payload field"
        },
        {
          "info": {
            "name": "Recommend points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/recommend",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Look for the points which are closer to stored positive examples and at the same time further to negative examples."
        },
        {
          "info": {
            "name": "Recommend batch points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/recommend/batch",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Look for the points which are closer to stored positive examples and at the same time further to negative examples."
        },
        {
          "info": {
            "name": "Recommend point groups",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/recommend/groups",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Look for the points which are closer to stored positive examples and at the same time further to negative examples, grouped by a given payload field."
        },
        {
          "info": {
            "name": "Discover points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/discover",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use context and a target to find the most similar points to the target, constrained by the context.\nWhen using only the context (without a target), a special search - called context search - is performed where pairs of points are used to generate a loss that guides the search towards the zone where most positive examples overlap. This means that the score minimizes the scenario of finding a point closer to a negative than to a positive part of a pair.\nSince the score of a context relates to loss"
        },
        {
          "info": {
            "name": "Discover batch points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/discover/batch",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Look for points based on target and/or positive and negative example pairs, in batch."
        },
        {
          "info": {
            "name": "Query points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/query",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to query"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Universally query points. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries."
        },
        {
          "info": {
            "name": "Query points in batch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/query/batch",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to query"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Universally query points in batch. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries."
        },
        {
          "info": {
            "name": "Query points, grouped by a given payload field",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/query/groups",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to query"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Universally query points, grouped by a given payload field"
        },
        {
          "info": {
            "name": "Search points matrix distance pairs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/search/matrix/pairs",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Compute distance matrix for sampled points with a pair based output format"
        },
        {
          "info": {
            "name": "Search points matrix distance offsets",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}/collections/:collection_name/points/search/matrix/offsets",
            "params": [
              {
                "name": "collection_name",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search in"
              },
              {
                "name": "consistency",
                "value": "",
                "type": "query",
                "description": "Define read consistency guarantees for the operation"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "If set, overrides global timeout for this request. Unit is seconds."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Compute distance matrix for sampled points with an offset based output format"
        }
      ]
    }
  ],
  "bundled": true
}