milvus-logo
LFAI
< Docs
  • RESTful
    • About
    • v1

Create Collection

Creates a collection in a cluster.

POST
/v1/vector/collections/create
Cluster Endpoint

The base URL for this API is in the following format:

http://localhost:19530

export CLUSTER_ENDPOINT="http://localhost:19530"
Parameters
Authorizationstringheaderrequired

The authentication token should be a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
dbNamestring

The name of the database.

collectionNamestringrequired

The name of the collection to create.

dimensionintegerrequired

The number of dimensions for the vector field of the collection.

Value Range: ≥ 1≤ 32768
metricTypestring

The distance metric used for the collection.

primaryFieldstring

The primary key field name.

vectorFieldstring

The vector field.

descriptionstring

The description of the collection

export TOKEN="root:Milvus"


curl --request POST \
--url "${CLUSTER_ENDPOINT}/v1/vector/collections/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "medium_articles",
    "dimension": 256,
    "metricType": "COSINE",
    "primaryField": "id",
    "vectorField": "vector"
}'
Responses200 - application/json
codeinteger

Response code.

dataobject

Response payload which is an empty object.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 200,
    "data": {}
}