Search Chunks

POST/v1/stores/search

Authorization

Authorizationstringrequired

Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Request Body

querystringrequired

Search query text

Constraints

•Minimum length: 1

store_identifiersarray | null

IDs or names of stores to search. This can be stores in your org or `mixedbread/web` for the web-store.

top_kintegerdefault: 10

Number of results to return

Constraints

•Minimum: 1

file_idsarray | array

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

Constraints

•Minimum items: 2•Maximum items: 2

Response Body

objectstringdefault: list

The object type of the response

Request

POST/v1/stores/search

from mixedbread import Mixedbread

mxbai = Mixedbread(api_key="YOUR_API_KEY")

response = mxbai.stores.search(
    query="How does authentication work?",
    store_identifiers=["my-knowledge-base"],
    top_k=5,
)

for chunk in response.data:
    print(chunk)

Response

JSON

{
  "object": "list",
  "data": [
    {
      "chunk_index": 0,
      "mime_type": "text/plain",
      "model": "mxbai-omni",
      "score": 0.8512,
      "file_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "filename": "auth_guide.pdf",
      "store_id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "metadata": {
        "source": "upload",
        "page": 1
      },
      "type": "text",
      "text": "Authentication is handled through JWT tokens. First, the user provides credentials..."
    },
    {
      "chunk_index": 2,
      "mime_type": "image/jpeg",
      "model": "mxbai-omni",
      "score": 0.8234,
      "file_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "filename": "security_diagram.pdf",
      "store_id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "metadata": {
        "category": "security",
        "year": 2024
      },
      "type": "image_url",
      "image_url": {
        "url": "https://example.com/auth-flow.jpg",
        "format": "jpeg"
      },
      "ocr_text": "Authentication Flow Diagram",
      "summary": "A diagram showing the OAuth 2.0 authentication flow"
    }
  ]
}