Kaien API 提供统一的 API Key 和 OpenAI 兼容接口,用于接入文本、图片、视频、音频、文件、向量、重排和实时会话能力。Claude 和 Gemini 客户端也可以按各自的原生协议接入。

阅读顺序

新接入项目建议按这个顺序阅读:
  1. 在控制台创建或选择 API Key。
  2. 调用模型列表,确认当前 Key 可用的模型 ID。
  3. 选择接口类型:文本、图片、视频、音频或文件。
  4. 先跑通一个最小请求,再加入流式输出、工具调用、参考图、任务轮询等能力。
  5. 在用量页核对请求记录和费用。

基础信息

生产环境地址:
默认鉴权方式:
Claude 原生接口还接受 x-api-key。Gemini 原生接口还接受 x-goog-api-key?key=。除非客户端有特殊要求,统一使用 Bearer。

结果处理

不同类型接口的返回形态不同:
  • 文本结果通常在 choices[0].message.content 或 Responses 的输出数组中。
  • 图片结果可能是 URL,也可能是 base64。
  • 视频和音乐通常是任务模式,先返回任务 ID,再查询状态和结果。
  • 文件类接口需要区分上传、查看、下载和删除。
长期需要复用的图片、视频或音频结果,建议保存到自己的对象存储。

面向 AI 工具

文档站支持这些 AI 工具读取方式:
  • Copy as Markdown:把页面转换为适合 LLM 阅读的 Markdown。
  • skill.md:让 agent 快速理解 Kaien API 的能力、接口边界和接入顺序。
  • MCP 文档服务:说明当前自托管静态部署下的 MCP 接入边界。
这些能力用于让 Codex、Claude Code、Cursor、OpenCode、n8n 等工具读取 Kaien API 的接入说明。