快速开始：发出第一条请求

这一页只做一件事：用最小的 OpenAI 兼容请求确认你的 API Key、地址和模型 ID 可用。先完成这一步，再配置聊天客户端、代码助手或工作流工具。

你需要准备

在开始前，从 Xikapi 控制台准备两项内容：

• 一个 API Key。
• 一个已启用、且当前 Key 有权限调用的模型 ID。

下文中的 YOUR_XIKAPI_API_KEY 和 YOUR_MODEL_ID 必须替换。它们不是示例模型或真实密钥。

1. 临时保存 API Key

Windows PowerShell：

$env:XIKAPI_API_KEY = "YOUR_XIKAPI_API_KEY"
$env:XIKAPI_MODEL = "YOUR_MODEL_ID"

macOS 或 Linux：

export XIKAPI_API_KEY="YOUR_XIKAPI_API_KEY"
export XIKAPI_MODEL="YOUR_MODEL_ID"

这些命令只对当前终端窗口有效。关闭窗口后变量会消失，这正适合首次测试。长期配置请使用工具自己的密钥管理或服务器环境变量，不要把 Key 写进公开仓库。

2. 发送最小请求

Windows PowerShell：

$body = @{
  model = $env:XIKAPI_MODEL
  messages = @(
    @{ role = "user"; content = "Reply with OK only." }
  )
} | ConvertTo-Json -Depth 4

Invoke-RestMethod `
  -Uri "https://xikapi.com/v1/chat/completions" `
  -Method Post `
  -ContentType "application/json" `
  -Headers @{ Authorization = "Bearer $env:XIKAPI_API_KEY" } `
  -Body $body

macOS 或 Linux：

curl https://xikapi.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $XIKAPI_API_KEY" \
  -d "{\"model\":\"$XIKAPI_MODEL\",\"messages\":[{\"role\":\"user\",\"content\":\"Reply with OK only.\"}]}"

成功时会返回 JSON，通常包含模型生成的文本。只要收到正常响应，就说明 Key、完整请求地址和模型 ID 已连通。

3. 在代码中调用

JavaScript（安装官方 OpenAI SDK 后）：

npm install openai

import OpenAI from "openai";

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

const completion = await client.chat.completions.create({
  model: process.env.XIKAPI_MODEL,
  messages: [{ role: "user", content: "Reply with OK only." }],
});

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

Python（安装官方 OpenAI SDK 后）：

pip install openai

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["XIKAPI_API_KEY"],
    base_url="https://xikapi.com/v1",
)

completion = client.chat.completions.create(
    model=os.environ["XIKAPI_MODEL"],
    messages=[{"role": "user", "content": "Reply with OK only."}],
)

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

在 SDK 中，baseURL / base_url 只填到 /v1。不要填写 /v1/chat/completions，因为 SDK 会自动补上接口路径。

没有成功时先看这里

现象	优先检查	下一步
401 或 Invalid API Key	Key 是否来自 Xikapi、是否复制完整、环境变量是否生效	认证与 Key
404	SDK 的 Base URL 是否误填成完整接口路径	Base URL 规则
model not found 或 403	模型 ID 是否与控制台一致，Key 是否有模型权限	模型与权限
400 或参数不支持	是否把不同协议的字段混用，是否一次开启了高级参数	报错指南
429、超时或 5xx	额度、速率、上游临时状态和超时设置	报错指南

接下来做什么

• 想在桌面聊天软件里使用：去 个人聊天工具。
• 想让 AI 协助写代码：去 代码开发工具。
• 想做知识库或自动化：去 知识库与自动化。
• 想选其他协议或高级能力：去 API 参考。