List vector IDs
The list
operation lists the IDs of vectors in a single namespace of a serverless index. An optional prefix can be passed to limit the results to IDs with a common prefix.
By default, list
returns up to 100 IDs per page 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_vectors
is supported only for serverless indexes.
Authorizations
An API Key is required to call Pinecone APIs. Get yours from the console.
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.
Response
The response for the list
operation.
The namespace of the vectors.
Was this page helpful?