Web Store

The Web Store lets you search the web using the same familiar Store API. Instead of searching your uploaded documents, it searches the internet and returns results in the same format as regular store searches.

Basic Web Search

Search the web by using mixedbread/web as a store identifier:

from mixedbread import Mixedbread

mxbai = Mixedbread(api_key="YOUR_API_KEY")

results = mxbai.stores.search(
    query="latest developments in transformer architectures",
    store_identifiers=["mixedbread/web"],
    top_k=10,
)

for chunk in results.data:
    print(f"Title: {chunk.metadata.get('title')}")
    print(f"URL: {chunk.metadata.get('url')}")
    print(f"Content: {chunk.text[:200]}...")
    print()

Each result includes the page title, the source URL (available in both the filename field and metadata.url), and relevant excerpts from the page content.

Hybrid Search: Web + Your Data

Combine web results with your own stores for comprehensive search. This is useful when you want to augment your internal knowledge base with up-to-date information from the web.

from mixedbread import Mixedbread

mxbai = Mixedbread(api_key="YOUR_API_KEY")

results = mxbai.stores.search(
    query="how to implement rate limiting",
    store_identifiers=[
        "mixedbread/web",  # Search the web
        "internal-docs",  # Your documentation store
        "code-examples",  # Your code examples store
    ],
    top_k=15,
)

print(results)

When combining web search with regular stores, results from all sources are merged together and reranked for consistent relevance scoring. The final response contains the top results based on combined relevance across all sources.

Response Format

Web search results follow the same structure as regular store search results:

{
  "object": "list",
  "data": [
    {
      "type": "text",
      "text": "Page title\n\nRelevant excerpts from the page content...",
      "chunk_index": 0,
      "score": 0.95,
      "file_id": "generated-uuid-from-url",
      "filename": "https://example.com/article",
      "store_id": "00000000-0000-0000-0000-000000000001",
      "metadata": {
        "title": "Page Title",
        "url": "https://example.com/article",
        "source": "web_search"
      }
    }
  ]
}

• text: Contains the page title followed by relevant excerpts
• filename: The source URL
• metadata.url: The source URL (same as filename)
• metadata.title: The page title
• metadata.source: Always "web_search" for web results
• store_id: Fixed ID for the web store

Considerations

Web search results are always reranked for optimal relevance. Usage counts toward your API rate limits like any other store search.

Note that metadata filters such as file_ids do not apply to web search results. Results reflect current web content at search time, providing fresh information for your queries.