侠客AI 开发文档

Appearance

快速开始 ​

本指南帮助你在 3 分钟内完成网关接入，并发出第一条对话请求。

前置要求 ​

  1. 在控制台创建并获取 API Key
  2. 准备运行环境：Python 3.8+ 或 Node.js 18+
  3. 确认网络可访问 API 网关

选择接入方式 ​

网关兼容 OpenAI / Anthropic / Gemini 协议，推荐优先使用 OpenAI 兼容方式。

OpenAI 兼容协议示例 ​

  • Base URL：https://api.inxk.com/v1
  • 鉴权方式：Authorization: Bearer <YOUR_API_KEY>
  • 内容类型：application/json

WARNING

请勿在前端代码或公开仓库中明文保存 API Key。

查询模型列表 ​

请求 ​

bash
export XK_BASE_URL="https://api.inxk.com/v1"
export XK_API_KEY="YOUR_API_KEY"

curl -X GET "$XK_BASE_URL/models" \
  -H "Authorization: Bearer $XK_API_KEY"

响应 ​

json
{
	"object": "list",
	"data": [
		{
			"id": "openai/gpt-5.3-codex",
			"object": "model"
		},
		{
			"id": "anthropic/claude-opus-4.6",
			"object": "model"
		}
	]
}

发起对话请求 ​

cURL ​

bash
curl -X POST "$XK_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $XK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-5.3-codex",
    "messages": [
      {"role": "user", "content": "你好，帮我总结这段文本"}
    ],
    "temperature": 0.7
  }'

JavaScript (fetch) ​

js
const baseUrl = "https://api.inxk.com/v1";
const response = await fetch(baseUrl + "/chat/completions", {
	method: "POST",
	headers: {
		"Authorization": "Bearer " + process.env.XK_API_KEY,
		"Content-Type": "application/json"
	},
	body: JSON.stringify({
		model: "openai/gpt-5.3-codex",
		messages: [{ role: "user", content: "你好，给我一个学习计划" }],
		temperature: 0.6
	})
});

const data = await response.json();
console.log(data);

Python (requests) ​

python
import os
import requests

base_url = "https://api.inxk.com/v1"
url = f"{base_url}/chat/completions"
headers = {
    "Authorization": f"Bearer {os.environ['XK_API_KEY']}",
    "Content-Type": "application/json",
}
payload = {
    "model": "openai/gpt-5.3-codex",
    "messages": [{"role": "user", "content": "请帮我生成会议纪要模板"}],
    "temperature": 0.5,
}

res = requests.post(url, headers=headers, json=payload, timeout=30)
print(res.status_code)
print(res.json())

常见错误码 ​

状态码含义建议处理
400请求参数错误检查字段名、类型和必填项
401鉴权失败检查 API Key 是否正确、是否过期
429触发限流增加重试和退避机制
500服务内部错误记录 request_id 并联系支持

重试建议 ​

对于 429 或短时 5xx，建议使用指数退避：

text
第 1 次重试: 1s
第 2 次重试: 2s
第 3 次重试: 4s
最大重试次数: 3

下一步 ​