List record IDs
List the IDs of records in a single namespace of a serverless index. An optional prefix can be passed to limit the results to IDs with a common prefix.
Returns up to 100 IDs at a time by default in sorted order (bitwise "C" collation). If the limit parameter is set, list returns up to that number of IDs instead. Whenever there are additional IDs to return, the response also includes a pagination_token that you can use to get the next batch of IDs. When the response does not include a pagination_token, there are no more IDs to return.
For guidance and examples, see List record IDs.
Note: list is supported only for serverless indexes.
Query parameters
The vector IDs to fetch. Does not accept values containing spaces.
Max number of IDs to return per page.
Pagination token to continue a previous listing operation.
The namespace to list vectors from. If not provided, the default namespace is used.
Headers
Required date-based version header
Response
A successful response.
Example response
{
"vectors": [
{
"id": "document1#abb"
},
{
"id": "document1#abc"
}
],
"pagination": {
"next": "Tm90aGluZyB0byBzZWUgaGVyZQo="
},
"namespace": "example-namespace",
"usage": {
"readUnits": 5
}
}