API Reference

Vector Stores

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

File 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.