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

# 開始使用 CometAPI：建立 API key 並發送第一個呼叫

> 透過建立 API key、設定 base URL，並發送第一個 curl、Python 或 Node.js API 請求來開始使用 CometAPI。

## 建立帳號與 API key

在呼叫 API 之前，請先建立 CometAPI 帳號與 API key。

<Steps>
  <Step title="登入或建立帳號">
    開啟 [CometAPI 登入頁面](https://www.cometapi.com/console/login)。使用 Google 繼續、使用 GitHub 繼續，或輸入你的電子郵件或使用者名稱。若你還沒有帳號，請在此頁面完成帳號建立。

    <Frame>
      <img src="https://mintcdn.com/cometapi/BtE3Lagaukxd3efj/images/overview/cometapi-console-login.png?fit=max&auto=format&n=BtE3Lagaukxd3efj&q=85&s=988bee0055bf1ce2552a8d877a48a97d" alt="提供 Google、GitHub 與電子郵件登入選項的 CometAPI 登入頁面" width="1280" height="720" data-path="images/overview/cometapi-console-login.png" />
    </Frame>
  </Step>

  <Step title="開啟 API keys">
    登入後，開啟 [API key 頁面](https://www.cometapi.com/console/token)。你也可以在控制台側邊欄中選擇 **API Keys**。
  </Step>

  <Step title="建立 API key">
    點擊 **Create API Key**，輸入清楚易懂的名稱，例如 `local-test`，並在第一次測試時保持 **Unlimited Quota** 啟用，除非你想設定支出上限。點擊 **Create**。

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/overview/810968_364191.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=aef81a83f29f8eb16655ed4060425f50" alt="醒目標示 Create API Key 按鈕與建立對話框的 CometAPI API keys 頁面" width="3824" height="1892" data-path="images/overview/810968_364191.png" />
    </Frame>
  </Step>

  <Step title="複製 API key">
    點擊 **Key** 欄位中的複製按鈕。請將複製的 key 儲存在伺服器端環境變數或本機 `.env` 檔案中。請勿將真實的 API key 貼到公開儲存庫、前端程式碼、螢幕截圖或支援工單中。

    <Frame>
      <img src="https://mintcdn.com/cometapi/HhtmQffktazbxUvS/images/overview/810968_364193.png?fit=max&auto=format&n=HhtmQffktazbxUvS&q=85&s=d893f659267150d0faf45f99eb5dffc1" alt="已遮罩 API key 並醒目標示複製按鈕的 CometAPI API keys 表格" width="2434" height="1232" data-path="images/overview/810968_364193.png" />
    </Frame>
  </Step>
</Steps>

請求範例會從你的環境中讀取 `COMETAPI_KEY`。

## 在本機儲存你的 API key

若要進行本機測試，請將你的 API key 匯出為環境變數：

```bash theme={null}
read -rsp "CometAPI API key: " COMETAPI_KEY
printf '\n'
export COMETAPI_KEY
```

## Base URL

請為 OpenAI 相容的 SDK 與 API 呼叫使用以下 base URL：

```text theme={null}
https://api.cometapi.com/v1
```

## 從 OpenAI 切換只要 30 秒

取得 CometAPI API key 後，當你將 OpenAI SDK 用戶端切換到 CometAPI 時，請使用這個只需調整兩個設定的 diff：

```diff theme={null}
- base_url="https://api.openai.com/v1"
- api_key=os.environ["OPENAI_API_KEY"]
+ base_url="https://api.cometapi.com/v1"
+ api_key=os.environ["COMETAPI_KEY"]
```

CometAPI 對常見的文字、圖片、音訊與影片工作流程採用與 OpenAI 相容的請求格式。如果你的應用程式已經使用 OpenAI SDK，請先從變更 base URL 與 API key 開始。

## 進行第一次呼叫

在你的環境中設定好 `COMETAPI_KEY` 後，請將 `your-model-id` 替換為來自[模型頁面](/zh-Hant/overview/models)的目前 model ID。

<CodeGroup>
  ```bash cURL theme={null}
  curl https://api.cometapi.com/v1/chat/completions \
    -H "Authorization: Bearer $COMETAPI_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "model": "your-model-id",
      "messages": [
        {
          "role": "user",
          "content": "Write a one-sentence bedtime story."
        }
      ]
    }'
  ```

  ```python Python theme={null}
  import os
  from openai import OpenAI

  client = OpenAI(
      api_key=os.environ["COMETAPI_KEY"],
      base_url="https://api.cometapi.com/v1",
  )

  completion = client.chat.completions.create(
      model="your-model-id",
      messages=[
          {
              "role": "user",
              "content": "Write a one-sentence bedtime story.",
          }
      ],
  )

  print(completion.choices[0].message.content)
  ```

  ```javascript Node.js theme={null}
  import OpenAI from "openai";

  const client = new OpenAI({
    apiKey: process.env.COMETAPI_KEY,
    baseURL: "https://api.cometapi.com/v1",
  });

  const completion = await client.chat.completions.create({
    model: "your-model-id",
    messages: [
      {
        role: "user",
        content: "Write a one-sentence bedtime story.",
      },
    ],
  });

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

## 選擇模型

從[模型頁面](/zh-Hant/overview/models)選擇一個 model ID，然後將該值傳入 `model` 欄位。

| 目標      | 從哪裡開始                                                                   |
| ------- | ----------------------------------------------------------------------- |
| 聊天或一般文字 | 使用 GPT、Claude、Gemini、DeepSeek 或其他聊天模型，搭配[聊天補全](/api/text/chat)。         |
| 程式撰寫與推理 | 當模型需要 Responses API 時，使用程式撰寫或推理模型搭配[回應](/api/text/responses)。           |
| 圖像生成    | 使用圖像模型搭配[Create image](/api/image/openai/images)或供應商專屬的圖像指南。            |
| 影片生成    | 使用影片模型搭配符合供應商工作流程的影片 API 頁面，例如[Create video](/api/video/sora-2/create)。 |

## 接下來是什麼

* 如遇請求失敗，請參閱[錯誤代碼與處理](/zh-Hant/errors/error-codes-handling)。
* 如需重試指引，請參閱[如何處理速率限制](/api/text/chat#how-to-handle-rate-limits)。
* 如需特定模型的使用方式，請從[聊天補全](/api/text/chat)、[回應](/api/text/responses)、[Create image](/api/image/openai/images)或[Create video](/api/video/sora-2/create)開始。
* 如需計費詳細資訊，請參閱[關於定價](/zh-Hant/pricing/about-pricing)。
* 若要邀請團隊成員並管理共用點數，請參閱 [使用 Workspace 管理團隊](/zh-Hant/workspace/overview)。
* 如需協助，請參閱[說明中心](/zh-Hant/support/help-center)或聯絡[CometAPI 支援](https://www.cometapi.com/support/)。

## 常見問題

<AccordionGroup>
  <Accordion title="如何建立 CometAPI 帳戶？">
    開啟 [CometAPI 登入頁面](https://www.cometapi.com/console/login)，然後選擇使用 Google 繼續、使用 GitHub 繼續，或輸入您的電子郵件或使用者名稱。如果您還沒有帳戶，可以在同一頁完成帳戶建立。
  </Accordion>

  <Accordion title="如何取得 CometAPI API key？">
    在 CometAPI 控制台中開啟 [API key 頁面](https://www.cometapi.com/console/token)，點擊 **Create API Key**，輸入名稱，點擊 **Create**，然後複製產生的 API key。在範例中請使用 `$COMETAPI_KEY`，不要使用真實的 API key。
  </Accordion>

  <Accordion title="我應該將 API key 儲存在哪裡？">
    將您的 API key 儲存在伺服器端環境變數或本機 `.env` 檔案中。不要將它提交到公開儲存庫、貼到前端程式碼中、包含在螢幕截圖裡，或透過支援工單傳送。
  </Accordion>

  <Accordion title="CometAPI 用於 API 呼叫的 base URL 是什麼？">
    對於 OpenAI 相容的 SDK 和端點（例如 `/v1/chat/completions`），請使用 `https://api.cometapi.com/v1`。
  </Accordion>

  <Accordion title="CometAPI 是否可搭配 OpenAI Python SDK 使用？">
    可以。建立一個 `OpenAI` client，將 `api_key` 設為您的 CometAPI API key，並將 `base_url` 設為 `https://api.cometapi.com/v1`。
  </Accordion>

  <Accordion title="如何從 OpenAI 切換到 CometAPI？">
    將 base URL 改為 `https://api.cometapi.com/v1`，把 API key 換成您的 CometAPI API key，並使用來自 [Models 頁面](/zh-Hant/overview/models) 的 CometAPI model ID。
  </Accordion>

  <Accordion title="我應該先使用哪個 model ID？">
    請依據使用情境選擇 model ID。先從 [Models 頁面](/zh-Hant/overview/models) 開始，然後選擇符合您打算呼叫之 API 頁面的聊天、程式設計、圖片或影片模型。
  </Accordion>

  <Accordion title="CometAPI 支援哪些程式語言？">
    CometAPI 可搭配任何能傳送 HTTPS 請求的程式語言使用。您可以先從本頁的 curl、Python 和 Node.js 範例開始，或使用允許您覆寫 base URL 的 OpenAI 相容 SDK。
  </Accordion>

  <Accordion title="CometAPI 是否提供免費試用或免費 API key？">
    您可以從控制台建立 CometAPI API key。如需查看免費試用是否可用、免費試用額度與計費詳細資訊，請參閱 [CometAPI pricing page](https://www.cometapi.com/pricing/) 和 [About Pricing](/zh-Hant/pricing/about-pricing)。
  </Accordion>
</AccordionGroup>

<script type="application/ld+json">
  {`
    {
    "@context": "https://schema.org",
    "@graph": [
      {
        "@type": "HowTo",
        "name": "CometAPI 快速入門：建立 API key 並進行第一次呼叫",
        "description": "給首次使用者的 CometAPI 快速入門：登入、建立 API key、複製 key、設定 base URL，並使用 curl、Python 或 Node.js 進行第一次 API 呼叫。",
        "step": [
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/overview/quick-start#sign-in-or-create-an-account",
            "name": "登入或建立帳戶",
            "text": "開啟 https://www.cometapi.com/console/login，然後使用 Google、GitHub 或電子郵件繼續。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/overview/quick-start#open-api-keys",
            "name": "開啟 API key",
            "text": "登入後，開啟 https://www.cometapi.com/console/token，或在控制台側邊欄中選擇 API Keys。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/overview/quick-start#create-an-api-key",
            "name": "建立 API key",
            "text": "點擊 Create API Key，輸入名稱，選擇配額設定，然後點擊 Create。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/overview/quick-start#copy-the-api-key",
            "name": "複製 API key",
            "text": "點擊 Key 欄位中的複製按鈕，並將 key 儲存在伺服器端環境變數或本機 .env 檔案中。"
          },
          {
            "@type": "HowToStep",
            "name": "設定 base URL",
            "text": "將 https://api.cometapi.com/v1 作為 OpenAI 相容 SDK 和 API 呼叫的 base URL。"
          },
          {
            "@type": "HowToStep",
            "name": "進行第一次呼叫",
            "text": "使用 curl、Python 或 Node.js 呼叫 /v1/chat/completions，並將 your-model-id 替換為來自 CometAPI Models 頁面的目前 model ID。"
          }
        ]
      },
      {
        "@type": "FAQPage",
        "mainEntity": [
          {
            "@type": "Question",
            "name": "如何建立 CometAPI 帳戶？",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "開啟 CometAPI 登入頁面，然後使用 Google、GitHub 或電子郵件繼續。如果您還沒有帳戶，可以在同一頁完成帳戶建立。"
            }
          },
          {
            "@type": "Question",
            "name": "如何取得 CometAPI API key？",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "在 CometAPI 控制台中開啟 API key 頁面，點擊 Create API Key，輸入名稱，點擊 Create，然後複製產生的 API key。"
            }
          },
          {
            "@type": "Question",
            "name": "我應該將 API key 儲存在哪裡？",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "將您的 API key 儲存在伺服器端環境變數或本機 .env 檔案中。不要將它提交到公開儲存庫、貼到前端程式碼中、包含在螢幕截圖裡，或透過支援工單傳送。"
            }
          },
          {
            "@type": "Question",
            "name": "CometAPI 用於 API 呼叫的 base URL 是什麼？",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "對於 OpenAI 相容的 SDK 和端點，請使用 https://api.cometapi.com/v1。"
            }
          },
          {
            "@type": "Question",
            "name": "CometAPI 是否可搭配 OpenAI Python SDK 使用？",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "可以。建立一個 OpenAI client，將 api_key 設為您的 CometAPI API key，並將 base_url 設為 https://api.cometapi.com/v1。"
            }
          },
          {
            "@type": "Question",
            "name": "如何從 OpenAI 切換到 CometAPI？",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "將 base URL 改為 https://api.cometapi.com/v1，把 API key 換成您的 CometAPI API key，並使用來自 Models 頁面的 CometAPI model ID。"
            }
          },
          {
            "@type": "Question",
            "name": "我應該先使用哪個 model ID？",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "請依據使用情境選擇 model ID。先從 Models 頁面開始，然後選擇符合您打算呼叫之 API 頁面的聊天、程式設計、圖片或影片模型。"
            }
          },
          {
            "@type": "Question",
            "name": "CometAPI 支援哪些程式語言？",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "CometAPI 可搭配任何能傳送 HTTPS 請求的程式語言使用。您可以先從 curl、Python 和 Node.js 範例開始，或使用允許您覆寫 base URL 的 OpenAI 相容 SDK。"
            }
          },
          {
            "@type": "Question",
            "name": "CometAPI 是否提供免費試用或免費 API key？",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "您可以從控制台建立 CometAPI API key。如需查看免費試用是否可用、免費試用額度與計費詳細資訊，請參閱 CometAPI pricing page 和 About Pricing 頁面。"
            }
          }
        ]
      }
    ]
    }
    `}
</script>