POST

Try POST /vector_stores/{vector_store_id}/search — OpenAI API

OpenAI playground

Search vector store

Credentials

OpenAI API key · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.openai.com; the proxy stores and logs nothing about them.

Path

vector_store_id · required · string The ID of the vector store to search.

Body application/json

5 body fields

query · required · string — A query string for a search
rewrite_query · optional · boolean — Whether to rewrite the natural language query for vector search.
max_num_results · optional · integer — The maximum number of results to return. This number should be between 1 and 50 inclusive.
filters · optional · object — A filter to apply based on file attributes.
ranking_options · optional · object — Ranking options for search.