List vector stores

GEThttps:/api.openai.com/v1/vector_stores

Returns a list of vector stores.

Query parameters

limit
integer
Defaults: 20
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
order
string
Defaults: desc
Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
after
string
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.
before
string
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.

Response

A list of vector store objects.

Example request

1curl https://api.openai.com/v1/vector_stores \
2  -H "Authorization: Bearer $OPENAI_API_KEY" \
3  -H "Content-Type: application/json" \
4  -H "OpenAI-Beta: assistants=v2"

Example response

1{
2  "object": "list",
3  "data": [
4    {
5      "id": "vs_abc123",
6      "object": "vector_store",
7      "created_at": 1699061776,
8      "name": "Support FAQ",
9      "bytes": 139920,
10      "file_counts": {
11        "in_progress": 0,
12        "completed": 3,
13        "failed": 0,
14        "cancelled": 0,
15        "total": 3
16      }
17    },
18    {
19      "id": "vs_abc456",
20      "object": "vector_store",
21      "created_at": 1699061776,
22      "name": "Support FAQ v2",
23      "bytes": 139920,
24      "file_counts": {
25        "in_progress": 0,
26        "completed": 3,
27        "failed": 0,
28        "cancelled": 0,
29        "total": 3
30      }
31    }
32  ],
33  "first_id": "vs_abc123",
34  "last_id": "vs_abc456",
35  "has_more": false
36}

Built with