# Describe collection

Read field names, data types, indexes and load state for a collection.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/describe/

## Section links

- [cURL command](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/describe/#curl-command)
- [Default request](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/describe/#default-request)
- [Sample response](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/describe/#sample-response)
- [Request fields](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/describe/#request-fields)

`POST /v2/vectordb/collections/describe`

Replace `https://your-cluster.example.com` with your Milvus endpoint. Set `MILVUS_TOKEN` for authentication or omit the Authorization header on an unauthenticated cluster.

## cURL command

```bash
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/collections/describe' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "collectionName": "books"
}'
```

## Default request

```json
{
  "dbName": "default",
  "collectionName": "books"
}
```

## Sample response

```json
{
  "code": 0,
  "data": {
    "collectionName": "books",
    "collectionID": 123456789,
    "description": "Book catalog",
    "autoId": false,
    "fields": [
      {
        "description": "",
        "primaryKey": true,
        "partitionKey": false,
        "clusteringKey": false,
        "autoId": false,
        "nullable": false,
        "id": 100,
        "name": "id",
        "type": "Int64"
      },
      {
        "description": "",
        "primaryKey": false,
        "partitionKey": false,
        "clusteringKey": false,
        "autoId": false,
        "nullable": false,
        "id": 101,
        "name": "title",
        "type": "VarChar",
        "params": [
          {
            "key": "max_length",
            "value": "256"
          }
        ]
      },
      {
        "description": "",
        "primaryKey": false,
        "partitionKey": false,
        "clusteringKey": false,
        "autoId": false,
        "nullable": false,
        "id": 102,
        "name": "vector",
        "type": "FloatVector",
        "params": [
          {
            "key": "dim",
            "value": "4"
          }
        ]
      }
    ],
    "structFields": [],
    "functions": [],
    "aliases": [
      "current_books"
    ],
    "indexes": [
      {
        "fieldName": "vector",
        "indexName": "vector_idx",
        "metricType": "COSINE"
      }
    ],
    "load": "LoadStateLoaded",
    "shardsNum": 1,
    "partitionsNum": 2,
    "consistencyLevel": "Bounded",
    "enableDynamicField": false,
    "externalSource": "",
    "externalSpec": "",
    "properties": []
  },
  "message": ""
}
```

A successful response makes its schema available in [Query](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/query/) and [Search](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/search/).

## Request fields

- `dbName` string
  Database name. Operations on collections use default when omitted.
- `collectionName` string (required)
  Name of the collection.

See [`HttpClient.describeCollection`](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describecollection) for the Node.js SDK method.
