Returns a list of vector store files.
GET /vector_stores/{vector_store_id}/files
Authorizations
Parameters
Path Parameters
The ID of the vector store that the files belong to.
Query Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
Sort order by the created_at
timestamp of the objects. asc
for ascending order and desc
for descending order.
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.
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.
Filter by file status. One of in_progress
, completed
, failed
, cancelled
.
Responses
200
OK
object
A list of files attached to a vector store.
object
The identifier, which can be referenced in API endpoints.
The object type, which is always vector_store.file
.
The total vector store usage in bytes. Note that this may be different from the original file size.
The Unix timestamp (in seconds) for when the vector store file was created.
The ID of the vector store that the File is attached to.
The status of the vector store file, which can be either in_progress
, completed
, cancelled
, or failed
. The status completed
indicates that the vector store file is ready for use.
The last error associated with this vector store file. Will be null
if there are no errors.
object
One of server_error
or rate_limit_exceeded
.
A human-readable description of the error.
object
Always static
.
object
The maximum number of tokens in each chunk. The default value is 800
. The minimum value is 100
and the maximum value is 4096
.
The number of tokens that overlap between chunks. The default value is 400
.
Note that the overlap must not exceed half of max_chunk_size_tokens
.
This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy
concept was introduced in the API.
object
Always other
.