Skip to content
🌕 Lucero

Returns a list of vector stores.

GET
/vector_stores

Authorizations

Parameters

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
string
default: desc
Allowed values: asc 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, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Responses

200

OK

object
object
required
string
list
data
required
Array<object>

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

object
id
required

The identifier, which can be referenced in API endpoints.

string
object
required

The object type, which is always vector_store.

string
Allowed values: vector_store
created_at
required

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

integer
name
required

The name of the vector store.

string
usage_bytes
required

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

integer
file_counts
required
object
in_progress
required

The number of files that are currently being processed.

integer
completed
required

The number of files that have been successfully processed.

integer
failed
required

The number of files that have failed to process.

integer
cancelled
required

The number of files that were cancelled.

integer
total
required

The total number of files.

integer
status
required

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.

string
Allowed values: expired in_progress completed
expires_after

The expiration policy for a vector store.

object
anchor
required

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

string
Allowed values: last_active_at
days
required

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

integer
>= 1 <= 365
expires_at

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

integer
nullable
last_active_at
required

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

integer
nullable
metadata
required

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. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

object
first_id
required
string
vs_abc123
last_id
required
string
vs_abc456
has_more
required
boolean