Returns a list of vector stores.

GET /vector_stores

Returns a list of vector stores.

cURL

curl --request GET \
  --url https://api.openai.com/v1/vector_stores \
  --header 'Authorization: Bearer <token>'

200

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "vector_store",
      "created_at": 123,
      "name": "<string>",
      "usage_bytes": 123,
      "file_counts": {
        "in_progress": 123,
        "completed": 123,
        "failed": 123,
        "cancelled": 123,
        "total": 123
      },
      "status": "expired",
      "last_active_at": 123,
      "metadata": {},
      "expires_after": {
        "anchor": "last_active_at",
        "days": 183
      },
      "expires_at": 123
    }
  ],
  "first_id": "vs_abc123",
  "last_id": "vs_abc456",
  "has_more": false
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer · default: 20

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order · enum<string> · default: desc

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

Available options: asc, desc

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

200 - application/json

OK

object · string · required

Example:

"list"

data · Vector store · object[] · required

Show child attributes

first_id · string · required

Example:

"vs_abc123"

last_id · string · required

Example:

"vs_abc456"

has_more · boolean · required

Example:

false