OpenAI

OpenAI Vector stores API

The Vector stores API from OpenAI — 10 operation(s) for vector stores.

Documentation GitHub OpenAPI

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /vector_stores List my vector stores · List vector stores #

Ask an LLM

“Which vector stores have I created for file search?”

“Can I page through all my vector stores in ascending order?”

Tell an agent

List all of my vector stores.

Show the {limit} newest vector stores in my account.

POST /vector_stores Create a vector store · Create vector store #

Ask an LLM

“How do I set up a new vector store so my assistant can search my documents?”

“Can I make a vector store expire automatically after it goes unused?”

Tell an agent

Create a vector store named {name}.

Create a new vector store called {name} seeded with files {file_ids}.

GET /vector_stores/{vector_store_id} Retrieve a vector store · Retrieve vector store #

Ask an LLM

“How many files are in a vector store and are they done processing?”

“What's the current status and size of one of my vector stores?”

Tell an agent

Get vector store {vector_store_id}.

Show the file counts and status of vector store {vector_store_id}.

POST /vector_stores/{vector_store_id} Rename or update a vector store · Modify vector store #

Ask an LLM

“Can I rename a vector store after creating it?”

“Can I change the expiration policy on an existing vector store?”

Tell an agent

Rename vector store {vector_store_id} to {name}.

Change the expiration policy of existing vector store {vector_store_id} to {expires_after}.

DELETE /vector_stores/{vector_store_id} Delete a vector store · Delete vector store #

Ask an LLM

“How do I get rid of a vector store I'm done with?”

“What happens when I delete an entire vector store?”

Tell an agent destructive · confirm first

Delete vector store {vector_store_id}.

Permanently remove the whole vector store {vector_store_id}.

POST /vector_stores/{vector_store_id}/file_batches Add many files to a vector store at once · Create vector store file batch #

Ask an LLM

“What's the most efficient way to add hundreds of files to a vector store in one go?”

“How many files can I put in a single vector store file batch?”

Tell an agent

Add files {file_ids} to vector store {vector_store_id} as one batch.

Start a file batch on vector store {vector_store_id} with files {file_ids} using chunking strategy {chunking_strategy}.

GET /vector_stores/{vector_store_id}/file_batches/{batch_id} Check a vector store file batch · Retrieve vector store file batch #

Ask an LLM

“Has my batch of files finished indexing into the vector store?”

“Can I see how many files in a batch completed or failed?”

Tell an agent

Get file batch {batch_id} on vector store {vector_store_id}.

Check the progress of batch {batch_id} in vector store {vector_store_id}.

POST /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel Cancel a vector store file batch · Cancel vector store file batch #

Ask an LLM

“Can I stop a file batch that's still being processed into a vector store?”

“How do I cancel a batch upload I started by mistake?”

Tell an agent destructive · confirm first

Cancel file batch {batch_id} on vector store {vector_store_id}.

Stop processing the files in batch {batch_id} for vector store {vector_store_id}.

GET /vector_stores/{vector_store_id}/file_batches/{batch_id}/files List the files in a file batch · List vector store files in a batch #

Ask an LLM

“Which files were part of a particular vector store batch?”

“Can I see only the files from a batch that failed to process?”

Tell an agent

List the files in batch {batch_id} of vector store {vector_store_id}.

Show files with status {filter} in batch {batch_id} on vector store {vector_store_id}.

GET /vector_stores/{vector_store_id}/files List files in a vector store · List vector store files #

Ask an LLM

“What files are currently indexed in my vector store?”

“Can I filter a vector store's files to only those still in progress?”

Tell an agent

List every file in vector store {vector_store_id}.

Show the {filter} files across all of vector store {vector_store_id}.

POST /vector_stores/{vector_store_id}/files Add a single file to a vector store · Create vector store file #

Ask an LLM

“How do I add one uploaded file to an existing vector store?”

“Can I tag a file with attributes as I add it to a vector store?”

Tell an agent

Add file {file_id} to vector store {vector_store_id}.

Attach file {file_id} to vector store {vector_store_id} with attributes {attributes}.

GET /vector_stores/{vector_store_id}/files/{file_id} Retrieve a file in a vector store · Retrieve vector store file #

Ask an LLM

“Did a particular file finish indexing in my vector store?”

“Why did one vector store file fail to process?”

Tell an agent

Get vector store file {file_id} in {vector_store_id}.

Check the indexing status of file {file_id} in vector store {vector_store_id}.

DELETE /vector_stores/{vector_store_id}/files/{file_id} Remove a file from a vector store · Delete vector store file #

Ask an LLM

“Can I take a file out of a vector store without deleting the file itself?”

“Does removing a file from a vector store also delete the uploaded file?”

Tell an agent destructive · confirm first

Remove file {file_id} from vector store {vector_store_id}.

Drop file {file_id} out of vector store {vector_store_id} but keep the original upload.

POST /vector_stores/{vector_store_id}/files/{file_id} Update attributes on a vector store file · Update vector store file attributes #

Ask an LLM

“Can I change the filterable attributes on a file that's already in a vector store?”

“How do I re-tag an indexed file so search filters pick it up?”

Tell an agent

Set attributes {attributes} on file {file_id} in vector store {vector_store_id}.

Replace the attributes of already-indexed file {file_id} in {vector_store_id} with {attributes}.

GET /vector_stores/{vector_store_id}/files/{file_id}/content Read the parsed contents of a vector store file · Retrieve vector store file content #

Ask an LLM

“What text did the vector store actually extract from my file?”

“Can I see the parsed content of a file after it was indexed?”

Tell an agent

Show the parsed content of file {file_id} in vector store {vector_store_id}.

Get the extracted text for vector store file {file_id} from {vector_store_id}.

POST /vector_stores/{vector_store_id}/search Search a vector store · Search vector store #

Ask an LLM

“How do I find the most relevant chunks in my vector store for a question?”

“Can I limit a vector store search to files with certain attributes?”

Tell an agent

Search vector store {vector_store_id} for {query}.

Find the top {max_num_results} chunks matching {query} in vector store {vector_store_id}.

OpenAI Vector stores API

Operations 16

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification