---
url: /guide/quickstart/index.md
---
本指南将帮助您快速接入智算多多 API 服务，完成从获取 API Key 到发起请求的完整流程。

## 1. 获取并配置 API Key

### 1.1 获取 API Key

1. 登录 [智算多多控制台](https://console.zsdodo.com/)
2. 进入「API 管理」页面
3. 点击「创建 API Key」
4. 复制生成的 API Key 并妥善保存

::: warning 注意
API Key 仅在创建时显示一次，请务必及时保存。如需更换，可在控制台重新创建。
:::

### 1.2 配置 API Key

您可以通过以下方式配置 API Key：

**方式一：环境变量（推荐）**

```bash
# Linux / macOS
export ZSDODO_API_KEY="your-api-key-here"

# Windows PowerShell
$env:ZSDODO_API_KEY="your-api-key-here"

# Windows CMD
set ZSDODO_API_KEY=your-api-key-here
```

**方式二：代码中直接配置**

在代码中直接传入 API Key（适用于测试环境，生产环境建议使用环境变量）。

## 2. 模型列表服务

智算多多提供丰富的模型选择，满足不同场景需求。

### 2.1 查询可用模型

通过 API 获取当前支持的模型列表：

::: code-tabs#shell

@tab Python

```python
import openai

client = openai.OpenAI(
    api_key="your-api-key",
    base_url="https://api.zsdodo.com/v1"
)

models = client.models.list()
for model in models:
    print(model.id)
```

@tab JavaScript

```javascript
import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'your-api-key',
  baseURL: 'https://api.zsdodo.com/v1', 
  dangerouslyAllowBrowser: true
});

const models = await client.models.list();
models.data.forEach(model => console.log(model.id));
```

@tab Java

```java
// 使用 OkHttp 请求
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
    .url("https://api.zsdodo.com/v1/models")
    .header("Authorization", "Bearer your-api-key")
    .build();

Response response = client.newCall(request).execute();
System.out.println(response.body().string());
```

:::

### 2.2 支持的模型类型

| 模型类型 | 适用场景 | 特点 |
|---------|---------|------|
| 文本生成 | 对话、写作、翻译 | 高质量文本输出 |
| 代码生成 | 编程辅助、代码补全 | 多语言支持 |
| 嵌入模型 | 向量化、语义搜索 | 高效向量化处理 |

## 3. 安装 SDK

智算多多兼容 OpenAI API 协议，可直接使用 OpenAI SDK。

::: code-tabs#install

@tab Python

```bash
pip install openai
```

@tab JavaScript/Node.js

```bash
npm install openai
# 或
pnpm add openai
# 或
yarn add openai
```

@tab Java

```xml
<!-- Maven -->
<dependency>
    <groupId>com.openai</groupId>
    <artifactId>openai-java</artifactId>
    <version>0.22.0</version> <!-- 建议检查并使用最新版本 -->
</dependency>
```

或使用 Gradle：

```gradle
implementation 'com.theokanning.openai-gpt3-java:service:0.18.2'
```

:::

## 4. 发起 API 请求

### 4.1 文本生成请求

::: code-tabs#request

@tab Python

```python
import os
from openai import OpenAI

client = OpenAI(
    # 若没有配置环境变量，请用平台API Key将下行替换为：api_key="sk-xxx"
    api_key=os.getenv("ZSDODO_API_KEY"),
    base_url="https://api.zsdodo.com/v1/chat/completions",
)

completion = client.chat.completions.create(
    # 模型列表：https://test-console.zsdodo.com/#/model/square
    model="qwen-plus",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "你是谁？"},
    ]
)
print(completion.model_dump_json())
```

@tab JavaScript

```javascript
import OpenAI from "openai";

const openai = new OpenAI(
    {
        // 若没有配置环境变量，请用平台API Key将下行替换为：apiKey: "sk-xxx",
        apiKey: process.env.ZSDODO_API_KEY,
        baseURL: "https://api.zsdodo.com/v1/chat/completions"
    }
);

async function main() {
    const completion = await openai.chat.completions.create({
        model: "qwen-plus",  //此处以qwen-plus为例，可按需更换模型名称。模型列表：https://test-console.zsdodo.com/#/model/square
        messages: [
            { role: "system", content: "You are a helpful assistant." },
            { role: "user", content: "你是谁？" }
        ],
    });
    console.log(JSON.stringify(completion))
}

main();
```

@tab Java

```java
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.chat.completions.ChatCompletion;
import com.openai.models.chat.completions.ChatCompletionCreateParams;

public class Main {
    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.builder()
                .apiKey(System.getenv("ZSDODO_API_KEY"))
                .baseUrl("https://api.zsdodo.com/v1/chat/completions")
                .build();

        ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
                .addUserMessage("你是谁")
                .model("qwen-plus")
                .build();

        try {
            ChatCompletion chatCompletion = client.chat().completions().create(params);
            System.out.println(chatCompletion);
        } catch (Exception e) {
            System.err.println("Error occurred: " + e.getMessage());
            e.printStackTrace();
        }
    }
}
```

:::

## 下一步

* 查看 [API 参考](./api-reference.md) 了解完整的 API 参数
* 查看 [最佳实践](./best-practices.md) 优化您的调用方式
* 查看 [常见问题](./faq.md) 解决使用中的疑问