Skip to content

mixedbread-ai/mxbai-image-search

Repository files navigation

Mixedbread Image Search

This minimal template demonstrates how to build semantic image search with natural language queries using the Mixedbread Search API.

Getting Started

Prerequisites

  • Bun (or Node.js 22+)
  • Git

1. Clone the Repository

git clone <your-repo-url>
cd mxbai-image-search

2. Install Dependencies

bun install

3. Set Up Environment Variables

Create a .env file in the root directory:

cp .env.example .env

Add your Mixedbread credentials to the .env file:

MXBAI_API_KEY=your-api-key-here
MXBAI_STORE_ID=your-store-id

To get your API key and Store ID, you have two options:

  1. From Vercel Integration (Recommended if deploying to Vercel):

  2. From Mixedbread Platform (For standalone use):

    • Visit the Mixedbread Platform
    • Sign up or log in to your account
    • Navigate to API Keys and create a new key
    • Navigate to Stores and create a new Store, then copy the Store ID

4. Upload Images to Your Store

The project includes a script to upload images to your Mixedbread Store:

bun scripts/upload-images.ts ./public/images

This will process all images in the ./public/images directory and upload them to your Store.

5. Run the Application

Start the development server:

bun dev

Open http://localhost:3000 in your browser and start searching for images using natural language queries.

Learn More

Mixedbread Resources

About

A starter template for building semantic image search with Mixedbread

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •