Skip to content
API Reference
Vector Stores

List vector stores

client.VectorStores.List(ctx, query) (*CursorPage[VectorStore], error)
GET/vector_stores

Returns a list of vector stores.

ParametersExpand Collapse
query VectorStoreListParams
After param.Field[string]optional

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 param.Field[string]optional

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 param.Field[int64]optional

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

Order param.Field[VectorStoreListParamsOrder]optional

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

const VectorStoreListParamsOrderAsc VectorStoreListParamsOrder = "asc"
const VectorStoreListParamsOrderDesc VectorStoreListParamsOrder = "desc"
ReturnsExpand Collapse
type VectorStore struct{…}

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

ID string

The identifier, which can be referenced in API endpoints.

CreatedAt int64

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

FileCounts VectorStoreFileCounts
Cancelled int64

The number of files that were cancelled.

Completed int64

The number of files that have been successfully processed.

Failed int64

The number of files that have failed to process.

InProgress int64

The number of files that are currently being processed.

Total int64

The total number of files.

LastActiveAt int64

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

Metadata Metadata

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 VectorStore

The object type, which is always vector_store.

Status VectorStoreStatus

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.

Accepts one of the following:
const VectorStoreStatusExpired VectorStoreStatus = "expired"
const VectorStoreStatusInProgress VectorStoreStatus = "in_progress"
const VectorStoreStatusCompleted VectorStoreStatus = "completed"
UsageBytes int64

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

ExpiresAfter VectorStoreExpiresAfteroptional

The expiration policy for a vector store.

Anchor LastActiveAt

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

Days int64

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

minimum1
maximum365
ExpiresAt int64optional

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

List vector stores

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.VectorStores.List(context.TODO(), openai.VectorStoreListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "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"
}
Returns Examples
{
  "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"
}