> ## Documentation Index
> Fetch the complete documentation index at: https://mixroute.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Get started with Mixroute Api in just three simple steps

<link rel="alternate" hrefLang="en" href="https://mixroute.ai/docs/quickstart" />

<link rel="alternate" hrefLang="zh-Hans" href="https://mixroute.ai/docs/zh-hans/quickstart" />

<link rel="alternate" hrefLang="zh-Hant" href="https://mixroute.ai/docs/zh-hant/quickstart" />

<link rel="alternate" hrefLang="ja" href="https://mixroute.ai/docs/ja/quickstart" />

<link rel="alternate" hrefLang="x-default" href="https://mixroute.ai/docs/quickstart" />

## Step 1: Register and Sign In

Open the [MixRoute Console](https://console.mixroute.ai/), register your account, and sign in.

<Info>
  New users receive \$5 in free trial credit upon registration. You can make your first request without topping up.
</Info>

## Step 2: Copy Your API Key

Your first API key is created automatically when you register.

1. Open **API Keys** in the console navigation.
2. Copy the existing key and use it in the request examples below.
3. Create an additional key only if you need a separate one for another application.

Keep your API key private. Do not put it in browser-side code or public repositories.

## Step 3: Start Calling

### 3.1 Connection Info

| Config | Value |
| - | - |
| API URL (Base URL) | `https://api.mixroute.ai/v1` |
| API Key | The key copied from API Keys |
| Request Format | Fully OpenAI API compatible |

### 3.2 Test Call

Quick test with curl:

```bash theme={null}
curl https://api.mixroute.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'
```

### 3.3 Code Examples

<Tabs>
  <Tab title="Python">
    ```python theme={null}
    from openai import OpenAI

    client = OpenAI(
        api_key="YOUR_API_KEY",
        base_url="https://api.mixroute.ai/v1"
    )

    response = client.chat.completions.create(
        model="gpt-5.5",
        messages=[
            {"role": "user", "content": "Hello!"}
        ]
    )

    print(response.choices[0].message.content)
    ```
  </Tab>

  <Tab title="Node.js">
    ```javascript theme={null}
    import OpenAI from 'openai';

    const openai = new OpenAI({
      apiKey: 'YOUR_API_KEY',
      baseURL: 'https://api.mixroute.ai/v1'
    });

    const response = await openai.chat.completions.create({
      model: 'gpt-5.5',
      messages: [{ role: 'user', content: 'Hello!' }]
    });

    console.log(response.choices[0].message.content);
    ```
  </Tab>

  <Tab title="Java">
    ```java theme={null}
    OpenAiService service = new OpenAiService(
        "YOUR_API_KEY", 
        Duration.ofSeconds(60), 
        "https://api.mixroute.ai/v1"
    );

    ChatCompletionRequest request = ChatCompletionRequest.builder()
        .model("gpt-5.5")
        .messages(List.of(
            new ChatMessage(ChatMessageRole.USER, "Hello!")
        ))
        .build();

    ChatCompletionResult result = service.createChatCompletion(request);
    System.out.println(result.getChoices().get(0).getMessage().getContent());
    ```
  </Tab>
</Tabs>

<Note>
  Open **Wallet** to check your balance. Top up there when you need additional credit; it is not a prerequisite for using your initial trial credit.
</Note>

## Next Steps

Congratulations! You've successfully set up MixRoute API. Then you can:

<CardGroup cols={2}>
  <Card title="View API Docs" icon="book" href="/docs/api-reference/endpoint/chat-openai" cta="Learn more">
    Learn about complete API specifications
  </Card>

  <Card title="Integration" icon="puzzle-piece" href="/docs/api-reference/openai-sdk" cta="Learn more">
    Integrate MixRoute API with various tools
  </Card>
</CardGroup>

<Tip>
  Save your API key safely and regularly check usage logs in the console to optimize costs. Happy coding!
</Tip>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.