NovelAI Nodejs SDK (非官方) 🎨

现代化、类型安全的 NovelAI 图像和文本生成 API TypeScript SDK。

✨ 特性

• 🔒 完整的 TypeScript 支持，基于 Zod 验证
• 🎯 高级 API（合理默认值）+ 低级 API（直接控制）
• 🖼️ 图像生成：V4.5/V4/V3 模型、角色参考、ControlNet、多角色
• 🎬 Director Tools：背景移除、线稿提取、上色、标签建议
• 📝 文本生成：Erato、Kayra、Clio 模型，支持流式输出
• 🔄 OpenAI 兼容 API：使用 GLM 模型，支持标准 OpenAI 格式的聊天和补全接口
• 📦 同时支持 ESM 和 CommonJS

📥 安装

pnpm add novelai-sdk-unofficial

🚀 快速开始

import { NovelAI } from "novelai-sdk-unofficial";
import { writeFileSync } from "fs";

const client = new NovelAI({ apiKey: "your-api-key" });

// 🖼️ 图像生成
const images = await client.image.generate({
  prompt: "1girl, cat ears, masterpiece, best quality",
  model: "nai-diffusion-4-5-full",
  size: "portrait",
});
writeFileSync("output.png", images[0]);

// 📝 文本生成
const text = await client.text.generate({
  input: "从前有座山",
  model: "llama-3-erato-v1",
  maxLength: 80,
});
console.log(text);

// 🔄 OpenAI 兼容 API (使用 GLM 模型)
const models = await client.openai.listModels();
const chat = await client.openai.chatCompletion({
  messages: [{ role: "user", content: "你好！" }],
  model: models[0].id, // glm-4-6
  maxTokens: 100,
});
console.log(chat.choices[0].message.content);

📚 文档

详细指南和 API 参考请访问文档站点。

🤖 AI 辅助开发

本项目提供 AI 友好的文档，方便 AI 编程助手理解和使用 SDK：

• Context7 - 已收录，支持 MCP 集成
• llms.txt - 精简版 AI 文档
• llms-full.txt - 完整版 AI 文档

💻 环境要求

• Node.js 18+
• 具有 API 访问权限的 NovelAI 订阅

📄 许可证

MIT 许可证。详见 LICENSE。

⚠️ 免责声明

这是一个非官方客户端库，与 NovelAI 官方无关。

🙏 致谢

• caru-ini/novelai-sdk - NovelAI API SDK for Python with full type hints and strong Pydantic v2 validation