## List vector stores

`$ openai vector-stores list`

**get** `/vector_stores`

Returns a list of vector stores.

### Parameters

- `--after: optional 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: optional 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.

- `--limit: optional number`

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

- `--order: optional "asc" or "desc"`

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

### Returns

- `ListVectorStoresResponse: object { data, first_id, has_more, 2 more }`

  - `data: array of VectorStore`

    - `id: string`

      The identifier, which can be referenced in API endpoints.

    - `created_at: number`

      The Unix timestamp (in seconds) for when the vector store was created.

    - `file_counts: object { cancelled, completed, failed, 2 more }`

      - `cancelled: number`

        The number of files that were cancelled.

      - `completed: number`

        The number of files that have been successfully processed.

      - `failed: number`

        The number of files that have failed to process.

      - `in_progress: number`

        The number of files that are currently being processed.

      - `total: number`

        The total number of files.

    - `last_active_at: number`

      The Unix timestamp (in seconds) for when the vector store was last active.

    - `metadata: map[string]`

      Set of 16 key-value pairs that can be attached to an object. This can be
      useful for storing additional information about the object in a structured
      format, and querying for objects via API or the dashboard.

      Keys are strings with a maximum length of 64 characters. Values are strings
      with a maximum length of 512 characters.

    - `name: string`

      The name of the vector store.

    - `object: "vector_store"`

      The object type, which is always `vector_store`.

    - `status: "expired" or "in_progress" or "completed"`

      The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use.

      - `"expired"`

      - `"in_progress"`

      - `"completed"`

    - `usage_bytes: number`

      The total number of bytes used by the files in the vector store.

    - `expires_after: optional object { anchor, days }`

      The expiration policy for a vector store.

      - `anchor: "last_active_at"`

        Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.

      - `days: number`

        The number of days after the anchor time that the vector store will expire.

    - `expires_at: optional number`

      The Unix timestamp (in seconds) for when the vector store will expire.

  - `first_id: string`

  - `has_more: boolean`

  - `last_id: string`

  - `object: string`

### Example

```cli
openai vector-stores list \
  --api-key 'My API Key'
```

#### Response

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