api-config.json 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. {
  2. "name": "xiaohongshu-search-notes",
  3. "displayName": "小红书搜索笔记",
  4. "description": "按关键词在小红书搜索笔记,获取相关笔记列表(图文/视频)、作者、互动数据(点赞/评论/收藏)。适用于品类种草内容发现、竞品笔记监控、VOC素材采集、爆款选题挖掘。",
  5. "category": "xiaohongshu",
  6. "version": "1.0.0",
  7. "endpoint": {
  8. "method": "GET",
  9. "url": "https://server.fmode.cn/thapi/v1/xiaohongshu/app/search_notes",
  10. "headers": {
  11. "Authorization": "Bearer gqsZHfMWgAiMwV+ITbmZy0qALADWBZVS7QnV7kKJe9CwzgWgJG+7bwK+GQ==",
  12. "Accept": "application/json"
  13. }
  14. },
  15. "parameters": {
  16. "type": "object",
  17. "required": [
  18. "keyword",
  19. "page"
  20. ],
  21. "properties": {
  22. "keyword": {
  23. "type": "string",
  24. "description": "搜索关键词,支持品类词/品牌词/人群词,如 '乳酸菌素片'、'护肝片'、'猴菇饮'、'儿童益生菌'"
  25. },
  26. "page": {
  27. "type": "integer",
  28. "description": "页码,首页传 1,下一页递增。每页固定返回 20 条笔记",
  29. "default": 1,
  30. "minimum": 1
  31. },
  32. "sort": {
  33. "type": "string",
  34. "description": "排序方式:'general'=综合排序(默认,平衡);'time_descending'=最新发布(时效优先);'popularity_descending'=最热门(爆款优先)",
  35. "enum": [
  36. "general",
  37. "time_descending",
  38. "popularity_descending"
  39. ],
  40. "default": "general"
  41. },
  42. "note_type": {
  43. "type": "string",
  44. "description": "笔记类型筛选:'_0'=不限;'_1'=视频笔记;'_2'=图文笔记",
  45. "enum": [
  46. "_0",
  47. "_1",
  48. "_2"
  49. ],
  50. "default": "_0"
  51. }
  52. }
  53. },
  54. "requestTransform": {
  55. "query": {
  56. "keyword": "{{keyword}}",
  57. "page": "{{page}}",
  58. "sort": "{{sort}}",
  59. "note_type": "{{note_type}}"
  60. }
  61. },
  62. "response": {
  63. "type": "object",
  64. "description": "搜索结果(双层包装:data.data 是真正数据),含 20 条笔记列表",
  65. "note": "社媒数据网关响应是双层 data:顶层 data 是 HTTP 包装层,data.data 才是业务数据。items[] 每项是 {model_type, note} 包装,真正的笔记字段在 items[].note 里。",
  66. "keyFields": {
  67. "data.code": "HTTP 状态码(外层)",
  68. "data.data.code": "业务状态码(0=成功)",
  69. "data.data.msg": "业务消息('成功' 等)",
  70. "data.data.success": "布尔成功标志",
  71. "data.data.searchId": "搜索会话 ID(翻页时保留)",
  72. "data.data.sessionId": "会话 ID",
  73. "data.data.items[]": "笔记包装列表(20 条/页),每项结构 {model_type:'note', note:{...}}",
  74. "data.data.items[].note.id": "笔记唯一 ID(24 位十六进制),传入 xiaohongshu-note-detail 和 xiaohongshu-note-comments 的 note_id 参数",
  75. "data.data.items[].note.type": "笔记类型:normal=图文、video=视频",
  76. "data.data.items[].note.title": "笔记标题",
  77. "data.data.items[].note.desc": "笔记正文摘要",
  78. "data.data.items[].note.timestamp": "发布时间戳(秒)",
  79. "data.data.items[].note.last_update_time": "最后编辑时间戳",
  80. "data.data.items[].note.xsec_token": "笔记访问令牌(访问详情/评论时可能需要)",
  81. "data.data.items[].note.user.userid": "作者 ID(24 位十六进制),传入 xiaohongshu-user-info 的 user_id 参数",
  82. "data.data.items[].note.user.nickname": "作者昵称",
  83. "data.data.items[].note.user.red_id": "作者小红书号(可读 ID)",
  84. "data.data.items[].note.user.red_official_verified": "是否官方认证",
  85. "data.data.items[].note.user.images": "作者头像 URL",
  86. "data.data.items[].note.liked_count": "点赞数(扁平字段,不在 interact_info 里,爆款指标)",
  87. "data.data.items[].note.comments_count": "评论数(字段带 s,注意复数),可用 xiaohongshu-note-comments 获取详情",
  88. "data.data.items[].note.collected_count": "收藏数(深度认可指标)",
  89. "data.data.items[].note.shared_count": "分享数(传播力指标)",
  90. "data.data.items[].note.nice_count": "踩/nice 数",
  91. "data.data.items[].note.images_list[].url": "封面图/图文笔记的图片 URL 列表",
  92. "data.data.items[].note.tag_info": "话题标签信息"
  93. }
  94. },
  95. "workflow": {
  96. "description": "推荐调用链",
  97. "steps": [
  98. "1. xiaohongshu-search-notes(keyword) → 获取相关笔记列表(每页 20 条)",
  99. "2. xiaohongshu-note-detail(note_id) → 获取单笔记完整数据(完整正文/图片)",
  100. "3. xiaohongshu-note-comments(note_id) → 获取该笔记评论",
  101. "4. xiaohongshu-user-info(user_id) → 获取作者画像(KOL/KOC 筛选)"
  102. ]
  103. },
  104. "usageExamples": [
  105. {
  106. "name": "品类种草内容发现",
  107. "input": {
  108. "keyword": "乳酸菌素片",
  109. "page": 1,
  110. "sort": "popularity_descending",
  111. "note_type": "_0"
  112. },
  113. "description": "搜索乳酸菌素片最热门的种草笔记,发现爆款内容规律和用户表达方式"
  114. },
  115. {
  116. "name": "最新竞品笔记监控",
  117. "input": {
  118. "keyword": "合生元益生菌",
  119. "page": 1,
  120. "sort": "time_descending"
  121. },
  122. "description": "搜索竞品品牌最新发布的笔记,监控其内容策略动向"
  123. },
  124. {
  125. "name": "用户痛点 VOC 素材采集",
  126. "input": {
  127. "keyword": "护肝片 踩雷",
  128. "page": 1,
  129. "sort": "general"
  130. },
  131. "description": "搜索用户发布的踩雷/避雷内容,结合 xiaohongshu-note-comments 提取真实痛点"
  132. },
  133. {
  134. "name": "视频内容趋势研究",
  135. "input": {
  136. "keyword": "养胃",
  137. "page": 1,
  138. "sort": "time_descending",
  139. "note_type": "_1"
  140. },
  141. "description": "筛选最新发布的养胃相关视频笔记,辅助新品上市内容策略规划"
  142. }
  143. ],
  144. "reportMapping": {
  145. "slides": [
  146. "小红书品类种草分析",
  147. "小红书竞品内容监控",
  148. "小红书用户 VOC 采集"
  149. ],
  150. "dataPoints": [
  151. "品类种草笔记列表",
  152. "笔记互动率(点赞/评论/收藏比)",
  153. "爆款标题/封面模式",
  154. "活跃 KOL/KOC 账号发现",
  155. "用户真实表达方式与痛点关键词(结合评论分析)"
  156. ]
  157. },
  158. "timeout": 60000,
  159. "retry": {
  160. "maxAttempts": 3,
  161. "delay": 2000,
  162. "backoffMultiplier": 2,
  163. "retryOn": [400, 429, 500, 502, 503, 504]
  164. },
  165. "notes": "本 skill 使用共享社媒数据订阅(/thapi/ 网关),不经过 APIG 计费。社媒网关偶发 400 瞬时错误,已启用 3 次重试。中文关键词会在请求时自动 URL-encode。"
  166. }