快速开始
抖音、B站、快手、小红书 Web 端相关数据接口的 Node.js 封装与服务
本项目专为 karin-plugin-kkk 服务
amagi 作为 karin-plugin-kkk 的核心数据层，以 Git 子模块方式提供多平台数据获取能力。功能迭代主要围绕 karin-plugin-kkk 的业务需求进行。
如需其他接口支持，请参考开发文档自行封装，或提交 Pull Request 贡献代码。
它能做什么
- 覆盖四个平台：抖音、B站、快手、小红书，收录了各平台主流的数据接口
- 两种用法：在代码中直接调用方法，或用一行代码启动为本地 HTTP 服务
- 参数即时校验：每个接口的参数都经 Zod 校验，漏填或填错会在请求发出前被指出
- 返回值格式统一：无论哪个平台、哪个接口，返回的都是同一种结构。先判断
success，成功读取data，失败读取error - 类型随接口而定：返回值的类型即接口本身的类型，无需手动声明，也没有开关需要设置
- 内置常用工具：签名算法、URL 拼接、AV/BV 号互转等
- 同时支持 ESM 与 CJS
本节内容
快速上手
三步上手：创建客户端、获取数据、按 success 读取返回值
安装
安装 @ikenxuan/amagi
SDK 使用指南
详细了解如何使用 amagi SDK
响应类型
v7 的响应类型模型与三条逃生舱（typeMode 已移除）
工具集
amagi 提供的各平台工具函数
自定义请求
用 client.<平台>.request 请求 amagi 尚未收录的接口，含双轨语义、amagi 子对象、反爬参数精调，以及 apiUrls 的返回形态
事件系统
实例级事件总线的 15 个事件、带 meta 的负载，以及 v6 全局单例的去处
HTTP 服务
使用 amagi 启动本地 HTTP 服务
B站 SDK 方法
B站平台的 27 个 SDK 方法，由端点注册表派生
抖音 SDK 方法
抖音平台的 26 个 SDK 方法，由端点注册表派生
快手 SDK 方法
快手平台的 14 个 SDK 方法，由端点注册表派生
小红书 SDK 方法
小红书平台的 13 个 SDK 方法，由端点注册表派生
HTTP 端点参考
80 个 HTTP 端点，由端点注册表派生的 OpenAPI 规范生成
类型参考
481 个公开导出的总索引，按页面分组
从 v6 迁移
v6 → v7 的四处必改、一行切回 v6 语义的 /compat，以及完整迁移矩阵
相关链接
本文档由 AI 辅助生成，可能存在描述不准确、示例代码过时或遗漏关键信息等问题。如发现错误或疑问，请以实际代码实现为准，或提交 Issue 反馈。
最后更新于 2026-09-27