Store Management

Stores transform any data into AI-native search engines that understand meaning, not just keywords. They act as containers for your files, automatically generating embeddings and enabling advanced search capabilities. Use these commands to create, manage, and organize your stores. Learn more about stores in the documentation.

List Stores

Command

mxbai store list [options]

Options

--filter <name> - Filter by name pattern
--limit <n> - Limit number of results

Examples

# List all stores
mxbai store list

# Filter stores by name
mxbai store list --filter "docs"

# Limit results
mxbai store list --limit 5

Create Store

Command

mxbai store create <name> [options]

Arguments

<name> - Name for the store (lowercase letters, numbers, periods, and hyphens only)

Options

--description <desc> - Description for the store
--expires-after <days> - Auto-delete after specified days
--metadata <json> - JSON metadata for the store
--public [value] - Make store publicly accessible (requestor pays for usage)
--contextualization [fields] - Include metadata in chunk embeddings to improve search relevance. Can be used as a flag to enable globally, or with comma-separated metadata field names for targeted contextualization (e.g., --contextualization=title,author).

Examples

# Create a basic store
mxbai store create my-knowledge-base

# Create with description
mxbai store create my-knowledge-base --description "Project documentation"

# Create with expiration
mxbai store create temp-store --expires-after 30

# Create with metadata
mxbai store create project-store --metadata '{"project": "web-app", "team": "engineering"}'

# Create a public store
mxbai store create my-public-store --public

# Create with contextualization enabled
mxbai store create my-knowledge-base --contextualization

# Create with contextualization using specific metadata fields
mxbai store create my-knowledge-base --contextualization=title,author,date

Get Store Details

Command

mxbai store get <name-or-id>

Options

None

Examples

# Get store by name
mxbai store get "my-knowledge-base"

# Get store by ID
mxbai store get "my-knowledge-base"

Update Store

Command

mxbai store update <name-or-id> [options]

Options

--name <name> - New name for the store (lowercase letters, numbers, periods, and hyphens only)
--description <desc> - New description
--expires-after <days> - Update expiration
--metadata <json> - Update metadata
--public [value] - Make store publicly accessible (requestor pays for usage)

Examples

# Update description
mxbai store update my-knowledge-base --description "Updated description"

# Rename store
mxbai store update old-name --name new-name

# Update metadata
mxbai store update my-store --metadata '{"version": "2.0"}'

# Make store public
mxbai store update my-store --public

# Make store private
mxbai store update my-store --public=false

Delete Store

Command

mxbai store delete <name-or-id> [options]

Alias: mxbai store rm <name-or-id>

Options

--yes, -y - Skip confirmation prompt

Examples

# Delete with confirmation prompt
mxbai store delete "my-knowledge-base"

# Delete without confirmation
mxbai store delete "my-knowledge-base" --yes

# Delete using alias
mxbai store rm "my-knowledge-base" --yes

# Delete by ID
mxbai store delete "my-knowledge-base" --yes

Store Management

On this page