MiniMax Open Platform

https://platform.minimax.cn/docs
Admin
MiniMax Open Platform provides multimodal AI models and developer APIs for text generation, video...
Tokens:320,080
Snippets:1,725
Trust Score:4.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install and Start Open WebUI

Source: https://platform.minimax.cn/docs/m-plan/other-tools

Install Open WebUI via pip (requires Python 3.11) and start the server.

```bash
pip install open-webui
open-webui serve
```

--------------------------------

### Start OpenClaw configuration

Source: https://platform.minimax.cn/docs/m-plan/openclaw

Run this command to start the configuration wizard if it does not start automatically after installation.

```bash
openclaw configure
```

--------------------------------

### Manual Pi installation and MiniMax configuration

Source: https://platform.minimax.cn/docs/m-plan/other-tools

Manually install Pi, set the MINIMAX_CN_API_KEY environment variable to your subscription key (prefix sk-cp-...), and start Pi with the MiniMax provider and model.

```bash
npm install -g @earendil-works/pi-coding-agent

```

```bash
export MINIMAX_CN_API_KEY=sk-cp-...
pi --provider minimax-cn --model MiniMax-M3.1-Flash-Preview

```

--------------------------------

### One-click Pi setup with MiniMax

Source: https://platform.minimax.cn/docs/m-plan/other-tools

Run the one-click configuration wizard for Pi, which installs the official npm package and writes the MiniMax model to Pi's settings. Requires Node.js 22.19 or higher.

```bash
npx -y mmx-cli@latest agent setup

```

```bash
pi

```

--------------------------------

### Install uv on Windows

Source: https://platform.minimax.cn/docs/guides/mcp-guide

Installs uv and uvx on Windows. Run this in PowerShell to get the uvx executable.

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

--------------------------------

### Run MiniMax M Plan setup wizard with npx mmx-cli

Source: https://platform.minimax.cn/docs/m-plan/hermes-agent

One-click configuration wizard for MiniMax M Plan. Select Hermes Agent from the tool list, enter your subscription key, and keep Hermes Agent in the second multi-select list if not installed. The wizard runs the official installer's non-interactive core CLI phase, skips optional flows like setup and gateway, and checks hermes --version. It updates ~/.hermes/config.yaml and ~/.hermes/.env.

```bash
npx -y mmx-cli@latest agent setup

```

--------------------------------

### Install AI SDK and MiniMax Provider

Source: https://platform.minimax.cn/docs/api-reference/text-ai-sdk

Install the AI SDK and the MiniMax provider using either npm or pnpm. Choose one package manager; both commands install the same packages.

```bash
npm install ai vercel-minimax-ai-provider

```

```bash
pnpm add ai vercel-minimax-ai-provider

```

--------------------------------

### Start nanobot Agent

Source: https://platform.minimax.cn/docs/m-plan/other-tools

Start the nanobot agent.

```bash
nanobot agent
```

--------------------------------

### Install AI SDK and MiniMax Provider

Source: https://platform.minimax.cn/docs/api-reference/text-ai-sdk

Install the required packages using npm or pnpm.

```APIDOC
## Install AI SDK and MiniMax Provider

### Description
Install the `ai` and `vercel-minimax-ai-provider` packages.

### Installation
#### npm
```bash
npm install ai vercel-minimax-ai-provider
```

#### pnpm
```bash
pnpm add ai vercel-minimax-ai-provider
```
```

--------------------------------

### Install OpenAI SDK

Source: https://platform.minimax.cn/docs/guides/text-chat

Install the OpenAI SDK for Python or Node.js to interact with the M2-her model.

```bash
pip install openai
```

```bash
npm install openai
```

--------------------------------

### Install Anthropic SDK for Node.js

Source: https://platform.minimax.cn/docs/guides/quickstart-sdk

Install the Anthropic SDK for Node.js. This is the recommended installation method for Node.js users.

```bash
npm install @anthropic-ai/sdk
```

--------------------------------

### Install OpenAI SDK (Node.js)

Source: https://platform.minimax.cn/docs/api-reference/text-openai-api

Install the OpenAI Node.js SDK using npm.

```bash
npm install openai

```

--------------------------------

### Install uv on macOS/Linux

Source: https://platform.minimax.cn/docs/guides/mcp-guide

Installs uv and uvx on macOS/Linux. Run this in a terminal before configuring MiniMax-MCP.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

--------------------------------

### Install OpenAI SDK (Python)

Source: https://platform.minimax.cn/docs/api-reference/text-openai-api

