/minimax-multimodal-toolkit

name: mmx-cli
description: Use mmx to generate text, images, video, speech, and music via the MiniMax AI platform. Use when the user wants to create media content, chat with MiniMax models, perform web search, or manage MiniMax API resources from the terminal.

MiniMax CLI — Agent Skill Guide

Use `mmx` to generate text, images, video, speech, music, and perform web search via the MiniMax AI platform.

Prerequisites

# Install
npm install -g mmx-cli

# Auth (persisted to ~/.mmx/credentials.json)
mmx auth login --api-key sk-xxxxx

# Or pass per-call
mmx text chat --api-key sk-xxxxx --message "Hello"

Region is auto-detected. Override with `--region global` or `--region cn`.

---

Agent Flags

Always use these flags in non-interactive (agent/CI) contexts:

| Flag | Purpose | |---|---| | `--non-interactive` | Fail fast on missing args instead of prompting | | `--quiet` | Suppress spinners/progress; stdout is pure data | | `--output json` | Machine-readable JSON output | | `--async` | Return task ID immediately (video generation) | | `--dry-run` | Preview the API request without executing | | `--yes` | Skip confirmation prompts |

---

Commands

text chat

Chat completion. Default model: `MiniMax-M2.7`.

mmx text chat --message <text> [flags]

| Flag | Type | Description | |---|---|---| | `--message <text>` | string, **required**, repeatable | Message text. Prefix with `role:` to set role (e.g. `"system:You are helpful"`, `"user:Hello"`) | | `--messages-file <path>` | string | JSON file with messages array. Use `-` for stdin | | `--system <text>` | string | System prompt | | `--model <model>` | string | Model ID (default: `MiniMax-M2.7`) | | `--max-tokens <n>` | number | Max tokens (default: 4096) | | `--temperature <n>` | number | Sampling temperature (0.0, 1.0] | | `--top-p <n>` | number | Nucleus sampling threshold | | `--stream` | boolean | Stream tokens (default: on in TTY) | | `--tool <json-or-path>` | string, repeatable | Tool definition JSON or file path |

# Single message
mmx text chat --message "user:What is MiniMax?" --output json --quiet

# Multi-turn
mmx text chat \
  --system "You are a coding assistant." \
  --message "user:Write fizzbuzz in Python" \
  --output json

# From file
cat conversation.json | mmx text chat --messages-file - --output json

**stdout**: response text (text mode) or full response object (json mode).

---

image generate

Generate images. Model: `image-01`.

mmx image generate --prompt <text> [flags]

| Flag | Type | Description | |---|---|---| | `--prompt <text>` | string, **required** | Image description | | `--aspect-ratio <ratio>` | string | e.g. `16:9`, `1:1` | | `--n <count>` | number | Number of images (default: 1) | | `--subject-ref <params>` | string | Subject reference: `type=character,image=path-or-url` | | `--out-dir <dir>` | string | Download images to directory | | `--out-prefix <prefix>` | string | Filename prefix (default: `image`) |

mmx image generate --prompt "A cat in a spacesuit" --output json --quiet
# stdout: image URLs (one per line in quiet mode)

mmx image generate --prompt "Logo" --n 3 --out-dir ./gen/ --quiet
# stdout: saved file paths (one per line)

---

video generate

Generate video. Default model: `MiniMax-Hailuo-2.3`. This is an async task — by default it polls until completion.

mmx video generate --prompt <text> [flags]

| Flag | Type | Description | |---|---|---| | `--prompt <text>` | string, **required** | Video description | | `--model <model>` | string | `MiniMax-Hailuo-2.3` (default) or `MiniMax-Hailuo-2.3-Fast` | | `--first-frame <path-or-url>` | string | First frame image | | `--callback-url <url>` | string | Webhook URL for completion | | `--download <path>` | string | Save video to specific file | | `--async` | boolean | Return task ID immediately | | `--no-wait` | boolean | Same as `--async` | | `--poll-interval <seconds>` | number | Polling interval (default: 5) |

# Non-blocking: get task ID
mmx video generate --prompt "A robot." --async --quiet
# stdout: {"taskId":"..."}

# Blocking: wait and get file path
mmx video generate --prompt "Ocean waves." --download ocean.mp4 --quiet
# stdout: ocean.mp4

video task get

Query status of a video generation task.

mmx video task get --task-id <id> [--output json]

video download

Download a completed video by task ID.

mmx video download --file-id <id> [--out <path>]

---

speech synthesize

Text-to-speech. Default model: `speech-2.8-hd`. Max 10k chars.

mmx speech synthesize --text <text> [flags]

| Flag | Type | Description | |---|---|---| | `--text <text>` | string | Text to synthesize | | `--text-file <path>` | string | Read text from file. Use `-` for stdin | | `--model <model>` | string | `speech-2.8-hd` (default), `speech-2.6`, `speech-02` | | `--voice <id>` | string | Voice ID (default: `English_expressive_narrator`) | | `--speed <n>` | number | Speed multiplier | | `--volume <n>` | number | Volume level | | `--pitch <n>` | number | Pitch adjustment | | `--format <fmt>` | string | Audio format (default: `mp3`) | | `--sample-rate <hz>` | number | Sample rate (default: 32000) | | `--bitrate <bps>` | number | Bitrate (default: 128000) | | `--channels <n>` | number | Audio channels (default: 1) | | `--language <code>` | string | Language boost | | `--subtitles` | boolean | Include subtitle timing data | | `--pronunciation <from/to>` | string, repeatable | Custom pronunciation | | `--sound-effect <effect>` | string | Add sound effect | | `--out <path>` | string | Save audio to file | | `--stream` | boolean | Stream raw audio to stdout |

mmx speech synthesize --text "Hello world" --out hello.mp3 --quiet
# stdout: hello.mp3

echo "Breaking news." | mmx speech synthesize --text-file - --out news.mp3

---

music generate

Generate music. Model: `music-2.5`. Responds well to rich, structure