文档
进入控制台
文档目录
本页目录

集成

开发 SDK

把支持的 SDK 指向 KHaiXAPI，即可按对应协议接入文本生成模型。先确认工具使用的协议，再运行最小文字示例。

选择 SDK 与协议

SDK 或语言协议Base URL本页覆盖
OpenAI PythonResponseshttps://api.khaix.net/v1完整示例
OpenAI JavaScriptResponseshttps://api.khaix.net/v1完整示例
OpenAI .NET、Java、Go、Ruby以 SDK 支持的 OpenAI 协议为准https://api.khaix.net/v1官方 SDK 索引；本页未实测
Anthropic PythonAnthropic Messageshttps://api.khaix.net完整示例
Anthropic TypeScriptAnthropic Messageshttps://api.khaix.net完整示例
Anthropic C#、Go、Java、PHP、RubyAnthropic Messageshttps://api.khaix.net官方 SDK 索引；本页未实测
Vercel AI SDK显式选择 Responses 或 Chat Completionshttps://api.khaix.net/v1两种协议示例
LangChain ChatOpenAIChat Completionshttps://api.khaix.net/v1基础文本示例

“官方 SDK 索引”表示该语言存在厂商维护的 SDK，不表示 KHaiXAPI 已逐语言验证全部功能。先完成最小文本请求，再分别验证流式、工具、结构化输出和多模态。示例从 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 兼容接口提供不同的 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-openai 的 ChatOpenAI 通过 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 版本和传入字段。

按能力选择模型

模型来源或名称不能决定 SDK 是否兼容。先在模型广场确认模型 ID 和可用分组，再按工作负载核对协议与能力；更换模型时还要同步客户端中的上下文、输出上限、输入类型和推理能力元数据。

工作负载必须核对接入动作
编码与工具工具调用、并行工具、流式工具参数先完成纯文本，再用只读工具验证完整回传循环
长文与长会话上下文窗口、最大输出、客户端压缩策略使用已确认的限制，避免依赖客户端默认值
图片理解图片输入格式与所选协议单独验证多模态输入；图片生成仍走图像生成 API
推理任务推理字段、摘要字段、状态保存行为不要把一个协议的推理参数直接复制到另一个协议
低延迟或低成本当前价格、分组、限额和实际延迟用代表性请求压测，以控制台实际记录为准

模型元数据与兼容边界详见模型与能力。

上线检查

  • 输入范围：文本 SDK 示例只发送文字；图像生成与图片编辑请使用图像生成 API，不要把 gpt-image-2 当作聊天模型。
  • 密钥：每个应用使用独立密钥，通过环境变量或 Secret 注入，并准备轮换流程。
  • 协议：记录当前调用的是 Responses 还是 Chat Completions，升级 provider 后重新确认。
  • 超时与重试：仅对可安全重试的失败采用指数退避，避免重复提交非幂等操作。
  • 日志：记录请求时间、模型、协议、HTTP 状态和请求 ID，过滤完整密钥和敏感 Prompt。
  • 高级能力：基础文字调用通过后，分别验证流式、工具和结构化输出。