Skip to content

AI API Gateway — API 调用手册

网关地址: https://ai.ospreyai.cn 鉴权方式: Bearer Token(new-api sk-xxx 格式)


目录


通用说明

鉴权

所有 API 均需 Bearer Token 鉴权(/health/webui/ 除外):

bash
curl -H "Authorization: Bearer sk-your-api-key" https://ai.ospreyai.cn/api/v1/...

网关通过 auth_request 将 Bearer Token 转发给 new-api 验证有效性。有效 key 返回 200,无效 key 返回 401。

Bearer Token 透传(RAGFlow / Dify 专用)

RAGFlow 和 Dify 自身需要 Authorization: Bearer xxx,与网关鉴权共用同一 header。 后端 Bearer token 通过 X-Authorization header 传入,网关自动转为 Authorization 转发给后端。

bash
curl -H "Authorization: Bearer sk-your-api-key" \
  -H "X-Authorization: Bearer <你的后端token>" \
  https://ai.ospreyai.cn/api/v1/rag/...

若未传 X-Authorization,网关会清空转发给后端的 Authorization header(避免 sk-xxx 泄露给后端服务),后端将返回 401。

限流

类型速率适用路径
AI 接口10 次/分/IP(突发 5)/api/v1/ai/*
普通接口60 次/分/IP(突发 10-20)/api/v1/embed/*, /api/v1/rerank/*, /api/v1/rag/*, /api/v1/search

超限返回 429 Too Many Requests

环境变量

以下示例中使用变量:

bash
export GW="https://ai.ospreyai.cn"              # 网关地址
export API_KEY="sk-your-api-key"         # Bearer Token

服务目录

网关代理以下后端服务,按功能大类组织:

图像生成

基于 ComfyUI(公网 https://ai.ospreyai.cn,无需后端 Bearer Token),任务异步执行(提交 → 轮询 → 下载)。

视频生成

基于 ComfyUI(公网 https://ai.ospreyai.cn,无需后端 Bearer Token),任务异步执行(提交 → 轮询 → 下载)。

音频生成

基于 ComfyUI(公网 https://ai.ospreyai.cn,无需后端 Bearer Token),任务异步执行(提交 → 轮询 → 下载)。音频提交端点为 /api/v1/ai/audio/generate,结果在 outputs[].audio 字段。

任务管理

图像/视频生成任务共用的通用接口:

向量与重排序

搜索

RAG 知识库

工作流编排

  • Dify — 工作流编排 — 工作流对话(阻塞/流式)与参数获取。需后端 Bearer TokenX-Authorization

AI 助手对话式接入

本网关提供 Skill 文件,可被 AI 智能体学习并通过自然语言对话调用 API。主要场景为龙虾(OpenClaw)智能体接入,同时兼容 Claude Code、Cursor 等 AI 助手。

什么是龙虾(OpenClaw)

龙虾(OpenClaw) 是团队内部的 AI 智能体平台,支持通过加载 Skill 文件扩展能力。将网关 Skill 文件导入龙虾智能体后,即可在对话中直接调用 ComfyUI 图片生成、视频生成等 API,无需手动编写 curl 命令。

可用 Skill 列表

Skill下载地址功能
ComfyUI 图片生成https://ai.ospreyai.cn/docs/raw/skills/comfyui-image-generation.md文生图,1024×1024
ComfyUI 视频生成https://ai.ospreyai.cn/docs/raw/skills/comfyui-video-generation.md图生视频,Wan2.2 I2V
ComfyUI 关键帧视频https://ai.ospreyai.cn/docs/raw/skills/comfyui-keyframes-video-generation.md6 关键帧首尾帧视频,Wan2.2 FLF2V

方式一:龙虾智能体在线学习(推荐)

在龙虾对话中发送以下指令,智能体会自动下载并学习 Skill 内容:

学习:https://ai.ospreyai.cn/docs/raw/skills/comfyui-image-generation.md,保存为本地的技能 skills
学习:https://ai.ospreyai.cn/docs/raw/skills/comfyui-video-generation.md,保存为本地的技能 skills
学习:https://ai.ospreyai.cn/docs/raw/skills/comfyui-keyframes-video-generation.md,保存为本地的技能 skills

学习完成后,龙虾智能体会:

  1. 理解 API 调用流程(提交工作流 → 轮询状态 → 下载结果)
  2. 将 Skill 保存到本地技能目录
  3. 后续对话中自动匹配触发词,按 Skill 流程调用 API

方式二:手动加载

先下载 Skill 文件到本地,再让智能体读取:

bash
# 创建技能目录并下载
mkdir -p .skills
curl https://ai.ospreyai.cn/docs/raw/skills/comfyui-image-generation.md -o .skills/comfyui-image-generation.md
curl https://ai.ospreyai.cn/docs/raw/skills/comfyui-video-generation.md -o .skills/comfyui-video-generation.md

然后在对话中:

请阅读 .skills/comfyui-image-generation.md,学习 ComfyUI 图片生成技能。
之后我说"生成一张 xxx 的图片"时,按此 Skill 的流程调用 API。

对话使用示例

学习 Skill 后,可在龙虾中直接用自然语言触发:

你说的话智能体执行的动作
"生成一张可爱小狗的图片"提交工作流 → 轮询状态 → 下载 PNG
"用 50 步采样生成一张风景照"修改 steps=50,提交 → 轮询 → 下载
"查看当前队列状态"调用 GET /api/v1/ai/queue
"换个种子重新生成"更换 seed 值,重新提交工作流
"把这张图片生成一段视频"提交 I2V 工作流 → 轮询 → 下载 MP4

环境变量配置

对话中使用前,需确保智能体知道以下信息:

网关地址: https://ai.ospreyai.cn
API Key:  sk-your-api-key(需提前申请)

可在项目根目录创建 .env 文件或在对话中直接告知智能体。


错误码参考

HTTP 状态码含义处理建议
200请求成功
400请求参数错误检查请求体格式
401鉴权失败检查 Bearer Token 是否有效
404路径不存在或资源未找到检查 URL 路径和 prompt_id
429请求被限流降低请求频率,稍后重试
503后端服务不可用检查内网服务是否运行

401 常见原因:

场景原因解决方案
所有 API 返回 401Bearer Token 无效或过期检查 sk-xxx key 是否正确
所有 API 返回 401缺少 Authorization header添加 -H "Authorization: Bearer sk-xxx"
RAGFlow/Dify 返回 401未传 X-Authorization添加 -H "X-Authorization: Bearer <token>"
RAGFlow/Dify 返回 401后端 Bearer Token 无效检查 API Key 是否正确、是否过期

AI API Gateway Documentation