Install the OpenAI Python SDK using pip.

```bash
pip install openai

```

--------------------------------

### 200 response example for get model details

Source: https://platform.minimax.cn/docs/api-reference/models/openai/retrieve-model

Example JSON response returned by the API when the request succeeds. Contains model id, object type, creation timestamp, and owner.

```json
{
  "id": "MiniMax-M3",
  "object": "model",
  "created": 1780272000,
  "owned_by": "minimax"
}
```

--------------------------------

### Speaker diarization and per-sentence timestamps - Python

Source: https://platform.minimax.cn/docs/guides/speech-to-text

Uses response_format=verbose_json to get speaker labels and timestamps. Iterates over the 'segments' array and prints speaker, start, end, and text for each segment.

```python
import os, requests

api_key = os.getenv("MINIMAX_API_KEY")
url = "https://api.minimax.cn/v1/speech_to_text"
headers = {"Authorization": f"Bearer {api_key}"}

with open("/path/to/meeting.wav", "rb") as f:
    files = {"file": ("meeting.wav", f)}
    data = {"model": "asr-1.0", "response_format": "verbose_json"}
    result = requests.post(url, headers=headers, data=data, files=files).json()

for seg in result["segments"]:
    print(f"[{seg['speaker']}] {seg['start']:.2f}-{seg['end']:.2f} {seg['text']}")

```

--------------------------------

### Streaming TTS WebSocket Client

Source: https://platform.minimax.cn/docs/guides/speech-t2a-websocket

Complete Python example for streaming TTS audio via WebSocket. Requires mpv player and MINIMAX_API_KEY environment variable. Establishes connection, sends task start, streams audio chunks, and saves output file.

```python
import asyncio
import websockets
import json
import ssl
import subprocess
import os

model = "speech-2.8-hd"
file_format = "mp3"

class StreamAudioPlayer:
    def __init__(self):
        self.mpv_process = None

    def start_mpv(self):
        """Start MPV player process"""
        try:
            mpv_command = ["mpv", "--no-cache", "--no-terminal", "--", "fd://0"]
            self.mpv_process = subprocess.Popen(
                mpv_command,
                stdin=subprocess.PIPE,
                stdout=subprocess.DEVNULL,
                stderr=subprocess.DEVNULL,
            )
            print("MPV player started")
            return True
        except FileNotFoundError:
            print("Error: mpv not found. Please install mpv")
            return False
        except Exception as e:
            print(f"Failed to start mpv: {e}")
            return False

    def play_audio_chunk(self, hex_audio):
        """Play audio chunk"""
        try:
            if self.mpv_process and self.mpv_process.stdin:
                audio_bytes = bytes.fromhex(hex_audio)
                self.mpv_process.stdin.write(audio_bytes)
                self.mpv_process.stdin.flush()
                return True
        except Exception as e:
            print(f"Play failed: {e}")
            return False
        return False

    def stop(self):
        """Stop player"""
        if self.mpv_process:
            if self.mpv_process.stdin and not self.mpv_process.stdin.closed:
                self.mpv_process.stdin.close()
            try:
                self.mpv_process.wait(timeout=20)
            except subprocess.TimeoutExpired:
                self.mpv_process.terminate()

async def establish_connection(api_key):
    """Establish WebSocket connection"""
    url = "wss://api.minimax.cn/ws/v1/t2a_v2"
    headers = {"Authorization": f"Bearer {api_key}"}

    ssl_context = ssl.create_default_context()
    ssl_context.check_hostname = False
    ssl_context.verify_mode = ssl.CERT_NONE

    try:
        ws = await websockets.connect(url, additional_headers=headers, ssl=ssl_context)
        connected = json.loads(await ws.recv())
        if connected.get("event") == "connected_success":
            print("Connection successful")
            return ws
        return None
    except Exception as e:
        print(f"Connection failed: {e}")
        return None

async def start_task(websocket):
    """Send task start request"""
    start_msg = {
        "event": "task_start",
        "model": model,
        "voice_setting": {
            "voice_id": "male-qn-qingse",
            "speed": 1,
            "vol": 1,
            "pitch": 0,
            "english_normalization": False
        },
        "audio_setting": {
            "sample_rate": 32000,
            "bitrate": 128000,
            "format": file_format,
            "channel": 1
        }
    }
    await websocket.send(json.dumps(start_msg))
    response = json.loads(await websocket.recv())
    return response.get("event") == "task_started"

async def continue_task_with_stream_play(websocket, text, player):
    """Send continue request and stream play audio"""
    await websocket.send(json.dumps({
        "event": "task_continue",
        "text": text
    }))

    chunk_counter = 1
    total_audio_size = 0
    audio_data = b""

    while True:
        try:
            response = json.loads(await websocket.recv())

            if "data" in response and "audio" in response["data"]:
                audio = response["data"]["audio"]
                if audio:
                    print(f"Playing chunk #{chunk_counter}")
                    audio_bytes = bytes.fromhex(audio)
                    if player.play_audio_chunk(audio):
                        total_audio_size += len(audio_bytes)
                        audio_data += audio_bytes
                        chunk_counter += 1

            if response.get("is_final"):
                print(f"Audio synthesis completed: {chunk_counter-1} chunks")
                if player.mpv_process and player.mpv_process.stdin:
                    player.mpv_process.stdin.close()

                # Save audio to file
                with open(f"output.{file_format}", "wb") as f:
                    f.write(audio_data)
                print(f"Audio saved as output.{file_format}")

                estimated_duration = total_audio_size * 0.0625 / 1000
                wait_time = max(estimated_duration + 5, 10)
                return wait_time

        except Exception as e:
            print(f"Error: {e}")
            break

    return 10

async def close_connection(websocket):
    """Close connection"""
    if websocket:
        try:
            await websocket.send(json.dumps({"event": "task_finish"}))
            await websocket.close()
        except Exception:
            pass
```

