Skip to content
API Reference

Vector Stores

List vector stores
vector_stores.list(VectorStoreListParams**kwargs) -> SyncCursorPage[VectorStore]
GET/vector_stores
Create vector store
vector_stores.create(VectorStoreCreateParams**kwargs) -> VectorStore
POST/vector_stores
Retrieve vector store
vector_stores.retrieve(strvector_store_id) -> VectorStore
GET/vector_stores/{vector_store_id}
Modify vector store
vector_stores.update(strvector_store_id, VectorStoreUpdateParams**kwargs) -> VectorStore
POST/vector_stores/{vector_store_id}
Delete vector store
vector_stores.delete(strvector_store_id) -> VectorStoreDeleted
DELETE/vector_stores/{vector_store_id}
Search vector store
vector_stores.search(strvector_store_id, VectorStoreSearchParams**kwargs) -> SyncPage[VectorStoreSearchResponse]
POST/vector_stores/{vector_store_id}/search
ModelsExpand Collapse
class AutoFileChunkingStrategyParam: …

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

type: Literal["auto"]

Always auto.

FileChunkingStrategy

The strategy used to chunk the file.

Accepts one of the following:
class StaticFileChunkingStrategyObject: …
type: Literal["static"]

Always static.

class OtherFileChunkingStrategyObject: …

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: Literal["other"]

Always other.

FileChunkingStrategyParam

The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.

Accepts one of the following:
class AutoFileChunkingStrategyParam: …

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

type: Literal["auto"]

Always auto.

class StaticFileChunkingStrategyObjectParam: …

Customize your own chunking strategy by setting chunk size and chunk overlap.

type: Literal["static"]

Always static.

class OtherFileChunkingStrategyObject: …

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: Literal["other"]

Always other.

class StaticFileChunkingStrategy: …
chunk_overlap_tokens: int

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.

max_chunk_size_tokens: int

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

minimum100
maximum4096
class StaticFileChunkingStrategyObject: …
type: Literal["static"]

Always static.

class StaticFileChunkingStrategyObjectParam: …

Customize your own chunking strategy by setting chunk size and chunk overlap.

type: Literal["static"]

Always static.

class VectorStore: …

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

id: str

The identifier, which can be referenced in API endpoints.

created_at: int

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

file_counts: FileCounts
cancelled: int

The number of files that were cancelled.

completed: int

The number of files that have been successfully processed.

failed: int

The number of files that have failed to process.

in_progress: int

The number of files that are currently being processed.

total: int

The total number of files.

last_active_at: Optional[int]

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

metadata: Optional[Metadata]

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.

name: str

The name of the vector store.

object: Literal["vector_store"]

The object type, which is always vector_store.

status: Literal["expired", "in_progress", "completed"]

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.

Accepts one of the following:
"expired"
"in_progress"
"completed"
usage_bytes: int

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

expires_after: Optional[ExpiresAfter]

The expiration policy for a vector store.

anchor: Literal["last_active_at"]

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

days: int

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

minimum1
maximum365
expires_at: Optional[int]

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

class VectorStoreDeleted: …
id: str
deleted: bool
object: Literal["vector_store.deleted"]

Vector StoresFiles

List vector store files
vector_stores.files.list(strvector_store_id, FileListParams**kwargs) -> SyncCursorPage[VectorStoreFile]
GET/vector_stores/{vector_store_id}/files
Create vector store file
vector_stores.files.create(strvector_store_id, FileCreateParams**kwargs) -> VectorStoreFile
POST/vector_stores/{vector_store_id}/files
Update vector store file attributes
vector_stores.files.update(strfile_id, FileUpdateParams**kwargs) -> VectorStoreFile
POST/vector_stores/{vector_store_id}/files/{file_id}
Retrieve vector store file
vector_stores.files.retrieve(strfile_id, FileRetrieveParams**kwargs) -> VectorStoreFile
GET/vector_stores/{vector_store_id}/files/{file_id}
Delete vector store file
vector_stores.files.delete(strfile_id, FileDeleteParams**kwargs) -> VectorStoreFileDeleted
DELETE/vector_stores/{vector_store_id}/files/{file_id}
Retrieve vector store file content
vector_stores.files.content(strfile_id, FileContentParams**kwargs) -> SyncPage[FileContentResponse]
GET/vector_stores/{vector_store_id}/files/{file_id}/content
ModelsExpand Collapse
class VectorStoreFile: …

A list of files attached to a vector store.

id: str

The identifier, which can be referenced in API endpoints.

created_at: int

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

last_error: Optional[LastError]

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

code: Literal["server_error", "unsupported_file", "invalid_file"]

One of server_error, unsupported_file, or invalid_file.

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

A human-readable description of the error.

object: Literal["vector_store.file"]

The object type, which is always vector_store.file.

status: Literal["in_progress", "completed", "cancelled", "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: int

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

vector_store_id: str

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

attributes: Optional[Dict[str, Union[str, float, bool]]]

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:
str
float
bool
chunking_strategy: Optional[FileChunkingStrategy]

The strategy used to chunk the file.

class VectorStoreFileDeleted: …
id: str
deleted: bool
object: Literal["vector_store.file.deleted"]

Vector StoresFile Batches

Create vector store file batch
vector_stores.file_batches.create(strvector_store_id, FileBatchCreateParams**kwargs) -> VectorStoreFileBatch
POST/vector_stores/{vector_store_id}/file_batches
Retrieve vector store file batch
vector_stores.file_batches.retrieve(strbatch_id, FileBatchRetrieveParams**kwargs) -> VectorStoreFileBatch
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}
Cancel vector store file batch
vector_stores.file_batches.cancel(strbatch_id, FileBatchCancelParams**kwargs) -> VectorStoreFileBatch
POST/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
List vector store files in a batch
vector_stores.file_batches.list_files(strbatch_id, FileBatchListFilesParams**kwargs) -> SyncCursorPage[VectorStoreFile]
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/files
ModelsExpand Collapse
class VectorStoreFileBatch: …

A batch of files attached to a vector store.

id: str

The identifier, which can be referenced in API endpoints.

created_at: int

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

file_counts: FileCounts
cancelled: int

The number of files that where cancelled.

completed: int

The number of files that have been processed.

failed: int

The number of files that have failed to process.

in_progress: int

The number of files that are currently being processed.

total: int

The total number of files.

object: Literal["vector_store.files_batch"]

The object type, which is always vector_store.file_batch.

status: Literal["in_progress", "completed", "cancelled", "failed"]

The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.

Accepts one of the following:
"in_progress"
"completed"
"cancelled"
"failed"
vector_store_id: str

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