快速开始与身份认证

欢迎使用 XIMI-API 企业级 AI 聚合平台！本文档将引导您快速了解如何发起第一次 API 请求并完成身份认证。

---

1. 认证机制 (Authentication)

XIMI-API 网关采用行业标准的 Bearer Token 认证方式，与 OpenAI 官方认证规范完全保持一致。

在每次向 API 发起 HTTP 请求时，必须在 HTTP Header 中包含您的 API Key：

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

🔑 如何获取 API Key：

1. 登录 XIMI-API 控制台：https://www.ximi-api.cc.cd
2. 进入左侧菜单 API Key 管理。
3. 点击 创建密钥，输入密钥名称后点击确定并妥善保存生成的 sk-xxxxxxxx 密钥。

---

2. 第一个 API 请求 (cURL 示例)

您可以使用标准的 cURL 命令行测试网关连通性：

curl https://api.ximi-api.cc.cd/v1/chat/completions \
  -H "Authorization: Bearer sk-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      { "role": "user", "content": "Hello! 请用一句话介绍 XIMI-API 网关。" }
    ]
  }'

响应数据结构示例

{
  "id": "chatcmpl-9x7A8k2mQ1n0P9o8L7k6J5h4G3f2E1d",
  "object": "chat.completion",
  "created": 1722000000,
  "model": "gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "XIMI-API 是一个高可用、高性能的企业级 AI 聚合网关平台！"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 15,
    "completion_tokens": 18,
    "total_tokens": 33
  }
}

---

3. SDK 快速接入示例

Python (OpenAI 官方 SDK)

无需修改任何代码逻辑，仅需指定 base_url 与 api_key 即可：

from openai import OpenAI

client = OpenAI(
    api_key="sk-YOUR_API_KEY",
    base_url="https://api.ximi-api.cc.cd/v1"  # 注意末尾加上 /v1
)

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "system", "content": "你是一位专业的 AI 助手。"},
        {"role": "user", "content": "请写一段 Python 快速排序代码。"}
    ]
)

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

Node.js (OpenAI 官方 SDK)

import OpenAI from 'openai';

const openai = new OpenAI({
  apiKey: 'sk-YOUR_API_KEY',
  baseURL: 'https://api.ximi-api.cc.cd/v1',
});

async function main() {
  const completion = await openai.chat.completions.create({
    messages: [{ role: 'user', content: 'Hello!' }],
    model: 'gpt-4o',
  });

  console.log(completion.choices[0].message.content);
}

main();