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.

list 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 Get record IDs.

Note: list is supported only for serverless indexes.

Authorizations

Api-Key

string

headerrequired

An API Key is required to call Pinecone APIs. Get yours at https://www.pinecone.io/start/

Query Parameters

prefix

string

The vector IDs to fetch. Does not accept values containing spaces.

limit

integer

default: 100

Max number of IDs to return.

paginationToken

string

Pagination token to continue a previous listing operation.

namespace

string

Response

200 - application/json

The response for the List operation.

vectors

object[]

Show child attributes

pagination

object

Show child attributes

namespace

string

The namespace of the vectors.