Collections API

REST API endpoints for managing collections in Qdrant

Collections are the fundamental organizational unit in Qdrant, containing points with vectors and payloads. Use these endpoints to create, manage, and configure collections.

List Collections

Get a list of all existing collections.

curl -X GET 'http://localhost:6333/collections'

Response

result · object

collections · array

List of collection descriptions

name · string

Name of the collection

Get Collection Info

Retrieve detailed information about a specific collection.

curl -X GET 'http://localhost:6333/collections/{collection_name}'

Path Parameters

collection_name · string · required

Name of the collection to retrieve

Response

result · object

status · string

Status of the collection (green, yellow, red)

optimizer_status · string

Current optimizer status

vectors_count · integer

Number of vectors in the collection

points_count · integer

Number of points in the collection

segments_count · integer

Number of segments

config · object

Collection configuration including vector params, distance metric, and replication settings

Create Collection

Create a new collection with specified parameters.

curl -X PUT 'http://localhost:6333/collections/{collection_name}' \
  -H 'Content-Type: application/json' \
  -d '{
    "vectors": {
      "size": 768,
      "distance": "Cosine"
    }
  }'

Path Parameters

collection_name · string · required

Name of the new collection

Query Parameters

timeout · integer

Wait for operation commit timeout in seconds. If timeout is reached, request returns with service error.

Request Body

vectors · object · required

Vector configuration for the collection

size · integer · required

Size of the vectors

distance · string · required

Distance metric: Cosine, Euclid, Dot, or Manhattan

hnsw_config · object

HNSW index configuration

quantization_config · object

Vector quantization configuration

on_disk · boolean

Store vectors on disk instead of RAM

shard_number · integer

Number of shards in collection. Default is 1 for standalone, 2 for clusters.

replication_factor · integer

Number of replicas for each shard. Default is 1.

write_consistency_factor · integer

Minimum number of replicas that must acknowledge a write operation.

on_disk_payload · boolean

Store payload data on disk

optimizers_config · object

Configuration for collection optimizers

Response

result · boolean

Returns true if collection was created successfully

Update Collection

Update parameters of an existing collection.

curl -X PATCH 'http://localhost:6333/collections/{collection_name}' \
  -H 'Content-Type: application/json' \
  -d '{
    "optimizers_config": {
      "indexing_threshold": 20000
    }
  }'

Path Parameters

collection_name · string · required

Name of the collection to update

Query Parameters

timeout · integer

Wait for operation commit timeout in seconds

Request Body

optimizers_config · object

New optimizer configuration

indexing_threshold · integer

Minimum number of vectors for indexing to trigger

max_segment_size · integer

Maximum segment size in KB

hnsw_config · object

HNSW index configuration updates

vectors · object

Vector configuration updates

Response

result · boolean

Returns true if collection was updated successfully

Delete Collection

Delete a collection and all its associated data.

curl -X DELETE 'http://localhost:6333/collections/{collection_name}'

Path Parameters

collection_name · string · required

Name of the collection to delete

Query Parameters

timeout · integer

Wait for operation commit timeout in seconds

Response

result · boolean

Returns true if collection was deleted successfully

Check Collection Existence

Check if a collection with the given name exists.

curl -X GET 'http://localhost:6333/collections/{collection_name}/exists'

Path Parameters

collection_name · string · required

Name of the collection

Response

result · object

exists · boolean

Returns true if collection exists, false otherwise

Create Field Index

Create an index for a specific field in the collection to enable efficient filtering.

curl -X PUT 'http://localhost:6333/collections/{collection_name}/index' \
  -H 'Content-Type: application/json' \
  -d '{
    "field_name": "city",
    "field_schema": "keyword"
  }'

Path Parameters

collection_name · string · required

Name of the collection

Query Parameters

wait · boolean

If true, wait for changes to actually happen. Default is true.

ordering · string

Define ordering guarantees: weak, medium, or strong

timeout · integer

Timeout for the operation in seconds

Request Body

field_name · string · required

Name of the field to index

field_schema · string · required

Field type: keyword, integer, float, bool, geo, datetime, or text

Response

result · object

operation_id · integer

Operation identifier

status · string

Update status: acknowledged or completed

Delete Field Index

Delete an index for a specific field.

curl -X DELETE 'http://localhost:6333/collections/{collection_name}/index/{field_name}'

Path Parameters

collection_name · string · required

Name of the collection

field_name · string · required

Name of the field where to delete the index

Query Parameters

wait · boolean

If true, wait for changes to actually happen

ordering · string

Define ordering guarantees for the operation

timeout · integer

Timeout for the operation in seconds

Response

result · object

operation_id · integer

Operation identifier

status · string

Update status

Update Collection Aliases

Manage collection aliases for easier collection referencing.

curl -X POST 'http://localhost:6333/collections/aliases' \
  -H 'Content-Type: application/json' \
  -d '{
    "actions": [
      {
        "create_alias": {
          "collection_name": "my_collection",
          "alias_name": "production"
        }
      }
    ]
  }'

Query Parameters

timeout · integer

Wait for operation commit timeout in seconds

Request Body

actions · array · required

List of alias operations to perform

create_alias · object

Create a new alias

collection_name · string · required

Target collection name

alias_name · string · required

New alias name

delete_alias · object

Delete an existing alias

alias_name · string · required

Alias name to delete

rename_alias · object

Rename an existing alias

old_alias_name · string · required

Current alias name

new_alias_name · string · required

New alias name

Response

result · boolean

Returns true if aliases were updated successfully