# Amagi 文档

- V7
  - Agent Skills: 让 AI 助手更好地理解
    - [Agent Skills](/amagi/docs/v7/ai): 让 AI 编码助手直接读取 amagi 文档与调用接口
    - [LLMs.txt](/amagi/docs/v7/ai/llms-txt): 让 AI 助手理解 Amagi 文档
  - 发布说明: 版本维度的变更记录

    - **概述**
    - [所有版本](/amagi/docs/v7/changelog): amagi v7 全部版本的发布说明 —— 新功能、修复与破坏性变更

    - **版本列表**
    - [v7.0.0-beta.10](/amagi/docs/v7/changelog/7.0.0-beta.10): 2026-10-24 发布的 v7 第十个 beta —— 抖音风控挑战自动处理与验证页、扫码登录补齐四个平台、B站 Cookie 续期、15 个新端点
    - [v7.0.0-beta.9](/amagi/docs/v7/changelog/7.0.0-beta.9): 2026-10-12 发布的 v7 第九个 beta —— 小红书签名算法内联（@ikenxuan/xhshow-ts 依赖退役）、游客 CK 自动铸造、全端点打通、HTTP 461 归为 RISK_CONTROL、翻页中途失败返回部分结果
    - [v7.0.0-beta.8](/amagi/docs/v7/changelog/7.0.0-beta.8): 2026-10-05 发布的 v7 第八个 beta —— 签名验证扩成全平台入口；抖音 403 根因修复与访客 id 自动铸造（SIGNATURE_REFUSED 归因、verify_center 判人机验证、缺访客 id 自动铸造并合并）
    - [v7.0.0-beta.7](/amagi/docs/v7/changelog/7.0.0-beta.7): 2026-10-02 发布的 v7 第七个 beta —— SDK 参数类型语义化：数字参数告别 unknown、B站评论枚举收窄、内部翻页参数退场；抖音弹幕加 7 天保险丝与分片限流
    - [v7.0.0-beta.6](/amagi/docs/v7/changelog/7.0.0-beta.6): 2026-09-29 发布的 v7 第六个 beta —— 开放 sign-steps 子入口精细控制反爬参数，修抖音裸请求丢 msToken，收敛 fetcher 类型打印
    - [v7.0.0-beta.5](/amagi/docs/v7/changelog/7.0.0-beta.5): 2026-09-25 发布的 v7 第五个 beta —— 移除 chalk 子路径导出，端点契约新增 aggregate 钩子与签名器名收窄
    - [v7.0.0-beta.4](/amagi/docs/v7/changelog/7.0.0-beta.4): 2026-09-21 发布的 v7 第四个 beta —— 修复发版脚本的幻影暂存
    - [v7.0.0-beta.3](/amagi/docs/v7/changelog/7.0.0-beta.3): 2026-09-21 发布的 v7 第三个 beta —— 发版链路从 release-please 换成自研脚本
    - [v7.0.0-beta.2](/amagi/docs/v7/changelog/7.0.0-beta.2): 2026-09-20 发布的 v7 第二个 beta —— 抖音搜索翻页修复与小红书签名适配
    - [v7.0.0-beta.1](/amagi/docs/v7/changelog/7.0.0-beta.1): 2026-09-17 发布的 v7 首个公开版本 —— 端点注册表驱动的重构
  - 开发者文档: 上手四页给人扫读；「内部机制」逐子系统讲清特点与机制，写给 AI 代理与深度贡献者

    - **上手**
    - [开始开发](/amagi/docs/v7/dev): 环境、仓库地图、开发闭环与该跑哪几道门，以及「我要做 X 该读哪一页」
    - [项目架构](/amagi/docs/v7/dev/architecture): amagi v7 的目录布局、依赖方向与核心概念
    - [新增接口](/amagi/docs/v7/dev/add-api): v7 中新增一个平台接口只需一份端点声明
    - [贡献指南](/amagi/docs/v7/dev/contributing): 提交规范和 PR 流程

    - **内部机制**
    - [内部机制](/amagi/docs/v7/dev/internals): 面向 AI 代理与深度贡献者的逐子系统机制说明，讲清每一层做什么、为什么这么做
    - [契约与信封](/amagi/docs/v7/dev/internals/contracts): contracts 是全仓的词汇表 —— AmagiResult、AmagiError、EndpointDef 的确切形状与三条硬约束
    - [端点注册表](/amagi/docs/v7/dev/internals/registry): 一份端点声明如何派生出方法、路由、类型、OpenAPI 与文档 —— amagi v7 最核心的设计
    - [请求生命周期](/amagi/docs/v7/dev/internals/lifecycle): 一次调用从入参到信封，中间的九个阶段、唯一一处 catch，以及 attempts 到底数的是什么
    - [传输与签名](/amagi/docs/v7/dev/internals/transport): 全仓唯一发请求的地方：header 合并顺序、重试策略、四个平台的签名机制，以及快手那条没接上的线
    - [签名与反爬](/amagi/docs/v7/dev/internals/signing): 签名的两层结构（steps 单一实现、signers 薄壳）、SignPhase 四阶段排序、端点声明与裸请求两条路径如何汇入同一份实现，以及有状态签名器为何进程内共享
    - [事件与可观测性](/amagi/docs/v7/dev/internals/events): 15 个事件、它们的触发点、meta 如何被补上，以及两套并存的事件系统如何区分
    - [翻页与会话](/amagi/docs/v7/dev/internals/session): 声明式翻页的收敛条件与聚合方式，扫码登录的状态机，以及实现与设计文档不一致的几处
    - [公开 API 表面](/amagi/docs/v7/dev/internals/surface): 六个导出子路径、默认导入的真实形状、/compat 做了什么、HTTP 服务的两个 startServer
    - [仓库工程](/amagi/docs/v7/dev/internals/repo): 构建、测试、CI 门禁与代码约定 —— 改代码之前需要知道什么会红

    - **签名验证**
    - [为什么签名需要被验证](/amagi/docs/v7/dev/sign-verify): 平台对签名是抽样校验的，「请求成功」证明不了任何事；四个平台的验证器与它们各自的验证强度
    - [抖音](/amagi/docs/v7/dev/sign-verify/douyin): a_bogus / X-Bogus / secsdk / 访客令牌 —— 四个验证器，以及各自的常量表与边界
    - [B站](/amagi/docs/v7/dev/sign-verify/bilibili): w_rid 重算比对与 av/bv 互转 —— 两个完全可验的纯函数签名
    - [快手](/amagi/docs/v7/dev/sign-verify/kuaishou): $HE_ 段可整段拆开（时钟与计数器原样读回）；HUDR 段拆不开，说了就是答案
    - [小红书](/amagi/docs/v7/dev/sign-verify/xiaohongshu): x-s 的算法本体进不了浏览器 —— 这里只有形状检查；XYW 信封能拆一层 JSON
  - 使用文档: 了解如何使用 amagi

    - **入门**
    - [快速开始](/amagi/docs/v7/usage): 抖音、B站、快手、小红书 Web 端相关数据接口的 Node.js 封装与服务
    - [快速上手](/amagi/docs/v7/usage/getting-started): 三步上手：创建客户端、获取数据、按 success 读取返回值
    - [安装](/amagi/docs/v7/usage/installation): 安装 @ikenxuan/amagi

    - **使用指南**
    - [SDK 使用指南](/amagi/docs/v7/usage/guide/sdk): 详细了解如何使用 amagi SDK
    - [响应类型](/amagi/docs/v7/usage/guide/type-mode): v7 的响应类型模型与三条逃生舱（typeMode 已移除）
    - [工具集](/amagi/docs/v7/usage/guide/utilities): amagi 提供的各平台工具函数

    - **高级**
    - [自定义请求](/amagi/docs/v7/usage/advanced/custom-request): 用 client.<平台>.request 请求 amagi 尚未收录的接口，含双轨语义、amagi 子对象、反爬参数精调，以及 apiUrls 的返回形态
    - [事件系统](/amagi/docs/v7/usage/advanced/events): 实例级事件总线的 15 个事件、带 meta 的负载，以及 v6 全局单例的去处
    - [HTTP 服务](/amagi/docs/v7/usage/advanced/http-server): 使用 amagi 启动本地 HTTP 服务

    - **SDK 方法**
    - [B站 SDK 方法](/amagi/docs/v7/usage/api/sdk/bilibili): B站平台的 27 个 SDK 方法，由端点注册表派生
    - [抖音 SDK 方法](/amagi/docs/v7/usage/api/sdk/douyin): 抖音平台的 26 个 SDK 方法，由端点注册表派生
    - [快手 SDK 方法](/amagi/docs/v7/usage/api/sdk/kuaishou): 快手平台的 14 个 SDK 方法，由端点注册表派生
    - [小红书 SDK 方法](/amagi/docs/v7/usage/api/sdk/xiaohongshu): 小红书平台的 13 个 SDK 方法，由端点注册表派生

    - **HTTP 端点**
    - HTTP 端点参考
      - [HTTP 端点参考](/amagi/docs/v7/usage/api/http): 80 个 HTTP 端点，由端点注册表派生的 OpenAPI 规范生成
      - 抖音: 抖音
        - [聚合解析作品数据（自动识别类型）](/amagi/docs/v7/usage/api/http/douyin/parseWork): 同一个作品 ID 可能是视频、图集、合辑、文字或文章，这条自动识别形态并返回对应结构。
        - [视频作品详细信息](/amagi/docs/v7/usage/api/http/douyin/videoWork): 已知是视频作品时用这条；形态不确定时先用 `parseWork` 自动识别。
        - [图集作品详细信息](/amagi/docs/v7/usage/api/http/douyin/imageAlbumWork): 已知是图集作品时用这条；形态不确定时先用 `parseWork` 自动识别。
        - [合辑作品详细信息](/amagi/docs/v7/usage/api/http/douyin/slidesWork): 已知是合辑（幻灯片/图文）时用这条；形态不确定时先用 `parseWork`。
        - [文字作品详细信息](/amagi/docs/v7/usage/api/http/douyin/textWork): 已知是文字作品时用这条；形态不确定时先用 `parseWork` 自动识别。
        - [作品评论列表](/amagi/docs/v7/usage/api/http/douyin/comments): 作品的一级评论列表；某条评论下的回复用 `commentReplies`。
        - [指定评论的回复列表](/amagi/docs/v7/usage/api/http/douyin/commentReplies): 某条根评论下的回复列表，单页仅 3 条；整个评论区用 `comments`。
        - [用户主页信息](/amagi/docs/v7/usage/api/http/douyin/userProfile): 只认 `sec_uid`；手里只有抖音号时先用 `guestUserInfo` 换。
        - [用户主页作品列表](/amagi/docs/v7/usage/api/http/douyin/userVideoList): 该用户发布的作品列表；喜欢列表用 `userFavoriteList`。
        - [用户主页点赞作品列表](/amagi/docs/v7/usage/api/http/douyin/userFavoriteList): 该用户点赞过的作品列表；其发布的作品用 `userVideoList`。
        - [用户主页推荐作品列表](/amagi/docs/v7/usage/api/http/douyin/userRecommendList): 主页的推荐流作品，不保证是该用户发布的；自己的作品用 `userVideoList`。
        - [搜索结果列表（综合/用户/视频）](/amagi/docs/v7/usage/api/http/douyin/search): 搜索结果的形态由 `type` 决定；响应里 `__search_type` 标出实际形态。
        - [搜索联想词与热点词列表](/amagi/docs/v7/usage/api/http/douyin/suggestWords): 按输入前缀返回候选词与热点词；不返回搜索结果，搜索用 `search`。
        - [分享链接转短链接](/amagi/docs/v7/usage/api/http/douyin/shortUrl): 把抖音作品分享链接转换成 `v.douyin.com` 短链；`belong=aweme` 是能缩短的前提。
        - [音乐作品信息](/amagi/docs/v7/usage/api/http/douyin/musicInfo): 带 mp3 播放地址与使用量的音乐详情，个别原声不回播放地址时用 `musicAwemeList`；免鉴权版本用 `guestMusicInfo`。
        - [某条原声下的作品列表](/amagi/docs/v7/usage/api/http/douyin/musicAwemeList): 某条原声下的作品列表，只取一页；每条作品的 `music` 带 mp3 播放地址，`musicInfo` 没有时从这里取。
        - [合集作品列表](/amagi/docs/v7/usage/api/http/douyin/mixAweme): 按 mix_id 获取合集内的作品；mix_id 取自作品详情 mix_info.mix_id，number 为目标条数。
        - [直播间信息](/amagi/docs/v7/usage/api/http/douyin/liveRoomInfo): 按直播间短号返回开播状态、标题与主播信息。
        - [登录二维码](/amagi/docs/v7/usage/api/http/douyin/loginQrcode): 创建登录二维码，返回二维码内容与票据；扫码后的登录状态不在这条。
        - [表情列表](/amagi/docs/v7/usage/api/http/douyin/emojiList): 返回常规与限时/联名表情的清单；动态表情用 `dynamicEmojiList`。
        - [动态表情列表](/amagi/docs/v7/usage/api/http/douyin/dynamicEmojiList): 返回动态表情资源；常规表情列表用 `emojiList`。
        - [作品弹幕列表](/amagi/docs/v7/usage/api/http/douyin/danmakuList): 取作品在给定时间区间内的弹幕；不给区间即全片，返回按时间排序。
        - [抖音号转用户信息（免鉴权）](/amagi/docs/v7/usage/api/http/douyin/guestUserInfo): 用抖音号精确换 `sec_uid`；抖音号不存在时返回失败。
        - [原声本体（免鉴权）](/amagi/docs/v7/usage/api/http/douyin/guestMusicInfo): 按原声 ID 返回原声详情；这条没有 mp3 播放地址，需要时用 `musicInfo`。
        - [某条原声下的作品列表（免鉴权）](/amagi/docs/v7/usage/api/http/douyin/guestMusicAwemeList): 某条原声下的作品列表，只取一页；只有 `aweme_id` 可用，详情走 `parseWork`。
        - [表情资源包元信息（免鉴权）](/amagi/docs/v7/usage/api/http/douyin/emojiResourceMeta): 返回表情资源包的版本与下载地址；下载与解包由调用方处理。
      - B站: B站
        - [视频作品详细信息](/amagi/docs/v7/usage/api/http/bilibili/videoInfo): 取稿件详情（标题、封面、UP 主、统计、分 P 列表）；返回的 `cid` 供取流与弹幕使用。
        - [视频下载流信息](/amagi/docs/v7/usage/api/http/bilibili/videoStream): 取稿件的播放与下载流地址；高清档位需要带登录凭证，`cid` 来自 `videoInfo`。
        - [视频实时弹幕列表](/amagi/docs/v7/usage/api/http/bilibili/videoDanmaku): 取视频某一段的实时弹幕；每段 6 分钟，按 `segment_index` 分段取全量。
        - [作品评论列表](/amagi/docs/v7/usage/api/http/bilibili/comments): 取作品评论列表，按 `number` 自动翻页并去重；楼中楼用 `commentReplies`。
        - [指定评论的回复列表](/amagi/docs/v7/usage/api/http/bilibili/commentReplies): 取单条根评论下的楼中楼回复；整个评论区的列表用 `comments`。
        - [用户名片信息](/amagi/docs/v7/usage/api/http/bilibili/userCard): 取用户名片（昵称、头像、个性签名、等级、认证）与粉丝、投稿数统计。
        - [用户空间动态列表](/amagi/docs/v7/usage/api/http/bilibili/userDynamicList): 取用户空间的第一页动态列表；本接口不支持翻页。
        - [用户直播状态与直播间基础信息](/amagi/docs/v7/usage/api/http/bilibili/userLiveStatus): 按 UID 查用户的直播状态与直播间信息；已有房间号时用 `liveRoomInfo`。
        - [用户空间详细信息](/amagi/docs/v7/usage/api/http/bilibili/userSpaceInfo): 取用户空间完整资料（等级、硬币、VIP、粉丝勋章等）；名片类信息用 `userCard`。
        - [UP 主总播放量](/amagi/docs/v7/usage/api/http/bilibili/uploaderTotalViews): 取 UP 主的播放与获赞统计；等级、VIP 等完整资料用 `userSpaceInfo`。
        - [动态详情](/amagi/docs/v7/usage/api/http/bilibili/dynamicDetail): 按动态 ID 取详情，返回结构随动态类型（图文 / 转发 / 视频等）而变。
        - [番剧基本信息](/amagi/docs/v7/usage/api/http/bilibili/bangumiInfo): 取番剧季度或单集的基本信息；两个 ID 至少传一个，都传时以 `ep_id` 为准。
        - [番剧下载流信息](/amagi/docs/v7/usage/api/http/bilibili/bangumiStream): 取番剧剧集的播放与下载流地址；高清档位需要带登录凭证。
        - [直播间信息](/amagi/docs/v7/usage/api/http/bilibili/liveRoomInfo): 取直播间的展示信息（标题、封面、分区等）；房间标识与开播状态用 `liveRoomInit`。
        - [直播间初始化信息](/amagi/docs/v7/usage/api/http/bilibili/liveRoomInit): 取房间的标识与开播状态；标题、封面等展示信息用 `liveRoomInfo`。
        - [专栏正文内容](/amagi/docs/v7/usage/api/http/bilibili/articleContent): 取专栏正文；标题、作者、阅读统计等元信息用 `articleInfo`。
        - [专栏显示卡片信息](/amagi/docs/v7/usage/api/http/bilibili/articleCards): 一次可批量查询多条，支持视频、专栏、直播间的 ID 混传，结果按 ID 分组返回。
        - [专栏文章基本信息](/amagi/docs/v7/usage/api/http/bilibili/articleInfo): 取文章页元信息（标题、头图、作者、阅读/点赞）；正文用 `articleContent`。
        - [文集基本信息](/amagi/docs/v7/usage/api/http/bilibili/articleListInfo): 取文集（`rlid`）本体与其中的文章清单；单篇专栏用 `articleInfo`。
        - [登录基本信息](/amagi/docs/v7/usage/api/http/bilibili/loginStatus): 取当前账号的登录信息，可用来判断登录凭证是否还有效。
        - [登录二维码](/amagi/docs/v7/usage/api/http/bilibili/loginQrcode): 扫码登录第一步：返回二维码内容与轮询凭据 `qrcode_key`。
        - [二维码扫码状态](/amagi/docs/v7/usage/api/http/bilibili/qrcodeStatus): 轮询扫码进度；登录成功时新登录态只在响应头，本接口不透出响应头。
        - [由 v_voucher 申请的验证码信息](/amagi/docs/v7/usage/api/http/bilibili/captchaFromVoucher): 人机校验第一步：用 `v_voucher` 换取验证码与校验参数。
        - [验证码校验结果](/amagi/docs/v7/usage/api/http/bilibili/validateCaptcha): 人机校验第二步：提交 `challenge` / `token` 与用户过完验证的结果。
        - [AV 号转换得到的 BV 号](/amagi/docs/v7/usage/api/http/bilibili/avToBv): 把稿件 AV 号换算成 BV 号，本地计算不发请求，返回 `{ bvid }`。
        - [BV 号转换得到的 AV 号](/amagi/docs/v7/usage/api/http/bilibili/bvToAv): 把稿件 BV 号换算成 AV 号，本地计算不发请求，返回 `{ aid }`。
        - [表情列表](/amagi/docs/v7/usage/api/http/bilibili/emojiList): 取评论区表情面板里的全部表情，无参数。
      - 快手: 快手
        - [单个作品详细信息](/amagi/docs/v7/usage/api/http/kuaishou/videoWork): 取快手作品详情。要图集预渲染地址等完整版字段时用 `videoWorkFull`。
        - [单个作品详细信息（完整版，当前稳定撞风控）](/amagi/docs/v7/usage/api/http/kuaishou/videoWorkFull): 日常取作品信息请用 `videoWork`；这条是唯一可能返回图集预渲染地址与同类推荐的通道。
        - [作品评论列表](/amagi/docs/v7/usage/api/http/kuaishou/comments): 取作品评论列表，子评论按根评论 ID 分组返回。`number` 指定目标条数，翻页自动完成。
        - [评论回复列表](/amagi/docs/v7/usage/api/http/kuaishou/commentReplies): 取一条根评论下的回复。`rootCommentId` 取评论列表里 `hasSubComments` 为真的那条评论 ID。走 PC GraphQL，自带 PC 上下文 cookie 并对首发风控自动重试；有浏览器里的真实 `did` 时经 `cookies.kuaishou` 传入更稳。
        - [作品弹幕列表](/amagi/docs/v7/usage/api/http/kuaishou/danmakuList): 取作品弹幕列表。可按时间段取（`from` / `to`），不传时间段就取全量。
        - [用户主页聚合信息](/amagi/docs/v7/usage/api/http/kuaishou/userProfile): 取用户主页聚合信息（资料、作品列表、直播间等）。部分数据取不到时留空，不整体失败。
        - [用户公开作品列表](/amagi/docs/v7/usage/api/http/kuaishou/userWorkList): 取用户公开作品列表。`number` 指定目标条数，翻页由端点自动完成，不用传游标。
        - [直播间聚合信息](/amagi/docs/v7/usage/api/http/kuaishou/liveRoomInfo): 取直播间聚合信息（直播流、主播、公告等）；只看直播间时比 `userProfile` 轻。
        - [表情列表](/amagi/docs/v7/usage/api/http/kuaishou/emojiList): 取快手内置表情列表，无参数。
        - [表情包列表](/amagi/docs/v7/usage/api/http/kuaishou/emotionPackageList): 取快手表情包列表（含包元数据与包内每条表情），无参数。只要表情图标地址时用 `emojiList`。
        - [作品相关推荐](/amagi/docs/v7/usage/api/http/kuaishou/slideFeed): 取某个作品的相关推荐列表。`authorId` 传作者的数字 ID（`videoWork` 响应里的 `photo.userId`）。返回的列表混有推荐卡片，读作品字段前需先判别。
        - [搜索用户](/amagi/docs/v7/usage/api/http/kuaishou/searchUser): 按关键词搜索用户，自动翻页。需要浏览器注册后的 cookie，支持游客。
        - [搜索作品](/amagi/docs/v7/usage/api/http/kuaishou/searchWorkList): 按关键词搜索作品，自动翻页。需要浏览器注册后的 cookie，支持游客。
        - [当前登录账号资料](/amagi/docs/v7/usage/api/http/kuaishou/loginUserProfile): 取当前 cookie 所属账号的资料，不接参数。需要登录态 cookie。
      - 小红书: 小红书
        - [首页推荐笔记列表](/amagi/docs/v7/usage/api/http/xiaohongshu/homeFeed): 取首页推荐流笔记。翻页要手动：把上一页响应的 `cursor_score` 传回来。
        - [笔记详细信息](/amagi/docs/v7/usage/api/http/xiaohongshu/noteDetail): 取笔记正文与互动数据。要评论区用 `noteComments`。
        - [笔记评论列表](/amagi/docs/v7/usage/api/http/xiaohongshu/noteComments): 取笔记评论列表。`number` 指定目标条数，翻页由端点自动完成。**游客身份下平台对本接口限流较紧**：超限回 HTTP 461（伪装成成功的空壳），退避需分钟级、秒级无效；而且**不传 `number` 会触发翻页、多烧一次请求** —— 传具体小值可把请求数降到 1。
        - [用户主页信息](/amagi/docs/v7/usage/api/http/xiaohongshu/userProfile): 取用户主页的资料与统计。笔记列表见 `userNoteList`。
        - [用户笔记列表](/amagi/docs/v7/usage/api/http/xiaohongshu/userNoteList): 取用户的笔记列表。翻页要手动：`cursor` 传上一页最后一条的 ID。
        - [表情列表](/amagi/docs/v7/usage/api/http/xiaohongshu/emojiList): 取小红书表情列表，无参数。
        - [笔记搜索结果列表](/amagi/docs/v7/usage/api/http/xiaohongshu/searchNotes): 按关键词搜笔记。翻页手动传 `page`，并复用相同的 `search_id` / `session_id`；可指定排序和笔记类型。
        - [搜索用户结果列表](/amagi/docs/v7/usage/api/http/xiaohongshu/searchUser): 按关键词或小红书号搜用户，返回 user_id 等。翻页手动传 `page`。
        - [搜索热榜](/amagi/docs/v7/usage/api/http/xiaohongshu/searchHotList): 取小红书当前搜索热榜，无参数。
        - [子评论（楼中楼）列表](/amagi/docs/v7/usage/api/http/xiaohongshu/subComments): 展开某条一级评论下的回复。`number` 指定目标条数，翻页自动完成。
        - [直播间信息](/amagi/docs/v7/usage/api/http/xiaohongshu/liveRoom): 取指定直播间的当前信息。variant=h5 走 h5 接口，否则走 web；web 端请提供 request_user_id 或含 userId 的 Cookie。
        - [直播状态](/amagi/docs/v7/usage/api/http/xiaohongshu/liveStatus): 轮询指定直播间是否在播，返回体极小。
        - [直播广场](/amagi/docs/v7/usage/api/http/xiaohongshu/liveSquare): 取直播广场推荐列表，参数均可选。

    - **API 类型**
    - 类型参考
      - [类型索引](/amagi/docs/v7/usage/api/types): 481 个公开导出的总索引，按页面分组
      - [函数](/amagi/docs/v7/usage/api/types/functions): 60 个符号，由 scripts/api-extractor.ts 从 packages/core/src/index.ts 抽取
      - [类、枚举与变量](/amagi/docs/v7/usage/api/types/classes): 33 个符号，由 scripts/api-extractor.ts 从 packages/core/src/index.ts 抽取
      - [接口](/amagi/docs/v7/usage/api/types/interfaces): 71 个符号，由 scripts/api-extractor.ts 从 packages/core/src/index.ts 抽取
      - [核心类型](/amagi/docs/v7/usage/api/types/types): 24 个符号，由 scripts/api-extractor.ts 从 packages/core/src/index.ts 抽取
      - [B站响应类型](/amagi/docs/v7/usage/api/types/types-bilibili): 103 个符号，由 scripts/api-extractor.ts 从 packages/core/src/index.ts 抽取
      - [抖音响应类型](/amagi/docs/v7/usage/api/types/types-douyin): 102 个符号，由 scripts/api-extractor.ts 从 packages/core/src/index.ts 抽取
      - [快手 / 小红书 / 通用响应类型](/amagi/docs/v7/usage/api/types/types-rest): 88 个符号，由 scripts/api-extractor.ts 从 packages/core/src/index.ts 抽取

    - **迁移**
    - [从 v6 迁移](/amagi/docs/v7/usage/migration-v7): v6 → v7 的四处必改、一行切回 v6 语义的 /compat，以及完整迁移矩阵
