Skip to content
Lucero

Retrieves a vector store file.

GET
/vector_stores/{vector_store_id}/files/{file_id}

Authorizations

Parameters

Path Parameters

vector_store_id
required
string
vs_abc123

The ID of the vector store that the file belongs to.

file_id
required
string
file-abc123

The ID of the file being retrieved.

Responses

200

OK

A list of files attached to a vector store.

object
id
required

The identifier, which can be referenced in API endpoints.

string
object
required

The object type, which is always vector_store.file.

string
Allowed values: vector_store.file
usage_bytes
required

The total vector store usage in bytes. Note that this may be different from the original file size.

integer
created_at
required

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

integer
vector_store_id
required

The ID of the vector store that the File is attached to.

string
status
required

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.

string
Allowed values: in_progress completed cancelled failed
last_error
required

The last error associated with this vector store file. Will be null if there are no errors.

object
code
required

One of server_error or rate_limit_exceeded.

string
Allowed values: server_error unsupported_file invalid_file
message
required

A human-readable description of the error.

string
chunking_strategy
One of:
object
type
required

Always static.

string
Allowed values: static
static
required
object
max_chunk_size_tokens
required

The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.

integer
>= 100 <= 4096
chunk_overlap_tokens
required

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.

integer