The Mixedbread Vercel integration makes it easy to add our powerful Search API to your Vercel projects. It allows you to create organizations and Stores directly from Vercel and connect them with your projects. You can start with a template, connect the environment variables and manage everything from the Vercel dashboard.

How It Works

The Mixedbread Vercel integration provides a streamlined workflow for working with our Search API:

• Team Installation → Creates a Mixedbread organization linked to your Vercel account
• Install Products → Each product creates a Store in your organization
• Connect Projects → Link Stores to Vercel projects with automatic environment variable injection
• Unified Billing → All usage is billed through your Vercel account

Getting Started

Install the Integration

1. Navigate to the Mixedbread Integration
2. Click Install and choose your team or personal account scope
3. Accept the permissions to allow Mixedbread to manage resources

The installation flow includes the creation of your Mixedbread organization and your first Store. You are granted the owner role with full access to manage Stores and team members.

Create a Store

Install Your First Product

1. From the Mixedbread integration page in Vercel, click Install to add a new product
2. Configure your Store:
   • Name - A descriptive identifier for your Store
   • Description - Optional context about the Store's purpose (optional)
   • Public Read - Enable public read access without authentication (optional)
3. Confirm to provision the Store

The product creator is granted the admin role in the Mixedbread organization if they are not the owner. The Store is immediately available for connecting to projects.

Add More Stores

You can create multiple Stores from the Vercel integration page to organize different use cases, environments, or applications. Each Store can be independently configured and connected to different projects.

Connect to Projects

Link Stores to Vercel Projects

1. In the Mixedbread integration page, click Connect Project
2. Select one or more Vercel projects to link
3. Environment variables are automatically added to your selected projects:
   • MXBAI_API_KEY - Authentication key for API requests
   • MXBAI_STORE_ID - The unique identifier for your Store
4. Redeploy your projects to access the new environment variables

Multi-Project Connections

A single Store can be connected to multiple Vercel projects, making it ideal for:

• Sharing data between staging and production environments
• Connecting multiple microservices to the same knowledge base
• Providing consistent search across different applications

Each connected project receives the same environment variables for seamless access.

Managing the Integration

Team Permissions

Permissions are automatically synchronized between Vercel and Mixedbread:

• Integration Creator → Mixedbread Organization Owner
• Resource Creators → Mixedbread Organization Admins

Team members can access and manage Stores based on their assigned roles in the Mixedbread organization.

Monitor Usage and Billing

• Billing: All usage is billed through your Vercel account
• Usage Metrics: View detailed usage statistics and analytics in both Vercel dashboard and Mixedbread dashboard
• Cost Tracking: Monitor consumption across all stores and projects in the Vercel billing dashboard

Uninstalling the Integration

When you uninstall the Mixedbread integration from Vercel:

• The associated Mixedbread organization is deleted
• All Stores in the organization become inaccessible
• Connected applications will fail API requests

Before uninstalling, ensure no production applications depend on the Stores and remove environment variables from your projects if necessary.