--------------------------------

### Initialize nanobot

Source: https://platform.minimax.cn/docs/m-plan/other-tools

Initialize nanobot configuration.

```bash
nanobot onboard
```

--------------------------------

### Install Qwen Code on Linux/macOS

Source: https://platform.minimax.cn/docs/m-plan/other-tools

Install Qwen Code on Linux or macOS using the official installation script.

```bash
bash -c "$(curl -fsSL https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen.sh)"
```

--------------------------------

### Start SGLang-Omni server for MiniMax-Music3

Source: https://platform.minimax.cn/docs/guides/local-deploy-music-3

Starts the SGLang-Omni HTTP server on the local loopback address 127.0.0.1:8000 using the downloaded model. Keep this terminal running.

```bash
CUDA_VISIBLE_DEVICES=0 sgl-omni serve \
  --model-path "$MUSIC3_MODEL_DIR" \
  --model-name MiniMaxAI/MiniMax-Music3 \
  --host 127.0.0.1 \
  --port 8000

```

--------------------------------

### Install Anthropic SDK for Python

Source: https://platform.minimax.cn/docs/guides/quickstart-sdk

Install the Anthropic SDK for Python. This is the recommended installation method for Python users.

```bash
pip install anthropic
```

--------------------------------

### 发送 task_start 事件

Source: https://platform.minimax.cn/docs/api-reference/speech-t2a-websocket-bidi

发送 `task_start` 事件以正式开始合成任务。需在收到服务端返回的 `task_started` 事件后才能发送 `task_continue` 或 `task_finish`。

```json
{  
  "event": "task_start",  
  "model": "speech-2.8-turbo",  
  "language_boost": "Chinese",  
  "voice_setting": {  
    "voice_id": "male-qn-qingse",  
    "speed": 1,  
    "vol": 1,  
    "pitch": 0  
  },  
  "pronunciation_dict": {  
    "tone": [  
      "处理/(chu3)(li3)",  
      "危险/dangerous"  
    ]  
  },  
  "audio_setting": {  
    "sample_rate": 32000,  
    "bitrate": 128000,  
    "format": "mp3",  
    "channel": 1  
  },  
  "session_id": "my-session-001"  
}
```

--------------------------------

### Verify Hermes Agent installation with hermes doctor

Source: https://platform.minimax.cn/docs/m-plan/hermes-agent

Verifies the Hermes Agent installation. Run after the install script to confirm the CLI is available.

```bash
hermes doctor

```

--------------------------------

### Install and configure OpenHands with MiniMax

Source: https://platform.minimax.cn/docs/m-plan/other-tools

Install OpenHands with pipx, configure MiniMax by replacing sk-cp-... with your subscription key, then launch the agent.

```bash
pipx install openhands

```

```bash
pipx run --spec openhands python -c '
import sys
from openhands_cli.stores.agent_store import AgentStore
AgentStore().create_and_save_from_settings(
    llm_api_key=sys.argv[1],
    settings={"llm_model": "openai/MiniMax-M3.1-Flash-Preview",
              "llm_base_url": "https://api.minimax.cn/v1"},
)
' sk-cp-...

```

```bash
openhands

```
Tokens:
Raw