deprecated_vector_stores

[DEPRECATED] Perform semantic search across vector store chunks

DEPRECATED: Use POST /stores/search instead

post/v1/vector_stores/search

Request body

querystring required

Search query text

top_kinteger

Number of results to return

file_idsstring[] nullable

Optional list of file IDs to filter chunks by (inclusion filter)

Example request

{
  "query": "how to configure SSL",
  "filters": {
    "all": [
      {
        "key": "price",
        "operator": "gt",
        "value": "100"
      },
      {
        "key": "color",
        "operator": "eq",
        "value": "red"
      }
    ],
    "any": [
      {
        "key": "price",
        "operator": "gt",
        "value": "100"
      },
      {
        "key": "color",
        "operator": "eq",
        "value": "red"
      }
    ],
    "none": [
      {
        "key": "price",
        "operator": "gt",
        "value": "100"
      },
      {
        "key": "color",
        "operator": "eq",
        "value": "red"
      }
    ]
  },
  "file_ids": [
    "123e4567-e89b-12d3-a456-426614174000",
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "search_options": {
    "rerank": {
      "model": "rerank_model",
      "top_k": 10
    }
  }
}

Response

List of semantically similar chunks with relevance scores and pagination details

object'list'

The object type of the response

Example response

{
  "data": [
    {
      "mime_type": "text/plain",
      "model": "text-embedding-ada-002",
      "score": 0.5,
      "file_id": "file1",
      "filename": "file1",
      "vector_store_id": "store1",
      "metadata": {
        "key": "value"
      },
      "context": "This chunk is from an SEC filing on ACME corp's Q2 2023 performance.",
      "summary": "A short overview of ACME's Q2 2023 performance."
    }
  ]
}

Changes

Changed in 4 of the 30 revisions of this API.419

Sep 15, 2026957bf8ec8df844See the full diff
- ▲
  added to the //// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the //// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the //// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the //// response property oneOf list for the response status
  response-property-one-of-added
- ○
  added csv discriminator mapping keys to the //// response property for the response status
  response-property-discriminator-mapping-added
- ○
  added csv discriminator mapping keys to the //// response property for the response status
  response-property-discriminator-mapping-added
- ○
  added csv discriminator mapping keys to the //// response property for the response status
  response-property-discriminator-mapping-added
- ○
  added csv discriminator mapping keys to the //// response property for the response status
  response-property-discriminator-mapping-added
Sep 8, 2026ce403656bc181See the full diff
- ●
  the request property's max was set to 10000.00
  request-property-max-set
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 29, 2026b4acfee365751See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
Jul 26, 2026587cbdf607b04See the full diff
- ○
  the request property default value changed from mixedbread-ai/mxbai-rerank-v3-listwise to mixedbread-ai/mxbai-rerank-v3.1-listwise
  request-property-default-value-changed
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history