- V6
  - AI 代理: 让 AI 助手更好地理解
    - [LLMs.txt](/amagi/docs/v6/ai/llms-txt): 让 AI 助手理解 Amagi 文档
  - 变更日志: 版本维度的变更记录
    - [变更日志](/amagi/docs/v6/changelog): amagi v6 各版本的行为变化
    - [v6.6.0](/amagi/docs/v6/changelog/6.6.0): 2026-09-01 发布的实验性抖音 Passport 扫码登录功能
    - [v6.5.0](/amagi/docs/v6/changelog/6.5.0): 2026-08-04 发布的重要变更
    - [v6.4.0](/amagi/docs/v6/changelog/6.4.0): 2026-07-30 发布的重要变更
    - [v6.3.0](/amagi/docs/v6/changelog/6.3.0): 2026-07-30 发布的重要变更
    - [v6.2.0](/amagi/docs/v6/changelog/6.2.0): 2025-06-30 发布的重要变更
    - [v6.1.3](/amagi/docs/v6/changelog/6.1.3): 2025-05-10 发布的重要变更
  - 开发者文档: 贡献者指南与项目架构
    - [开始开发](/amagi/docs/v6/dev): 贡献者快速入门
    - [项目架构](/amagi/docs/v6/dev/architecture): 了解 amagi 的项目结构和核心概念
    - [新增接口](/amagi/docs/v6/dev/add-api): 学习如何为平台新增数据接口
    - [贡献指南](/amagi/docs/v6/dev/contributing): 提交规范和 PR 流程
  - 使用文档: 了解如何使用 amagi

    - **入门**
    - [快速开始](/amagi/docs/v6/usage): 抖音、B站、快手、小红书 Web 端相关数据接口的 Node.js 封装与服务
    - [快速上手](/amagi/docs/v6/usage/getting-started): 快速开始使用 @ikenxuan/amagi
    - [安装](/amagi/docs/v6/usage/installation): 安装 @ikenxuan/amagi

    - **使用指南**
    - [SDK 使用指南](/amagi/docs/v6/usage/guide/sdk): 详细了解如何使用 amagi SDK
    - [HTTP 服务](/amagi/docs/v6/usage/guide/http-server): 使用 amagi 启动本地 HTTP 服务
    - [事件系统](/amagi/docs/v6/usage/guide/events): 使用 amagi 的事件驱动架构
    - [类型模式](/amagi/docs/v6/usage/guide/type-mode): 了解 amagi 的类型模式系统
    - [工具集](/amagi/docs/v6/usage/guide/utilities): amagi 提供的各平台工具函数

    - **API 参考**
    - [B站 API](/amagi/docs/v6/usage/api/bilibili): B站平台 API 参考文档
    - [抖音 API](/amagi/docs/v6/usage/api/douyin): 抖音平台 API 参考文档
    - [快手 API](/amagi/docs/v6/usage/api/kuaishou): 快手平台 API 参考文档
    - [小红书 API](/amagi/docs/v6/usage/api/xiaohongshu): 小红书平台 API 参考文档

    - **迁移**
    - [v6 迁移指南](/amagi/docs/v6/usage/migration-v6): 从 v5.x 升级到 v6.x 的迁移指南

## 完整文档

访问 https://ikenxuan.github.io/amagi/llms-full.txt 获取所有文档的完整内容。

## 单个页面

在任何文档页面 URL 后添加 .mdx 即可获取该页面的 Markdown 内容。

- https://ikenxuan.github.io/amagi/docs/v7/usage/getting-started.mdx
- https://ikenxuan.github.io/amagi/docs/v7/usage/api/sdk/bilibili.mdx

## 链接

- GitHub: https://github.com/ikenxuan/amagi
- 文档站点: https://ikenxuan.github.io/amagi
- MCP Server: https://ikenxuan.github.io/amagi/api/mcp