Skip to content

通用

通用接口覆盖模型查询、对话、Responses、Claude Messages、文本嵌入、补全、音频、重排序、内容审核与实时连接。统一使用雪羊 AI API Key 鉴权。

获取模型列表

格式方法请求地址
OpenAIGET/v1/models
GeminiGET/v1beta/models
bash
curl 'https://xueyangai.com/v1/models' \
  --header 'Authorization: Bearer sk-your-key'

OpenAI 格式(Chat)

兼容 OpenAI Chat Completions。现有 OpenAI SDK 只需替换接口基址和 API Key 即可接入。

基础信息

项目内容
接口基址https://xueyangai.com/v1
请求地址POST /chat/completions
完整地址https://xueyangai.com/v1/chat/completions
内容类型application/json
鉴权方式Authorization: Bearer <API Key>

请求示例

bash
curl --location 'https://xueyangai.com/v1/chat/completions' \
  --header 'Authorization: Bearer sk-your-key' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-4o",
    "messages": [
      {"role": "user", "content": "你好,请用一句话介绍自己。"}
    ],
    "temperature": 0.7,
    "stream": false,
    "max_tokens": 1024
  }'

请求参数

参数类型必填说明
modelstring模型 ID。
messagesobject[]按顺序排列的对话消息。
temperaturenumber采样温度,值越高输出越随机。
top_pnumber核采样参数。
ninteger生成数量。
streamboolean是否以 SSE 流式返回,默认关闭。
stream_optionsobject流式响应选项。
stopstring停止序列。
max_tokensinteger最大生成 Token 数。
max_completion_tokensinteger最大补全 Token 数。
presence_penaltynumber降低重复主题的倾向。
frequency_penaltynumber降低重复词语的倾向。
toolsobject[]工具调用定义。
tool_choicestringnoneautorequired
response_formatobject指定输出格式。
seedinteger尝试复现输出的随机种子。
reasoning_effortstring推理强度:lowmediumhigh

JavaScript 调用

js
const response = await fetch('https://xueyangai.com/v1/chat/completions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${process.env.XUEYANGAI_API_KEY}`
  },
  body: JSON.stringify({
    model: 'gpt-4o',
    messages: [{ role: 'user', content: '用三点总结这段文本。' }]
  })
})

const data = await response.json()
console.log(data.choices[0].message.content)

响应结构

成功响应的核心字段如下:

json
{
  "id": "id_xxx",
  "object": "chat.completion",
  "created": 1790250000,
  "model": "gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好,我是一个 AI 助手。"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 12,
    "completion_tokens": 10,
    "total_tokens": 22
  }
}

状态码

状态码含义处理建议
200请求成功读取 choices[0].message.content
400请求参数错误检查 modelmessages 和 JSON 格式。
401API Key 无效重新复制密钥,确认 Bearer 前缀。
404路径或模型不存在检查完整接口地址和模型 ID。
429额度不足或请求过于频繁补充额度或稍后重试。

安全建议

  • 在服务端或环境变量中保存 API Key,不要放在浏览器前端。
  • 给不同应用使用不同密钥,便于定位和撤销。
  • 生产环境记录请求 ID 和状态码,不要记录完整的 Authorization 请求头。

OpenAI 格式(Responses)

方法请求地址说明
POST/v1/responses创建 OpenAI Responses API 响应。
POST/v1/responses/compact压缩较长的对话上下文。
bash
curl 'https://xueyangai.com/v1/responses' \
  --header 'Authorization: Bearer sk-your-key' \
  --header 'Content-Type: application/json' \
  --data '{"model":"gpt-4o","input":"你好"}'

Claude 格式(Messages)

使用 Anthropic Claude Messages 请求格式创建对话。

text
POST /v1/messages

请求头需要包含 Authorization: Bearer <API Key>Content-Type: application/json

Gemini 格式

方法请求地址说明
POST/v1/engines/{model}/embeddingsGemini 格式嵌入接口。

Gemini 图片生成接口位于图片接口

OpenAI 格式(Embeddings)

text
POST /v1/embeddings

将文本或文本数组转换为向量。请求体至少包含 modelinput

json
{
  "model": "text-embedding-3-small",
  "input": ["第一段文本", "第二段文本"]
}

文本补全(Completions)

text
POST /v1/completions

兼容旧版 OpenAI Completions 格式。新项目优先使用 Chat Completions 或 Responses API。

OpenAI 音频(Audio)

方法请求地址说明
POST/v1/audio/transcriptions将音频转写为文本。
POST/v1/audio/translations将音频翻译为文本。
POST/v1/audio/speech将文本转换为语音。

上传音频时使用 multipart/form-data;语音合成使用 application/json

重排序(Rerank)

text
POST /v1/rerank

对候选文档进行相关性重排序。请求体包含查询文本、候选文档和模型 ID。

内容审核(Moderations)

text
POST /v1/moderations

检测输入内容中的潜在风险类别。请求体包含 modelinput

实时接口(Realtime)

text
GET /v1/realtime

建立实时 WebSocket 连接。客户端需要在握手阶段携带有效的 API Key。

由雪羊科技维护