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

# 快速開始

> 只需簡單三步，即可開始使用 API易 訪問各種 AI 模型。

## 第一步：賬戶準備

### 1.1 註冊賬號

訪問 [API易官網](https://api.apiyi.com) 註冊賬號：

* 使用郵箱註冊（推薦高校、企業郵箱註冊）
* 驗證郵箱地址
* 登入控制台

### 1.2 賬戶充值

在控制台進行充值：

1. 點選"充值"選單
2. 選擇充值金額（最低 5 美金起，充值越多加贈越多，[檢視優惠政策](/zh-Hant/faq/recharge-promotions)）
3. 完成支付（支援支付寶、微信）

<Note>
  新使用者首次充值可獲得額外贈送，充值後餘額立即到賬，首充加贈額度需要[聯絡企業微信客服](https://work.weixin.qq.com/kfid/kfc9adfd5810ece25ec)後為你人工加贈。
</Note>

## 第二步：建立 API 金鑰

### 2.1 生成金鑰

1. 在後臺導航點選"令牌"欄目，[https://api.apiyi.com/token](https://api.apiyi.com/token)
2. 可以複製【預設令牌】直接使用（右側有個 複製 圖示）
3. 或者新建立令牌：點選右上側"新增"按鈕，為金鑰命名（如：test-key），點選確認建立，即擁有新的令牌。

## 第三步：開始呼叫

### 3.1 獲取接入資訊

* **API 地址（所謂的 Base\_Url）**：`https://api.apiyi.com`
* **API 金鑰**：您剛建立的金鑰
* **請求格式**：完全相容 OpenAI API，相容 OpenAI 格式呼叫。

### 3.2 測試呼叫

使用 curl 快速測試：

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

### 3.3 程式碼示例

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

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

    response = client.chat.completions.create(
        model="gpt-4.1-mini",
        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.apiyi.com/v1'
    });

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

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

  <Tab title="Java">
    ```java theme={null}
    // 使用官方 OpenAI Java 庫
    OpenAiService service = new OpenAiService(
        "YOUR_API_KEY", 
        Duration.ofSeconds(60), 
        "https://api.apiyi.com/v1"
    );

    ChatCompletionRequest request = ChatCompletionRequest.builder()
        .model("gpt-4.1-mini")
        .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>

## 下一步

恭喜！您已經成功完成了 API易 的接入。接下來您可以：

<CardGroup cols={2}>
  <Card title="檢視 API 文件" icon="book" href="/zh-Hant/api-manual">
    瞭解完整的 API 介面說明
  </Card>

  <Card title="探索模型列表" icon="bot" href="/zh-Hant/api-capabilities/model-info">
    檢視所有支援的 AI 模型
  </Card>

  <Card title="整合到應用" icon="plug" href="/zh-Hant/scenarios/engineering/langchain">
    將 API易 整合到各種工具
  </Card>

  <Card title="檢視使用統計" icon="chart-line" href="https://api.apiyi.com/log">
    在控制台監控使用情況
  </Card>
</CardGroup>

## 常見問題

### 如何切換模型？

只需修改請求中的 `model` 引數：

```json theme={null}
{
  "model": "gpt-4.1",           // 使用 GPT-4.1
  "model": "claude-sonnet-4-20250514",   // 使用 Claude 4 Sonnet
  "model": "gemini-2.5-pro"       // 使用 Gemini 2.5 Pro
}
```

### 支援哪些程式語言？

API易 相容 OpenAI API 標準，支援所有 OpenAI SDK 支援的語言：

* Python
* JavaScript/TypeScript
* Java
* C#/.NET
* Go
* Ruby
* PHP
* 更多...

### 如何檢視餘額？

登入 [控制台](https://api.apiyi.com/account/profile) 即可檢視：

* 賬戶餘額
* 使用記錄
* 消費統計

也可通過 API 程式化查詢：

* [餘額查詢 API](/zh-Hant/api-capabilities/balance-query)：通過介面獲取賬戶餘額、有效期等資訊
* [餘額告警設定方法](/zh-Hant/faq/balance-alerts)：餘額不足時自動通知，避免服務中斷

### 遇到問題怎麼辦？

1. 檢視 [API 文件](/zh-Hant/api-manual)
2. 檢查 [常見錯誤](/zh-Hant/faq/invalid-api-key)
3. 聯絡客服：[support@apiyi.com](mailto:support@apiyi.com)

<Info>
  提示：儲存好您的 API 金鑰，並定期在控制台檢視使用日誌，每筆請求都有訊息歷史，合理最佳化成本。
  祝使用愉快\~
</Info>