﻿# Quick Access

This article describes how to quickly connect to Token Plan, which can be completed in just 3 steps from subscription to invocation. 

## Step 1: Subscribe to the Token Plan 

Go to [Token Plan](https://platform.xiaomimimo.com/#/token-plan), select a suitable subscription plan. 

## Step 2: Obtain Credentials 

After successful subscription, go to [ Subscription](https://platform.xiaomimimo.com/#/console/plan-manage)  to obtain the following credentials: 

- **Base URL**: Subsequently, one of the following Base URLs needs to be configured in the AI programming tool ( **protocol varies by tool, Base URL is subject to the display on the** [**Subscription**](https://platform.xiaomimimo.com/#/console/plan-manage) **page** ), for specific operations, please refer to the corresponding AI programming tool user guide document.

- **OpenAI Compatibility Protocol**

   - China Cluster: `https://token-plan-cn.xiaomimimo.com/v1`

   - Singapore Cluster: `https://token-plan-sgp.xiaomimimo.com/v1`

   - Europe Cluster: `https://token-plan-ams.xiaomimimo.com/v1`

- **Anthropic Compatibility Protocol**

   - China Cluster: `https://token-plan-cn.xiaomimimo.com/anthropic`

   - Singapore Cluster: `https://token-plan-sgp.xiaomimimo.com/anthropic`

   - Europe Cluster: `https://token-plan-ams.xiaomimimo.com/anthropic`

<div className='mdx-highlight'>

The API Key of Token Plan (`tp-xxxxx`) and the API Key for pay-as-you-go API calls (`sk-xxxxx`) are independent of each other and cannot be mixed.

</div>

## Step 3: Connect to AI Programming Tools 

Go to [AI Tools Overview](https://platform.xiaomimimo.com/#/docs/integration/tools-overview) to view the configuration guide for the tools you use (such as OpenCode, OpenClaw, etc.).

## Quick Verification (Optional)

After completing the configuration, you can quickly verify whether the connection is successful through the following methods. 

### Method 1: Verify through AI programming tools 

Enter a simple programming requirement into the configured AI programming tool, for example: 

> Help me write a quick sort algorithm in Python

If the tool returns a normal code, it indicates successful connection. 

### Method 2: Directly call verification via API 

Use the curl command to directly call the API and verify whether the credentials are valid. 

<div className='mdx-highlight'>

In the following examples, both `BASE_URL` and `MIMO_API_KEY` are placeholders. Please replace them with the real credentials obtained from the Console when actually using them.

</div>

**OpenAI Compatibility Protocol:**

```bash
curl --location --request POST 'BASE_URL/chat/completions' \
--header "api-key: $MIMO_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
    "model": "mimo-v2.5-pro",
    "messages": [
        {
            "role": "system",
            "content": "You are MiMo, an AI assistant developed by Xiaomi. Today is date: Tuesday, December 16, 2025. Your knowledge cutoff date is December 2024."
        },
        {
            "role": "user",
            "content": "please introduce yourself"
        }
    ],
    "max_completion_tokens": 1024
}'
```

**Anthropic Compatibility** **Protocol:**

```bash
curl --location --request POST 'BASE_URL/v1/messages' \
--header "api-key: $MIMO_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
    "model": "mimo-v2.5-pro",
    "max_tokens": 1024,
    "system": "You are MiMo, an AI assistant developed by Xiaomi. Today is date: Tuesday, December 16, 2025. Your knowledge cutoff date is December 2024.",
    "messages": [
        {
            "role": "user",
            "content": [
                {
                    "type": "text",
                    "text": "please introduce yourself"
                }
            ]
        }
    ]
}'
```

## Frequently Asked Questions 

**Question: What is the difference between the API Key of Token Plan and the API Key for Pay-as-you-go  API calls?**

Answer: The API Key format for Token Plan is `tp-xxxxx`, which is only used for Token Plan subscription services; Pay-as-you-go API calls have an API Key format of `sk-xxxxx`, which is used for pay-as-you-go billing. The two are independent of each other and cannot be mixed.

**Question: What is the difference between the Base URL of the Token Plan and the Base URL of Pay-as-you-go API calls?**

Answer: The Base URL format of Token Plan is different, and it shall be subject to the display on the [ Subscription](https://platform.xiaomimimo.com/#/console/plan-manage) page.

**Question: Can the API Key still be used after the subscription expires?**

Answer: No. The API Key of Token Plan is only available during the subscription validity period, and renewal is required after the subscription expires to continue using it.
