API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Vector Stores

Create vector store

$ openai vector-stores create

POST/vector_stores

Delete vector store

$ openai vector-stores delete

DELETE/vector_stores/{vector_store_id}

List vector stores

$ openai vector-stores list

GET/vector_stores

Retrieve vector store

$ openai vector-stores retrieve

GET/vector_stores/{vector_store_id}

Search vector store

$ openai vector-stores search

POST/vector_stores/{vector_store_id}/search

Modify vector store

$ openai vector-stores update

POST/vector_stores/{vector_store_id}

ModelsExpand Collapse

auto_file_chunking_strategy_param: object { type }

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

file_chunking_strategy: StaticFileChunkingStrategyObject { static, type } or OtherFileChunkingStrategyObject { type }

The strategy used to chunk the file.

file_chunking_strategy_param: AutoFileChunkingStrategyParam { type } or StaticFileChunkingStrategyObjectParam { static, type }

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.

other_file_chunking_strategy_object: 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.

static_file_chunking_strategy: object { chunk_overlap_tokens, max_chunk_size_tokens }

static_file_chunking_strategy_object: object { static, type }

static_file_chunking_strategy_object_param: object { static, type }

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

vector_store: object { id, created_at, file_counts, 8 more }

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

vector_store_deleted: object { id, deleted, object }

Vector StoresFile Batches

Cancel vector store file batch

$ openai vector-stores:file-batches cancel

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

Create vector store file batch

$ openai vector-stores:file-batches create

POST/vector_stores/{vector_store_id}/file_batches

List vector store files in a batch

$ openai vector-stores:file-batches list-files

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

Retrieve vector store file batch

$ openai vector-stores:file-batches retrieve

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

ModelsExpand Collapse

vector_store_file_batch: object { id, created_at, file_counts, 3 more }

A batch of files attached to a vector store.

Vector StoresFiles

Retrieve vector store file content

$ openai vector-stores:files content

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

Create vector store file

$ openai vector-stores:files create

POST/vector_stores/{vector_store_id}/files

Delete vector store file

$ openai vector-stores:files delete

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

List vector store files

$ openai vector-stores:files list

GET/vector_stores/{vector_store_id}/files

Retrieve vector store file

$ openai vector-stores:files retrieve

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

Update vector store file attributes

$ openai vector-stores:files update

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

ModelsExpand Collapse

vector_store_file: object { id, created_at, last_error, 6 more }

A list of files attached to a vector store.

vector_store_file_deleted: object { id, deleted, object }