Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).
POST /vector_stores/{vector_store_id}/files
Authorizations
Parameters
Path Parameters
The ID of the vector store for which to create a File.
Request Body required
object
A File ID that the vector store should use. Useful for tools like file_search
that can access files.
The default strategy. This strategy currently uses a max_chunk_size_tokens
of 800
and chunk_overlap_tokens
of 400
.
object
Always auto
.
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
.
Responses
200
OK
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
.