API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Vector Stores

Create vector store

VectorStore vectorStores().create(VectorStoreCreateParamsparams = VectorStoreCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/vector_stores

Delete vector store

VectorStoreDeleted vectorStores().delete(VectorStoreDeleteParamsparams = VectorStoreDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/vector_stores/{vector_store_id}

List vector stores

VectorStoreListPage vectorStores().list(VectorStoreListParamsparams = VectorStoreListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/vector_stores

Retrieve vector store

VectorStore vectorStores().retrieve(VectorStoreRetrieveParamsparams = VectorStoreRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/vector_stores/{vector_store_id}

Search vector store

VectorStoreSearchPage vectorStores().search(VectorStoreSearchParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/vector_stores/{vector_store_id}/search

Modify vector store

VectorStore vectorStores().update(VectorStoreUpdateParamsparams = VectorStoreUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/vector_stores/{vector_store_id}

ModelsExpand Collapse

class AutoFileChunkingStrategyParam:

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

class FileChunkingStrategy: A class that can be one of several variants.union

The strategy used to chunk the file.

class FileChunkingStrategyParam: A class that can be one of several variants.union

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.

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.

class StaticFileChunkingStrategy:

class StaticFileChunkingStrategyObject:

class StaticFileChunkingStrategyObjectParam:

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

class VectorStore:

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

class VectorStoreDeleted:

Vector StoresFile Batches

Cancel vector store file batch

VectorStoreFileBatch vectorStores().fileBatches().cancel(FileBatchCancelParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

Create vector store file batch

VectorStoreFileBatch vectorStores().fileBatches().create(FileBatchCreateParamsparams = FileBatchCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/vector_stores/{vector_store_id}/file_batches

List vector store files in a batch

FileBatchListFilesPage vectorStores().fileBatches().listFiles(FileBatchListFilesParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

Retrieve vector store file batch

VectorStoreFileBatch vectorStores().fileBatches().retrieve(FileBatchRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/vector_stores/{vector_store_id}/file_batches/{batch_id}

ModelsExpand Collapse

class VectorStoreFileBatch:

A batch of files attached to a vector store.

Vector StoresFiles

Retrieve vector store file content

FileContentPage vectorStores().files().content(FileContentParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Create vector store file

VectorStoreFile vectorStores().files().create(FileCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/vector_stores/{vector_store_id}/files

Delete vector store file

VectorStoreFileDeleted vectorStores().files().delete(FileDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

DELETE/vector_stores/{vector_store_id}/files/{file_id}

List vector store files

FileListPage vectorStores().files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/vector_stores/{vector_store_id}/files

Retrieve vector store file

VectorStoreFile vectorStores().files().retrieve(FileRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Update vector store file attributes

VectorStoreFile vectorStores().files().update(FileUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/vector_stores/{vector_store_id}/files/{file_id}

ModelsExpand Collapse

class VectorStoreFile:

A list of files attached to a vector store.

class VectorStoreFileDeleted: