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

# 快速开始

> 使用 AIOAGI API Key 和 OpenAI 兼容接口完成第一次模型调用。

本页展示最小接入流程。你只需要准备 API Key、选择端点和模型名称，即可调用聊天补全接口。

<Info>
  服务端点以控制台和开发者指南展示为准。常用 OpenAI 兼容端点为 `https://api.aiearth.dev/v1` 和 `https://api.aiearth.vip/v1`。
</Info>

<Tip>
  如果你还没有 API Key，请先阅读 [API Key 全流程指南](/api-key-guide)。该指南覆盖充值、兑换、创建令牌和配置聊天应用。
</Tip>

## 前置条件

* 已登录 [AIOAGI 控制台](https://api.aiearth.dev)。
* 已创建 API Key。
* 已确认账户余额或 Token 组配额充足。
* 本地已安装 `curl`、Python 或 Node.js 中的一种。

## 三步完成接入

<Steps>
  <Step title="配置环境变量">
    在服务端环境中保存 API Key。

    ```bash theme={null}
    export AIO_API_KEY="sk-your-api-key"
    export AIO_BASE_URL="https://api.aiearth.dev/v1"
    ```
  </Step>

  <Step title="选择模型">
    在控制台或开发者指南中查看可用模型名称。常见模型系列包括 GPT、Claude、DeepSeek、Gemini、Qwen 和 Vibe Coding。
  </Step>

  <Step title="发送请求">
    调用 `POST /chat/completions`，请求结构与 OpenAI Chat Completions 兼容。
  </Step>
</Steps>

## 官网推荐流程

官网首页把新用户流程概括为四步：

<Steps>
  <Step title="注册或登录">
    打开 [AIOAGI 控制台](https://api.aiearth.dev)，完成登录。
  </Step>

  <Step title="充值或兑换额度">
    通过控制台 **钱包** 和 [卡密商城](https://shop.aiearth.dev/) 完成额度准备。
  </Step>

  <Step title="创建 API Key">
    在 **令牌** 页面创建 Key，并选择合适的分组、额度和有效期。
  </Step>

  <Step title="修改端点并调用">
    在你的应用、SDK 或客户端中替换 `base_url` 和 `api_key`，然后选择模型发起请求。
  </Step>
</Steps>

## curl 示例

```bash theme={null}
curl "$AIO_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $AIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [
      {
        "role": "system",
        "content": "You are a concise assistant."
      },
      {
        "role": "user",
        "content": "用一句话介绍 AIOAGI。"
      }
    ],
    "temperature": 0.7
  }'
```

## Python 示例

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

client = OpenAI(
    api_key=os.environ["AIO_API_KEY"],
    base_url=os.environ.get("AIO_BASE_URL", "https://api.aiearth.dev/v1"),
)

response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[
        {"role": "system", "content": "You are a concise assistant."},
        {"role": "user", "content": "用一句话介绍 AIOAGI。"},
    ],
)

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

## JavaScript 示例

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

const client = new OpenAI({
  apiKey: process.env.AIO_API_KEY,
  baseURL: process.env.AIO_BASE_URL ?? "https://api.aiearth.dev/v1",
});

const response = await client.chat.completions.create({
  model: "gpt-4o-mini",
  messages: [
    { role: "system", content: "You are a concise assistant." },
    { role: "user", content: "用一句话介绍 AIOAGI。" },
  ],
});

console.log(response.choices[0].message.content);
```

## 端点选择

<ParamField path="https://api.aiearth.dev/v1" type="base URL">
  通用 OpenAI 兼容 API 端点，适合大多数服务端调用。
</ParamField>

<ParamField path="https://api.aiearth.vip/v1" type="base URL">
  CDN 加速端点，适合对连接质量和访问速度更敏感的场景。
</ParamField>

<ParamField path="https://api-s1.aiearth.dev/v1" type="base URL">
  适用于余额查询、实时语音等指定能力。请以控制台说明为准。
</ParamField>

## 常见错误

<AccordionGroup>
  <Accordion title="401 Unauthorized" icon="key">
    检查 `Authorization` 请求头是否为 `Bearer sk-...` 格式，并确认 API Key 未被删除或禁用。
  </Accordion>

  <Accordion title="模型不存在" icon="circle-question">
    模型名称必须与控制台展示一致。不同供应商模型可能有不同命名方式。
  </Accordion>

  <Accordion title="余额不足或配额不足" icon="coins">
    进入控制台检查账户余额、Token 组额度和调用限制。
  </Accordion>
</AccordionGroup>

<Card title="服务状态与支持" icon="life-ring" horizontal href="/service-status">
  如果你遇到网络、额度、分组或模型问题，请按服务状态页的排查顺序处理。
</Card>
