Skip to main content
POST
/
collections
curl --request POST \
  --url https://{projectHost}/collections \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "collectionName": "example-collection-name",
  "indexConfigs": {
    "example-field1": {
      "type": "text",
      "analyzers": [
        "english"
      ]
    },
    "example-field2": {
      "type": "vector",
      "dimensions": 128,
      "similarity": "cosine"
    }
  }
}
'
{
  "collection": {
    "projectName": "example-project-name",
    "collectionName": "example-collection-name",
    "indexConfigs": {
      "example-field1": {
        "type": "text",
        "analyzers": [
          "english"
        ]
      },
      "example-field2": {
        "type": "vector",
        "dimensions": 128,
        "similarity": "cosine"
      }
    },
    "numDocs": 0,
    "collectionStatus": "CREATING"
  }
}

Authorizations

​
x-api-key
string
header
required

Project API Key.

Body

application/json
​
collectionName
string
required

Collection name must be unique within a project and the supported maximum length is 52.

​
indexConfigs
IndexConfigs · object
​
partitionConfig
PartitionConfig · object
​
sourceProjectName
string
​
sourceCollectionName
string
​
sourceDatetime
string
​
sourceProjectApiKey
string

Response

Created collection

​
collection
CollectionResponse · object
required