Skip to main content

Get

Gets entities by the specified IDs. You can set an ID in string or integer or set a set of IDs in a list of strings or a list of integers as shown in the four types of request bodies below.

POST
/v1/vector/get
Cluster Endpoint

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

https://${CLUSTER_ENDPOINT}

📘Notes
  • You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
  • To get the endpoint, refer to Zilliz Cloud Console or use the Describe Cluster API to extract the values from the responses.
export CLUSTER_ENDPOINT=""
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or 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 which this operation applies.

partitionNamesarray

The name of the partitions to which this operation applies. Setting this indicates that the operation should be applied to only these partitions. If not set, the operation will be applied to all partitions in the collection.

[]partitionNamesstring

A partition name.

outputFieldsarray

An array of fields to return along with the query results.

[]outputFieldsstring

A field name.

idoneOfrequired
(To be added soon)

An array of IDs of the entities to be retrieved

An array of IDs of the entities to be retrieved

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v1/vector/get" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "quick_setup",
    "id": [
        1,
        3,
        5
    ],
    "outputFields": [
        "color"
    ]
}'
Responses200 - application/json
codeinteger

Response code.

dataarray

Query results.

[]dataobject

An entity object.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 200,
    "data": [
        {
            "color": "red_7025",
            "id": 1
        },
        {
            "color": "pink_9298",
            "id": 3
        },
        {
            "color": "yellow_4222",
            "id": 5
        }
    ]
}