> ## 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="CometAPI API keys 表中为已遮罩 API key 突出显示复制按钮" 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
```

## 在 30 秒内从 OpenAI 切换

获得 CometAPI API key 后，将 OpenAI SDK 客户端切换到 CometAPI 时，使用以下两处设置变更：

```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` 替换为来自 [Models page](/zh-Hans/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>

## 选择模型

从 [Models page](/zh-Hans/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)。 |

## 接下来做什么

* 如遇请求失败，请参阅 [Error Codes & Handling](/zh-Hans/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) 开始。
* 关于计费详情，请参阅 [About Pricing](/zh-Hans/pricing/about-pricing)。
* 如需邀请团队成员并管理共享额度，请参阅 [使用 Workspace 管理团队](/zh-Hans/workspace/overview)。
* 如需帮助，请参阅 [Help Center](/zh-Hans/support/help-center) 或联系 [CometAPI support](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` 客户端，将 `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-Hans/overview/models) 的 CometAPI model ID。
  </Accordion>

  <Accordion title="我应该首先使用哪个 model ID？">
    请根据使用场景选择 model ID。先从 [Models 页面](/zh-Hans/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 定价页面](https://www.cometapi.com/pricing/) 和 [关于定价](/zh-Hans/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 keys",
            "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": "对于 OpenAI 兼容的 SDK 和 API 调用，请使用 https://api.cometapi.com/v1 作为 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 客户端，将 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 定价页面和关于定价页面。"
            }
          }
        ]
      }
    ]
    }
    `}
</script>