Quickstart

This quickstart walks you through building powerful Search with Mixedbread's Stores. You'll turn your files into a searchable knowledge base and explore it using natural language queries.

Pick the approach that fits your workflow: use our SDKs for seamless programmatic control and integration into your applications, or run everything directly in your terminal with the CLI for streamlined scripting and automation.

Using the SDK

Before you begin, make sure you have:

1. API Key: Get your API key from the API Keys page
2. SDK Installed: Install the Mixedbread SDK for your preferred language

Python

pip install mixedbread

TypeScript

npm install @mixedbread/sdk

Create a Store, upload your files, and search with natural language:

Working with Metadata

Add metadata during upload to categorize files and filter during search:

Use metadata to organize files by category, department, or any custom attribute, then search only the relevant subsets.

Using the CLI

Before you begin, make sure you have:

1. API Key: Get your API key from the API Keys page
2. CLI Installed: Install the Mixedbread CLI using your preferred package manager

npm install -g @mixedbread/cli

# Save your API key (one-time setup)
mxbai config keys add YOUR_API_KEY default

# Create a Store
mxbai store create "my-knowledge-base"

# Upload and process your files (PDFs, images, docs, code)
mxbai store upload "my-knowledge-base" ./documents/

# Search your data with natural language
mxbai store search "my-knowledge-base" "What are the key features?"