Skip to content
MilvusNode SDK
Sections

Get by ID

Markdown

Copy for agent

Connection and CORS help

Use HTTPS for remote clusters or HTTP on loopback. Requests go directly from your browser to the endpoint. Run List collections to populate the collection selector. When copying an authenticated cURL command, set MILVUS_TOKEN in your shell.

For cross-origin requests, configure the endpoint to answer OPTIONS and allow the docs origin, POST, Content-Type, and Authorization if you use a token. Try the copied cURL command to troubleshoot outside the browser.

POST/v2/vectordb/entities/get

{
  "dbName": "default",
  "collectionName": "books",
  "id": [
    101
  ],
  "outputFields": [
    "title"
  ]
}

Example response

{
  "code": 0,
  "data": [
    {
      "id": 101,
      "title": "Invisible Cities"
    }
  ],
  "cost": 0
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/entities/get' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "collectionName": "books",
  "id": [
    101
  ],
  "outputFields": [
    "title"
  ]
}'

Fetch one or more entities by primary key from a loaded collection.

Request fields

dbName string
Database name. Operations on collections use default when omitted.
collectionName string (required)
Name of the collection.
partitionName string
Name of the partition.
partitionNames array of string
Names of the partitions to target.
outputFields array of string
Field names to include in the returned entities.
id JSON value (required)
Primary key or array of primary keys, matching the collection schema.
consistencyLevel string
Read consistency level, such as Strong, Session, or Bounded.

See HttpClient.get for the Node.js SDK method.