Skip to content
API Reference
Vector Stores

Files

List vector store files
GET/vector_stores/{vector_store_id}/files
Create vector store file
POST/vector_stores/{vector_store_id}/files
Update vector store file attributes
POST/vector_stores/{vector_store_id}/files/{file_id}
Retrieve vector store file
GET/vector_stores/{vector_store_id}/files/{file_id}
Delete vector store file
DELETE/vector_stores/{vector_store_id}/files/{file_id}
Retrieve vector store file content
GET/vector_stores/{vector_store_id}/files/{file_id}/content
ModelsExpand Collapse
VectorStoreFile = object { id, created_at, last_error, 6 more }

A list of files attached to a vector store.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

last_error: object { code, message }

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

code: "server_error" or "unsupported_file" or "invalid_file"

One of server_error, unsupported_file, or invalid_file.

Accepts one of the following:
"server_error"
"unsupported_file"
"invalid_file"
message: string

A human-readable description of the error.

object: "vector_store.file"

The object type, which is always vector_store.file.

status: "in_progress" or "completed" or "cancelled" or "failed"

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.

Accepts one of the following:
"in_progress"
"completed"
"cancelled"
"failed"
usage_bytes: number

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

vector_store_id: string

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

attributes: optional map[string or number or boolean]

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, booleans, or numbers.

Accepts one of the following:
UnionMember0 = string
UnionMember1 = number
UnionMember2 = boolean
chunking_strategy: optional StaticFileChunkingStrategyObject { static, type } or OtherFileChunkingStrategyObject { type }

The strategy used to chunk the file.

Accepts one of the following:
StaticFileChunkingStrategyObject = object { static, type }
static: StaticFileChunkingStrategy { chunk_overlap_tokens, max_chunk_size_tokens }
type: "static"

Always static.

OtherFileChunkingStrategyObject = object { type }

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.

type: "other"

Always other.

VectorStoreFileDeleted = object { id, deleted, object }
id: string
deleted: boolean
object: "vector_store.file.deleted"