Returns a list of vector stores.

GET /vector_stores

Copy endpoint

https://api.openai.com/v1

Parameters

query Query Parameters

Name	Type
`limit` A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.	number
`order` Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.	"asc" \| "desc"
`after` A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.	string
`before` A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.	string

Responses

200 application/json

interface ListVectorStoresResponse {
object: string;
data:

VectorStoreObject

A vector store is a collection of processed files can be used by the file_search tool.

interface VectorStoreObject {
id: string;
object: "vector_store";
created_at: number;
name: string;
usage_bytes: number;
file_counts: {
in_progress: number;
completed: number;
failed: number;
cancelled: number;
total: number;
};
status: "expired" | "in_progress" | "completed";
expires_after?: VectorStoreExpirationAfter;
expires_at?: number | null;
last_active_at: number | null;
metadata: Metadata;
}

[];
first_id: string;
last_id: string;
has_more: boolean;
}