文档目录
本页目录

集成

开发 SDK

把 SDK 的 Base URL 指向 KHaiXAPI,即可使用 OpenAI、Anthropic、Vercel AI SDK 或 LangChain。先确认 SDK 对应的协议,再运行下面的最小文字示例。

选择 SDK 与协议

SDK示例协议Base URL
OpenAI PythonResponseshttps://api.khaix.net/v1
OpenAI JavaScriptResponseshttps://api.khaix.net/v1
Anthropic PythonAnthropic Messageshttps://api.khaix.net
Anthropic TypeScriptAnthropic Messageshttps://api.khaix.net
Vercel AI SDK显式选择 Responses 或 Chat Completionshttps://api.khaix.net/v1
LangChain ChatOpenAIChat Completionshttps://api.khaix.net/v1

示例从 KHAIX_API_KEY 环境变量读取密钥。请在本机环境、部署平台 Secret 或密钥管理服务中设置该变量,源代码中只保留变量名。

OpenAI Python

安装或升级 OpenAI 官方 Python SDK

Terminal
python -m pip install --upgrade openai
Python · Responses
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["KHAIX_API_KEY"],
    base_url="https://api.khaix.net/v1",
)

response = client.responses.create(
    model="gpt-5.6-sol",
    input="请回复:Python 连接成功",
)

print(response.output_text)

如果 output_text 为空,输出完整的 response 检查事件和输出项。Responses 的返回结构中没有 Chat Completions 使用的 choices

OpenAI JavaScript

以下示例在 Node.js 或服务端路由中运行,密钥由后端环境变量提供。

Terminal
npm install openai
JavaScript · Responses
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.KHAIX_API_KEY,
  baseURL: "https://api.khaix.net/v1",
});

const response = await client.responses.create({
  model: "gpt-5.6-sol",
  input: "请回复:JavaScript 连接成功",
});

console.log(response.output_text);

Anthropic Python

安装或升级 Anthropic 官方 Python SDK。该 SDK 会在 Base URL 后拼接 /v1/messages,因此这里填写站点根地址,不加 /v1

Terminal
python -m pip install --upgrade anthropic
Python · Anthropic Messages
import os
from anthropic import Anthropic

client = Anthropic(
    api_key=os.environ["KHAIX_API_KEY"],
    base_url="https://api.khaix.net",
)

message = client.messages.create(
    model="claude-sonnet-5",
    max_tokens=256,
    messages=[{"role": "user", "content": "请回复:Python Messages 连接成功"}],
)

for block in message.content:
    if block.type == "text":
        print(block.text)

Anthropic TypeScript

以下示例使用 Anthropic 官方 TypeScript SDK,应在 Node.js、服务端路由或其他受信任的服务端运行时中执行。

Terminal
npm install @anthropic-ai/sdk
TypeScript · Anthropic Messages
import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  apiKey: process.env.KHAIX_API_KEY,
  baseURL: "https://api.khaix.net",
});

const message = await client.messages.create({
  model: "claude-sonnet-5",
  max_tokens: 256,
  messages: [{ role: "user", content: "请回复:TypeScript Messages 连接成功" }],
});

for (const block of message.content) {
  if (block.type === "text") console.log(block.text);
}

Vercel AI SDK

Vercel AI SDK 为 Responses 和通用 OpenAI Compatible 提供不同的 provider。调用 Responses 使用 @ai-sdk/openai;调用 Chat Completions 使用 @ai-sdk/openai-compatible

Responses provider

Terminal
npm install ai @ai-sdk/openai
TypeScript · Responses
import { createOpenAI } from "@ai-sdk/openai";
import { generateText } from "ai";

const khaix = createOpenAI({
  apiKey: process.env.KHAIX_API_KEY,
  baseURL: "https://api.khaix.net/v1",
});

const { text } = await generateText({
  model: khaix.responses("gpt-5.6-sol"),
  prompt: "请回复:Vercel AI SDK 连接成功",
});

console.log(text);

Chat Completions provider

Terminal
npm install ai @ai-sdk/openai-compatible
TypeScript · Chat Completions
import { createOpenAICompatible } from "@ai-sdk/openai-compatible";
import { generateText } from "ai";

const khaix = createOpenAICompatible({
  name: "khaix",
  apiKey: process.env.KHAIX_API_KEY,
  baseURL: "https://api.khaix.net/v1",
});

const { text } = await generateText({
  model: khaix("gpt-5.6-sol"),
  prompt: "请回复:Chat Completions 连接成功",
});

console.log(text);

LangChain

langchain-openaiChatOpenAI 通过 Chat Completions 接入。标准文字消息可直接使用;工具、结构化输出等扩展字段需逐项验证。

Terminal
python -m pip install --upgrade langchain-openai
Python · Chat Completions
import os
from langchain_openai import ChatOpenAI

model = ChatOpenAI(
    model="gpt-5.6-sol",
    api_key=os.environ["KHAIX_API_KEY"],
    base_url="https://api.khaix.net/v1",
)

message = model.invoke("请回复:LangChain 连接成功")
print(message.content)

遇到参数或流式问题时,先运行文字 API 页面的最小 Chat Completions 请求。若该请求正常,再检查 LangChain 版本和传入字段。

上线检查

  • 输入范围:只发送文字,不传入图片、音频、视频、附件或多媒体消息块。
  • 密钥:每个应用使用独立密钥,通过环境变量或 Secret 注入,并准备轮换流程。
  • 协议:记录当前调用的是 Responses 还是 Chat Completions,升级 provider 后重新确认。
  • 超时与重试:仅对可安全重试的失败采用指数退避,避免重复提交非幂等操作。
  • 日志:记录请求时间、模型、协议、HTTP 状态和请求 ID,过滤完整密钥和敏感 Prompt。
  • 高级能力:基础文字调用通过后,分别验证流式、工具和结构化输出。