@tikomni/skills 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (480) hide show
  1. package/.skill-package-allowlist.txt +1 -3
  2. package/README.md +41 -49
  3. package/README.zh-CN.md +43 -51
  4. package/bin/tikomni-skills.js +2 -2
  5. package/env.example +37 -56
  6. package/package.json +7 -3
  7. package/skills/social-media-crawl/SKILL.md +53 -0
  8. package/skills/social-media-crawl/agents/openai.yaml +5 -0
  9. package/skills/social-media-crawl/references/contracts/output-envelope.md +22 -0
  10. package/skills/social-media-crawl/references/contracts/work-fact-card-fields.md +48 -0
  11. package/skills/social-media-crawl/references/guides/generic-mcp-objects.md +30 -0
  12. package/skills/social-media-crawl/references/mcp-usage-contract.md +30 -0
  13. package/skills/social-media-crawl/references/pipelines/douyin-creator-home.md +7 -0
  14. package/skills/social-media-crawl/references/pipelines/douyin-single-work.md +7 -0
  15. package/skills/social-media-crawl/references/pipelines/xiaohongshu-creator-home.md +7 -0
  16. package/skills/social-media-crawl/references/pipelines/xiaohongshu-single-work.md +7 -0
  17. package/skills/social-media-crawl/references/schemas/creator-profile.schema.json +33 -0
  18. package/skills/social-media-crawl/references/schemas/output-envelope.schema.json +41 -0
  19. package/skills/social-media-crawl/references/schemas/work-collection.schema.json +29 -0
  20. package/skills/social-media-crawl/references/schemas/work-fact-card.schema.json +67 -0
  21. package/skills/social-media-crawl/references/service-guides/u2-u3-mandatory-fallback.md +21 -0
  22. package/skills/social-media-crawl/scripts/__init__.py +2 -0
  23. package/skills/social-media-crawl/scripts/core/__init__.py +2 -0
  24. package/skills/{creator-analysis/scripts/pipeline/asr → social-media-crawl/scripts/core}/asr_pipeline.py +252 -9
  25. package/skills/social-media-crawl/scripts/core/completeness.py +83 -0
  26. package/skills/{single-work-analysis → social-media-crawl}/scripts/core/config_loader.py +108 -167
  27. package/skills/social-media-crawl/scripts/core/mcp_dispatch.py +145 -0
  28. package/skills/social-media-crawl/scripts/core/object_detection.py +63 -0
  29. package/skills/{creator-analysis/scripts/pipeline/asr → social-media-crawl/scripts/core}/poll_u2_task.py +6 -2
  30. package/skills/{single-work-analysis → social-media-crawl}/scripts/core/progress_report.py +32 -0
  31. package/skills/social-media-crawl/scripts/core/storage_router.py +160 -0
  32. package/skills/{creator-analysis → social-media-crawl}/scripts/core/tikomni_common.py +13 -3
  33. package/skills/social-media-crawl/scripts/core/u3_fallback.py +328 -0
  34. package/skills/social-media-crawl/scripts/pipelines/__init__.py +2 -0
  35. package/skills/social-media-crawl/scripts/pipelines/douyin_creator_home_helpers.py +35 -0
  36. package/skills/social-media-crawl/scripts/pipelines/douyin_platform_adapter.py +7 -0
  37. package/skills/{creator-analysis/scripts/author_home/asr → social-media-crawl/scripts/pipelines}/home_asr.py +1 -1
  38. package/skills/{creator-analysis/scripts/author_home/adapters → social-media-crawl/scripts/pipelines}/platform_adapters.py +8 -2
  39. package/skills/social-media-crawl/scripts/pipelines/run_douyin_creator_home.py +237 -0
  40. package/skills/{single-work-analysis/scripts/platform/douyin/run_douyin_single_video.py → social-media-crawl/scripts/pipelines/run_douyin_single_work.py} +282 -174
  41. package/skills/social-media-crawl/scripts/pipelines/run_xiaohongshu_creator_home.py +237 -0
  42. package/skills/{single-work-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py → social-media-crawl/scripts/pipelines/run_xiaohongshu_single_work.py} +290 -141
  43. package/skills/{creator-analysis/scripts/author_home → social-media-crawl/scripts/pipelines}/schema.py +1 -1
  44. package/skills/social-media-crawl/scripts/pipelines/xiaohongshu_creator_home_helpers.py +35 -0
  45. package/skills/social-media-crawl/scripts/pipelines/xiaohongshu_platform_adapter.py +7 -0
  46. package/skills/social-media-crawl/scripts/writers/__init__.py +1 -0
  47. package/skills/social-media-crawl/scripts/writers/write_work_fact_card.py +391 -0
  48. package/skills/creator-analysis/SKILL.md +0 -95
  49. package/skills/creator-analysis/agents/openai.yaml +0 -4
  50. package/skills/creator-analysis/env.example +0 -36
  51. package/skills/creator-analysis/references/api-capability-index.md +0 -92
  52. package/skills/creator-analysis/references/api-contracts/asr-api.md +0 -130
  53. package/skills/creator-analysis/references/api-contracts/bilibili-app-api.md +0 -776
  54. package/skills/creator-analysis/references/api-contracts/bilibili-web-api.md +0 -2017
  55. package/skills/creator-analysis/references/api-contracts/demo-api.md +0 -717
  56. package/skills/creator-analysis/references/api-contracts/douyin-app-v3-api.md +0 -3594
  57. package/skills/creator-analysis/references/api-contracts/douyin-billboard-api.md +0 -2274
  58. package/skills/creator-analysis/references/api-contracts/douyin-creator-api.md +0 -1575
  59. package/skills/creator-analysis/references/api-contracts/douyin-creator-v2-api.md +0 -3254
  60. package/skills/creator-analysis/references/api-contracts/douyin-search-api.md +0 -4118
  61. package/skills/creator-analysis/references/api-contracts/douyin-web-api.md +0 -5544
  62. package/skills/creator-analysis/references/api-contracts/douyin-xingtu-api.md +0 -1916
  63. package/skills/creator-analysis/references/api-contracts/douyin-xingtu-v2-api.md +0 -1540
  64. package/skills/creator-analysis/references/api-contracts/health-check.md +0 -69
  65. package/skills/creator-analysis/references/api-contracts/hybrid-parsing.md +0 -78
  66. package/skills/creator-analysis/references/api-contracts/instagram-v1-api.md +0 -2256
  67. package/skills/creator-analysis/references/api-contracts/instagram-v2-api.md +0 -2011
  68. package/skills/creator-analysis/references/api-contracts/instagram-v3-api.md +0 -2630
  69. package/skills/creator-analysis/references/api-contracts/ios-shortcut.md +0 -44
  70. package/skills/creator-analysis/references/api-contracts/kuaishou-app-api.md +0 -1518
  71. package/skills/creator-analysis/references/api-contracts/kuaishou-web-api.md +0 -1242
  72. package/skills/creator-analysis/references/api-contracts/lemon8-app-api.md +0 -1088
  73. package/skills/creator-analysis/references/api-contracts/linkedin-web-api.md +0 -1949
  74. package/skills/creator-analysis/references/api-contracts/media-ingest-api.md +0 -126
  75. package/skills/creator-analysis/references/api-contracts/pipixia-app-api.md +0 -1142
  76. package/skills/creator-analysis/references/api-contracts/reddit-app-api.md +0 -2025
  77. package/skills/creator-analysis/references/api-contracts/sora2-api.md +0 -2266
  78. package/skills/creator-analysis/references/api-contracts/temp-mail-api.md +0 -208
  79. package/skills/creator-analysis/references/api-contracts/threads-web-api.md +0 -897
  80. package/skills/creator-analysis/references/api-contracts/tikhub-downloader-api.md +0 -134
  81. package/skills/creator-analysis/references/api-contracts/tikhub-user-api.md +0 -494
  82. package/skills/creator-analysis/references/api-contracts/tiktok-ads-api.md +0 -5947
  83. package/skills/creator-analysis/references/api-contracts/tiktok-analytics-api.md +0 -968
  84. package/skills/creator-analysis/references/api-contracts/tiktok-app-v3-api.md +0 -5735
  85. package/skills/creator-analysis/references/api-contracts/tiktok-creator-api.md +0 -1951
  86. package/skills/creator-analysis/references/api-contracts/tiktok-interaction-api.md +0 -742
  87. package/skills/creator-analysis/references/api-contracts/tiktok-shop-web-api.md +0 -1890
  88. package/skills/creator-analysis/references/api-contracts/tiktok-web-api.md +0 -4448
  89. package/skills/creator-analysis/references/api-contracts/toutiao-app-api.md +0 -342
  90. package/skills/creator-analysis/references/api-contracts/toutiao-web-api.md +0 -143
  91. package/skills/creator-analysis/references/api-contracts/twitter-web-api.md +0 -989
  92. package/skills/creator-analysis/references/api-contracts/wechat-channels-api.md +0 -809
  93. package/skills/creator-analysis/references/api-contracts/wechat-media-platform-web-api.md +0 -677
  94. package/skills/creator-analysis/references/api-contracts/weibo-app-api.md +0 -1547
  95. package/skills/creator-analysis/references/api-contracts/weibo-web-api.md +0 -798
  96. package/skills/creator-analysis/references/api-contracts/weibo-web-v2-api.md +0 -2459
  97. package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-api.md +0 -1291
  98. package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +0 -1683
  99. package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-api.md +0 -1324
  100. package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +0 -1209
  101. package/skills/creator-analysis/references/api-contracts/xigua-app-v2-api.md +0 -489
  102. package/skills/creator-analysis/references/api-contracts/youtube-web-api.md +0 -2636
  103. package/skills/creator-analysis/references/api-contracts/youtube-web-v2-api.md +0 -2660
  104. package/skills/creator-analysis/references/api-contracts/zhihu-web-api.md +0 -2315
  105. package/skills/creator-analysis/references/api-tags/asr-api.md +0 -100
  106. package/skills/creator-analysis/references/api-tags/bilibili-app-api.md +0 -482
  107. package/skills/creator-analysis/references/api-tags/bilibili-web-api.md +0 -1267
  108. package/skills/creator-analysis/references/api-tags/demo-api.md +0 -365
  109. package/skills/creator-analysis/references/api-tags/douyin-app-v3-api.md +0 -2012
  110. package/skills/creator-analysis/references/api-tags/douyin-billboard-api.md +0 -1428
  111. package/skills/creator-analysis/references/api-tags/douyin-creator-api.md +0 -694
  112. package/skills/creator-analysis/references/api-tags/douyin-creator-v2-api.md +0 -694
  113. package/skills/creator-analysis/references/api-tags/douyin-search-api.md +0 -1059
  114. package/skills/creator-analysis/references/api-tags/douyin-web-api.md +0 -3314
  115. package/skills/creator-analysis/references/api-tags/douyin-xingtu-api.md +0 -935
  116. package/skills/creator-analysis/references/api-tags/douyin-xingtu-v2-api.md +0 -925
  117. package/skills/creator-analysis/references/api-tags/health-check.md +0 -40
  118. package/skills/creator-analysis/references/api-tags/hybrid-parsing.md +0 -57
  119. package/skills/creator-analysis/references/api-tags/instagram-v1-api.md +0 -1224
  120. package/skills/creator-analysis/references/api-tags/instagram-v2-api.md +0 -1147
  121. package/skills/creator-analysis/references/api-tags/instagram-v3-api.md +0 -1123
  122. package/skills/creator-analysis/references/api-tags/ios-shortcut.md +0 -45
  123. package/skills/creator-analysis/references/api-tags/kuaishou-app-api.md +0 -846
  124. package/skills/creator-analysis/references/api-tags/kuaishou-web-api.md +0 -551
  125. package/skills/creator-analysis/references/api-tags/lemon8-app-api.md +0 -687
  126. package/skills/creator-analysis/references/api-tags/linkedin-web-api.md +0 -1105
  127. package/skills/creator-analysis/references/api-tags/media-ingest-api.md +0 -112
  128. package/skills/creator-analysis/references/api-tags/pipixia-app-api.md +0 -721
  129. package/skills/creator-analysis/references/api-tags/reddit-app-api.md +0 -1057
  130. package/skills/creator-analysis/references/api-tags/sora2-api.md +0 -737
  131. package/skills/creator-analysis/references/api-tags/temp-mail-api.md +0 -136
  132. package/skills/creator-analysis/references/api-tags/threads-web-api.md +0 -472
  133. package/skills/creator-analysis/references/api-tags/tikhub-downloader-api.md +0 -65
  134. package/skills/creator-analysis/references/api-tags/tikhub-user-api.md +0 -253
  135. package/skills/creator-analysis/references/api-tags/tiktok-ads-api.md +0 -1393
  136. package/skills/creator-analysis/references/api-tags/tiktok-analytics-api.md +0 -179
  137. package/skills/creator-analysis/references/api-tags/tiktok-app-v3-api.md +0 -3264
  138. package/skills/creator-analysis/references/api-tags/tiktok-creator-api.md +0 -709
  139. package/skills/creator-analysis/references/api-tags/tiktok-interaction-api.md +0 -366
  140. package/skills/creator-analysis/references/api-tags/tiktok-shop-web-api.md +0 -663
  141. package/skills/creator-analysis/references/api-tags/tiktok-web-api.md +0 -2516
  142. package/skills/creator-analysis/references/api-tags/toutiao-app-api.md +0 -220
  143. package/skills/creator-analysis/references/api-tags/toutiao-web-api.md +0 -96
  144. package/skills/creator-analysis/references/api-tags/twitter-web-api.md +0 -562
  145. package/skills/creator-analysis/references/api-tags/wechat-channels-api.md +0 -405
  146. package/skills/creator-analysis/references/api-tags/wechat-media-platform-web-api.md +0 -431
  147. package/skills/creator-analysis/references/api-tags/weibo-app-api.md +0 -851
  148. package/skills/creator-analysis/references/api-tags/weibo-web-api.md +0 -470
  149. package/skills/creator-analysis/references/api-tags/weibo-web-v2-api.md +0 -1405
  150. package/skills/creator-analysis/references/api-tags/xiaohongshu-app-api.md +0 -534
  151. package/skills/creator-analysis/references/api-tags/xiaohongshu-app-v2-api.md +0 -934
  152. package/skills/creator-analysis/references/api-tags/xiaohongshu-web-api.md +0 -757
  153. package/skills/creator-analysis/references/api-tags/xiaohongshu-web-v2-api.md +0 -762
  154. package/skills/creator-analysis/references/api-tags/xigua-app-v2-api.md +0 -308
  155. package/skills/creator-analysis/references/api-tags/youtube-web-api.md +0 -934
  156. package/skills/creator-analysis/references/api-tags/youtube-web-v2-api.md +0 -717
  157. package/skills/creator-analysis/references/api-tags/zhihu-web-api.md +0 -1384
  158. package/skills/creator-analysis/references/asr-orchestration.md +0 -33
  159. package/skills/creator-analysis/references/config-templates/defaults.yaml +0 -60
  160. package/skills/creator-analysis/references/contracts/creator-card-fields.md +0 -25
  161. package/skills/creator-analysis/references/contracts/work-card-fields.md +0 -68
  162. package/skills/creator-analysis/references/platform-guides/douyin.md +0 -54
  163. package/skills/creator-analysis/references/platform-guides/generic.md +0 -50
  164. package/skills/creator-analysis/references/platform-guides/xiaohongshu.md +0 -69
  165. package/skills/creator-analysis/references/prompt-contracts/asr-clean.md +0 -28
  166. package/skills/creator-analysis/references/prompt-contracts/author-analysis-v2.md +0 -46
  167. package/skills/creator-analysis/references/prompt-contracts/author-analysis.md +0 -49
  168. package/skills/creator-analysis/references/prompt-contracts/cta.md +0 -24
  169. package/skills/creator-analysis/references/prompt-contracts/hook.md +0 -25
  170. package/skills/creator-analysis/references/prompt-contracts/insight.md +0 -47
  171. package/skills/creator-analysis/references/prompt-contracts/sampled-work-batch-explanations.md +0 -30
  172. package/skills/creator-analysis/references/prompt-contracts/structure.md +0 -25
  173. package/skills/creator-analysis/references/prompt-contracts/style.md +0 -27
  174. package/skills/creator-analysis/references/prompt-contracts/summary.md +0 -29
  175. package/skills/creator-analysis/references/prompt-contracts/topic.md +0 -29
  176. package/skills/creator-analysis/references/schemas/author-analysis-input-v1.schema.json +0 -325
  177. package/skills/creator-analysis/references/schemas/author-analysis-v2.schema.json +0 -287
  178. package/skills/creator-analysis/references/schemas/sampled-work-batch-explanations.schema.json +0 -41
  179. package/skills/creator-analysis/references/service-guides/asr-u2-u3-fallback.md +0 -75
  180. package/skills/creator-analysis/references/workflow.md +0 -23
  181. package/skills/creator-analysis/scripts/__init__.py +0 -0
  182. package/skills/creator-analysis/scripts/author_home/__init__.py +0 -0
  183. package/skills/creator-analysis/scripts/author_home/adapters/__init__.py +0 -0
  184. package/skills/creator-analysis/scripts/author_home/analyzers/__init__.py +0 -0
  185. package/skills/creator-analysis/scripts/author_home/analyzers/author_analysis_v2_support.py +0 -1165
  186. package/skills/creator-analysis/scripts/author_home/analyzers/prompt_first_analyzers.py +0 -447
  187. package/skills/creator-analysis/scripts/author_home/analyzers/sampled_work_batch_explainer.py +0 -331
  188. package/skills/creator-analysis/scripts/author_home/asr/__init__.py +0 -5
  189. package/skills/creator-analysis/scripts/author_home/builders/__init__.py +0 -0
  190. package/skills/creator-analysis/scripts/author_home/builders/home_builders.py +0 -213
  191. package/skills/creator-analysis/scripts/author_home/collectors/__init__.py +0 -0
  192. package/skills/creator-analysis/scripts/author_home/orchestrator/__init__.py +0 -0
  193. package/skills/creator-analysis/scripts/author_home/orchestrator/run_author_analysis.py +0 -834
  194. package/skills/creator-analysis/scripts/author_home/orchestrator/work_analysis_artifacts.py +0 -609
  195. package/skills/creator-analysis/scripts/core/__init__.py +0 -0
  196. package/skills/creator-analysis/scripts/core/analysis_pipeline.py +0 -133
  197. package/skills/creator-analysis/scripts/core/config_loader.py +0 -418
  198. package/skills/creator-analysis/scripts/core/progress_report.py +0 -111
  199. package/skills/creator-analysis/scripts/core/storage_router.py +0 -256
  200. package/skills/creator-analysis/scripts/pipeline/__init__.py +0 -0
  201. package/skills/creator-analysis/scripts/pipeline/asr/__init__.py +0 -0
  202. package/skills/creator-analysis/scripts/platform/__init__.py +0 -0
  203. package/skills/creator-analysis/scripts/platform/douyin/__init__.py +0 -0
  204. package/skills/creator-analysis/scripts/platform/douyin/run_douyin_single_video.py +0 -1208
  205. package/skills/creator-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
  206. package/skills/creator-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +0 -2128
  207. package/skills/creator-analysis/scripts/writers/__init__.py +0 -0
  208. package/skills/creator-analysis/scripts/writers/write_author_homepage_samples.py +0 -107
  209. package/skills/creator-analysis/scripts/writers/write_benchmark_card.py +0 -1579
  210. package/skills/meta-capability/SKILL.md +0 -69
  211. package/skills/meta-capability/agents/openai.yaml +0 -4
  212. package/skills/meta-capability/env.example +0 -42
  213. package/skills/meta-capability/references/api-capability-index.md +0 -92
  214. package/skills/meta-capability/references/api-contracts/asr-api.md +0 -130
  215. package/skills/meta-capability/references/api-contracts/bilibili-app-api.md +0 -776
  216. package/skills/meta-capability/references/api-contracts/bilibili-web-api.md +0 -2017
  217. package/skills/meta-capability/references/api-contracts/demo-api.md +0 -717
  218. package/skills/meta-capability/references/api-contracts/douyin-app-v3-api.md +0 -3594
  219. package/skills/meta-capability/references/api-contracts/douyin-billboard-api.md +0 -2274
  220. package/skills/meta-capability/references/api-contracts/douyin-creator-api.md +0 -1575
  221. package/skills/meta-capability/references/api-contracts/douyin-creator-v2-api.md +0 -3254
  222. package/skills/meta-capability/references/api-contracts/douyin-search-api.md +0 -4118
  223. package/skills/meta-capability/references/api-contracts/douyin-web-api.md +0 -5544
  224. package/skills/meta-capability/references/api-contracts/douyin-xingtu-api.md +0 -1916
  225. package/skills/meta-capability/references/api-contracts/douyin-xingtu-v2-api.md +0 -1540
  226. package/skills/meta-capability/references/api-contracts/health-check.md +0 -69
  227. package/skills/meta-capability/references/api-contracts/hybrid-parsing.md +0 -78
  228. package/skills/meta-capability/references/api-contracts/instagram-v1-api.md +0 -2256
  229. package/skills/meta-capability/references/api-contracts/instagram-v2-api.md +0 -2011
  230. package/skills/meta-capability/references/api-contracts/instagram-v3-api.md +0 -2630
  231. package/skills/meta-capability/references/api-contracts/ios-shortcut.md +0 -44
  232. package/skills/meta-capability/references/api-contracts/kuaishou-app-api.md +0 -1518
  233. package/skills/meta-capability/references/api-contracts/kuaishou-web-api.md +0 -1242
  234. package/skills/meta-capability/references/api-contracts/lemon8-app-api.md +0 -1088
  235. package/skills/meta-capability/references/api-contracts/linkedin-web-api.md +0 -1949
  236. package/skills/meta-capability/references/api-contracts/media-ingest-api.md +0 -126
  237. package/skills/meta-capability/references/api-contracts/pipixia-app-api.md +0 -1142
  238. package/skills/meta-capability/references/api-contracts/reddit-app-api.md +0 -2025
  239. package/skills/meta-capability/references/api-contracts/sora2-api.md +0 -2266
  240. package/skills/meta-capability/references/api-contracts/temp-mail-api.md +0 -208
  241. package/skills/meta-capability/references/api-contracts/threads-web-api.md +0 -897
  242. package/skills/meta-capability/references/api-contracts/tikhub-downloader-api.md +0 -134
  243. package/skills/meta-capability/references/api-contracts/tikhub-user-api.md +0 -494
  244. package/skills/meta-capability/references/api-contracts/tiktok-ads-api.md +0 -5947
  245. package/skills/meta-capability/references/api-contracts/tiktok-analytics-api.md +0 -968
  246. package/skills/meta-capability/references/api-contracts/tiktok-app-v3-api.md +0 -5735
  247. package/skills/meta-capability/references/api-contracts/tiktok-creator-api.md +0 -1951
  248. package/skills/meta-capability/references/api-contracts/tiktok-interaction-api.md +0 -742
  249. package/skills/meta-capability/references/api-contracts/tiktok-shop-web-api.md +0 -1890
  250. package/skills/meta-capability/references/api-contracts/tiktok-web-api.md +0 -4448
  251. package/skills/meta-capability/references/api-contracts/toutiao-app-api.md +0 -342
  252. package/skills/meta-capability/references/api-contracts/toutiao-web-api.md +0 -143
  253. package/skills/meta-capability/references/api-contracts/twitter-web-api.md +0 -989
  254. package/skills/meta-capability/references/api-contracts/wechat-channels-api.md +0 -809
  255. package/skills/meta-capability/references/api-contracts/wechat-media-platform-web-api.md +0 -677
  256. package/skills/meta-capability/references/api-contracts/weibo-app-api.md +0 -1547
  257. package/skills/meta-capability/references/api-contracts/weibo-web-api.md +0 -798
  258. package/skills/meta-capability/references/api-contracts/weibo-web-v2-api.md +0 -2459
  259. package/skills/meta-capability/references/api-contracts/xiaohongshu-app-api.md +0 -1291
  260. package/skills/meta-capability/references/api-contracts/xiaohongshu-app-v2-api.md +0 -1683
  261. package/skills/meta-capability/references/api-contracts/xiaohongshu-web-api.md +0 -1324
  262. package/skills/meta-capability/references/api-contracts/xiaohongshu-web-v2-api.md +0 -1209
  263. package/skills/meta-capability/references/api-contracts/xigua-app-v2-api.md +0 -489
  264. package/skills/meta-capability/references/api-contracts/youtube-web-api.md +0 -2636
  265. package/skills/meta-capability/references/api-contracts/youtube-web-v2-api.md +0 -2660
  266. package/skills/meta-capability/references/api-contracts/zhihu-web-api.md +0 -2315
  267. package/skills/meta-capability/references/api-tags/asr-api.md +0 -100
  268. package/skills/meta-capability/references/api-tags/bilibili-app-api.md +0 -482
  269. package/skills/meta-capability/references/api-tags/bilibili-web-api.md +0 -1267
  270. package/skills/meta-capability/references/api-tags/demo-api.md +0 -365
  271. package/skills/meta-capability/references/api-tags/douyin-app-v3-api.md +0 -2012
  272. package/skills/meta-capability/references/api-tags/douyin-billboard-api.md +0 -1428
  273. package/skills/meta-capability/references/api-tags/douyin-creator-api.md +0 -694
  274. package/skills/meta-capability/references/api-tags/douyin-creator-v2-api.md +0 -694
  275. package/skills/meta-capability/references/api-tags/douyin-search-api.md +0 -1059
  276. package/skills/meta-capability/references/api-tags/douyin-web-api.md +0 -3314
  277. package/skills/meta-capability/references/api-tags/douyin-xingtu-api.md +0 -935
  278. package/skills/meta-capability/references/api-tags/douyin-xingtu-v2-api.md +0 -925
  279. package/skills/meta-capability/references/api-tags/health-check.md +0 -40
  280. package/skills/meta-capability/references/api-tags/hybrid-parsing.md +0 -57
  281. package/skills/meta-capability/references/api-tags/instagram-v1-api.md +0 -1224
  282. package/skills/meta-capability/references/api-tags/instagram-v2-api.md +0 -1147
  283. package/skills/meta-capability/references/api-tags/instagram-v3-api.md +0 -1123
  284. package/skills/meta-capability/references/api-tags/ios-shortcut.md +0 -45
  285. package/skills/meta-capability/references/api-tags/kuaishou-app-api.md +0 -846
  286. package/skills/meta-capability/references/api-tags/kuaishou-web-api.md +0 -551
  287. package/skills/meta-capability/references/api-tags/lemon8-app-api.md +0 -687
  288. package/skills/meta-capability/references/api-tags/linkedin-web-api.md +0 -1105
  289. package/skills/meta-capability/references/api-tags/media-ingest-api.md +0 -112
  290. package/skills/meta-capability/references/api-tags/pipixia-app-api.md +0 -721
  291. package/skills/meta-capability/references/api-tags/reddit-app-api.md +0 -1057
  292. package/skills/meta-capability/references/api-tags/sora2-api.md +0 -737
  293. package/skills/meta-capability/references/api-tags/temp-mail-api.md +0 -136
  294. package/skills/meta-capability/references/api-tags/threads-web-api.md +0 -472
  295. package/skills/meta-capability/references/api-tags/tikhub-downloader-api.md +0 -65
  296. package/skills/meta-capability/references/api-tags/tikhub-user-api.md +0 -253
  297. package/skills/meta-capability/references/api-tags/tiktok-ads-api.md +0 -1393
  298. package/skills/meta-capability/references/api-tags/tiktok-analytics-api.md +0 -179
  299. package/skills/meta-capability/references/api-tags/tiktok-app-v3-api.md +0 -3264
  300. package/skills/meta-capability/references/api-tags/tiktok-creator-api.md +0 -709
  301. package/skills/meta-capability/references/api-tags/tiktok-interaction-api.md +0 -366
  302. package/skills/meta-capability/references/api-tags/tiktok-shop-web-api.md +0 -663
  303. package/skills/meta-capability/references/api-tags/tiktok-web-api.md +0 -2516
  304. package/skills/meta-capability/references/api-tags/toutiao-app-api.md +0 -220
  305. package/skills/meta-capability/references/api-tags/toutiao-web-api.md +0 -96
  306. package/skills/meta-capability/references/api-tags/twitter-web-api.md +0 -562
  307. package/skills/meta-capability/references/api-tags/wechat-channels-api.md +0 -405
  308. package/skills/meta-capability/references/api-tags/wechat-media-platform-web-api.md +0 -431
  309. package/skills/meta-capability/references/api-tags/weibo-app-api.md +0 -851
  310. package/skills/meta-capability/references/api-tags/weibo-web-api.md +0 -470
  311. package/skills/meta-capability/references/api-tags/weibo-web-v2-api.md +0 -1405
  312. package/skills/meta-capability/references/api-tags/xiaohongshu-app-api.md +0 -534
  313. package/skills/meta-capability/references/api-tags/xiaohongshu-app-v2-api.md +0 -934
  314. package/skills/meta-capability/references/api-tags/xiaohongshu-web-api.md +0 -757
  315. package/skills/meta-capability/references/api-tags/xiaohongshu-web-v2-api.md +0 -762
  316. package/skills/meta-capability/references/api-tags/xigua-app-v2-api.md +0 -308
  317. package/skills/meta-capability/references/api-tags/youtube-web-api.md +0 -934
  318. package/skills/meta-capability/references/api-tags/youtube-web-v2-api.md +0 -717
  319. package/skills/meta-capability/references/api-tags/zhihu-web-api.md +0 -1384
  320. package/skills/meta-capability/references/config-templates/defaults.yaml +0 -18
  321. package/skills/meta-capability/references/dispatch.md +0 -27
  322. package/skills/meta-capability/references/execution-guidelines.md +0 -25
  323. package/skills/meta-capability/references/implemented-route-map.md +0 -177
  324. package/skills/meta-capability/references/service-guides/asr-u2-u3-fallback.md +0 -75
  325. package/skills/meta-capability/scripts/__init__.py +0 -1
  326. package/skills/meta-capability/scripts/call_route.py +0 -141
  327. package/skills/meta-capability/scripts/core/__init__.py +0 -1
  328. package/skills/meta-capability/scripts/core/bootstrap_env.py +0 -32
  329. package/skills/meta-capability/scripts/core/config_loader.py +0 -204
  330. package/skills/meta-capability/scripts/core/tikomni_common.py +0 -443
  331. package/skills/meta-capability/scripts/test_auth.py +0 -98
  332. package/skills/single-work-analysis/SKILL.md +0 -62
  333. package/skills/single-work-analysis/agents/openai.yaml +0 -4
  334. package/skills/single-work-analysis/env.example +0 -36
  335. package/skills/single-work-analysis/references/api-capability-index.md +0 -92
  336. package/skills/single-work-analysis/references/api-contracts/asr-api.md +0 -130
  337. package/skills/single-work-analysis/references/api-contracts/bilibili-app-api.md +0 -776
  338. package/skills/single-work-analysis/references/api-contracts/bilibili-web-api.md +0 -2017
  339. package/skills/single-work-analysis/references/api-contracts/demo-api.md +0 -717
  340. package/skills/single-work-analysis/references/api-contracts/douyin-app-v3-api.md +0 -3594
  341. package/skills/single-work-analysis/references/api-contracts/douyin-billboard-api.md +0 -2274
  342. package/skills/single-work-analysis/references/api-contracts/douyin-creator-api.md +0 -1575
  343. package/skills/single-work-analysis/references/api-contracts/douyin-creator-v2-api.md +0 -3254
  344. package/skills/single-work-analysis/references/api-contracts/douyin-search-api.md +0 -4118
  345. package/skills/single-work-analysis/references/api-contracts/douyin-web-api.md +0 -5544
  346. package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-api.md +0 -1916
  347. package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-v2-api.md +0 -1540
  348. package/skills/single-work-analysis/references/api-contracts/health-check.md +0 -69
  349. package/skills/single-work-analysis/references/api-contracts/hybrid-parsing.md +0 -78
  350. package/skills/single-work-analysis/references/api-contracts/instagram-v1-api.md +0 -2256
  351. package/skills/single-work-analysis/references/api-contracts/instagram-v2-api.md +0 -2011
  352. package/skills/single-work-analysis/references/api-contracts/instagram-v3-api.md +0 -2630
  353. package/skills/single-work-analysis/references/api-contracts/ios-shortcut.md +0 -44
  354. package/skills/single-work-analysis/references/api-contracts/kuaishou-app-api.md +0 -1518
  355. package/skills/single-work-analysis/references/api-contracts/kuaishou-web-api.md +0 -1242
  356. package/skills/single-work-analysis/references/api-contracts/lemon8-app-api.md +0 -1088
  357. package/skills/single-work-analysis/references/api-contracts/linkedin-web-api.md +0 -1949
  358. package/skills/single-work-analysis/references/api-contracts/media-ingest-api.md +0 -126
  359. package/skills/single-work-analysis/references/api-contracts/pipixia-app-api.md +0 -1142
  360. package/skills/single-work-analysis/references/api-contracts/reddit-app-api.md +0 -2025
  361. package/skills/single-work-analysis/references/api-contracts/sora2-api.md +0 -2266
  362. package/skills/single-work-analysis/references/api-contracts/temp-mail-api.md +0 -208
  363. package/skills/single-work-analysis/references/api-contracts/threads-web-api.md +0 -897
  364. package/skills/single-work-analysis/references/api-contracts/tikhub-downloader-api.md +0 -134
  365. package/skills/single-work-analysis/references/api-contracts/tikhub-user-api.md +0 -494
  366. package/skills/single-work-analysis/references/api-contracts/tiktok-ads-api.md +0 -5947
  367. package/skills/single-work-analysis/references/api-contracts/tiktok-analytics-api.md +0 -968
  368. package/skills/single-work-analysis/references/api-contracts/tiktok-app-v3-api.md +0 -5735
  369. package/skills/single-work-analysis/references/api-contracts/tiktok-creator-api.md +0 -1951
  370. package/skills/single-work-analysis/references/api-contracts/tiktok-interaction-api.md +0 -742
  371. package/skills/single-work-analysis/references/api-contracts/tiktok-shop-web-api.md +0 -1890
  372. package/skills/single-work-analysis/references/api-contracts/tiktok-web-api.md +0 -4448
  373. package/skills/single-work-analysis/references/api-contracts/toutiao-app-api.md +0 -342
  374. package/skills/single-work-analysis/references/api-contracts/toutiao-web-api.md +0 -143
  375. package/skills/single-work-analysis/references/api-contracts/twitter-web-api.md +0 -989
  376. package/skills/single-work-analysis/references/api-contracts/wechat-channels-api.md +0 -809
  377. package/skills/single-work-analysis/references/api-contracts/wechat-media-platform-web-api.md +0 -677
  378. package/skills/single-work-analysis/references/api-contracts/weibo-app-api.md +0 -1547
  379. package/skills/single-work-analysis/references/api-contracts/weibo-web-api.md +0 -798
  380. package/skills/single-work-analysis/references/api-contracts/weibo-web-v2-api.md +0 -2459
  381. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-api.md +0 -1291
  382. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +0 -1683
  383. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-api.md +0 -1324
  384. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +0 -1209
  385. package/skills/single-work-analysis/references/api-contracts/xigua-app-v2-api.md +0 -489
  386. package/skills/single-work-analysis/references/api-contracts/youtube-web-api.md +0 -2636
  387. package/skills/single-work-analysis/references/api-contracts/youtube-web-v2-api.md +0 -2660
  388. package/skills/single-work-analysis/references/api-contracts/zhihu-web-api.md +0 -2315
  389. package/skills/single-work-analysis/references/api-tags/asr-api.md +0 -100
  390. package/skills/single-work-analysis/references/api-tags/bilibili-app-api.md +0 -482
  391. package/skills/single-work-analysis/references/api-tags/bilibili-web-api.md +0 -1267
  392. package/skills/single-work-analysis/references/api-tags/demo-api.md +0 -365
  393. package/skills/single-work-analysis/references/api-tags/douyin-app-v3-api.md +0 -2012
  394. package/skills/single-work-analysis/references/api-tags/douyin-billboard-api.md +0 -1428
  395. package/skills/single-work-analysis/references/api-tags/douyin-creator-api.md +0 -694
  396. package/skills/single-work-analysis/references/api-tags/douyin-creator-v2-api.md +0 -694
  397. package/skills/single-work-analysis/references/api-tags/douyin-search-api.md +0 -1059
  398. package/skills/single-work-analysis/references/api-tags/douyin-web-api.md +0 -3314
  399. package/skills/single-work-analysis/references/api-tags/douyin-xingtu-api.md +0 -935
  400. package/skills/single-work-analysis/references/api-tags/douyin-xingtu-v2-api.md +0 -925
  401. package/skills/single-work-analysis/references/api-tags/health-check.md +0 -40
  402. package/skills/single-work-analysis/references/api-tags/hybrid-parsing.md +0 -57
  403. package/skills/single-work-analysis/references/api-tags/instagram-v1-api.md +0 -1224
  404. package/skills/single-work-analysis/references/api-tags/instagram-v2-api.md +0 -1147
  405. package/skills/single-work-analysis/references/api-tags/instagram-v3-api.md +0 -1123
  406. package/skills/single-work-analysis/references/api-tags/ios-shortcut.md +0 -45
  407. package/skills/single-work-analysis/references/api-tags/kuaishou-app-api.md +0 -846
  408. package/skills/single-work-analysis/references/api-tags/kuaishou-web-api.md +0 -551
  409. package/skills/single-work-analysis/references/api-tags/lemon8-app-api.md +0 -687
  410. package/skills/single-work-analysis/references/api-tags/linkedin-web-api.md +0 -1105
  411. package/skills/single-work-analysis/references/api-tags/media-ingest-api.md +0 -112
  412. package/skills/single-work-analysis/references/api-tags/pipixia-app-api.md +0 -721
  413. package/skills/single-work-analysis/references/api-tags/reddit-app-api.md +0 -1057
  414. package/skills/single-work-analysis/references/api-tags/sora2-api.md +0 -737
  415. package/skills/single-work-analysis/references/api-tags/temp-mail-api.md +0 -136
  416. package/skills/single-work-analysis/references/api-tags/threads-web-api.md +0 -472
  417. package/skills/single-work-analysis/references/api-tags/tikhub-downloader-api.md +0 -65
  418. package/skills/single-work-analysis/references/api-tags/tikhub-user-api.md +0 -253
  419. package/skills/single-work-analysis/references/api-tags/tiktok-ads-api.md +0 -1393
  420. package/skills/single-work-analysis/references/api-tags/tiktok-analytics-api.md +0 -179
  421. package/skills/single-work-analysis/references/api-tags/tiktok-app-v3-api.md +0 -3264
  422. package/skills/single-work-analysis/references/api-tags/tiktok-creator-api.md +0 -709
  423. package/skills/single-work-analysis/references/api-tags/tiktok-interaction-api.md +0 -366
  424. package/skills/single-work-analysis/references/api-tags/tiktok-shop-web-api.md +0 -663
  425. package/skills/single-work-analysis/references/api-tags/tiktok-web-api.md +0 -2516
  426. package/skills/single-work-analysis/references/api-tags/toutiao-app-api.md +0 -220
  427. package/skills/single-work-analysis/references/api-tags/toutiao-web-api.md +0 -96
  428. package/skills/single-work-analysis/references/api-tags/twitter-web-api.md +0 -562
  429. package/skills/single-work-analysis/references/api-tags/wechat-channels-api.md +0 -405
  430. package/skills/single-work-analysis/references/api-tags/wechat-media-platform-web-api.md +0 -431
  431. package/skills/single-work-analysis/references/api-tags/weibo-app-api.md +0 -851
  432. package/skills/single-work-analysis/references/api-tags/weibo-web-api.md +0 -470
  433. package/skills/single-work-analysis/references/api-tags/weibo-web-v2-api.md +0 -1405
  434. package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-api.md +0 -534
  435. package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-v2-api.md +0 -934
  436. package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-api.md +0 -757
  437. package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-v2-api.md +0 -762
  438. package/skills/single-work-analysis/references/api-tags/xigua-app-v2-api.md +0 -308
  439. package/skills/single-work-analysis/references/api-tags/youtube-web-api.md +0 -934
  440. package/skills/single-work-analysis/references/api-tags/youtube-web-v2-api.md +0 -717
  441. package/skills/single-work-analysis/references/api-tags/zhihu-web-api.md +0 -1384
  442. package/skills/single-work-analysis/references/asr-and-fallback.md +0 -20
  443. package/skills/single-work-analysis/references/config-templates/defaults.yaml +0 -58
  444. package/skills/single-work-analysis/references/contracts/work-card-fields.md +0 -41
  445. package/skills/single-work-analysis/references/platform-guides/douyin.md +0 -47
  446. package/skills/single-work-analysis/references/platform-guides/generic.md +0 -43
  447. package/skills/single-work-analysis/references/platform-guides/xiaohongshu.md +0 -54
  448. package/skills/single-work-analysis/references/prompt-contracts/asr-clean.md +0 -28
  449. package/skills/single-work-analysis/references/prompt-contracts/cta.md +0 -24
  450. package/skills/single-work-analysis/references/prompt-contracts/hook.md +0 -25
  451. package/skills/single-work-analysis/references/prompt-contracts/insight.md +0 -47
  452. package/skills/single-work-analysis/references/prompt-contracts/structure.md +0 -25
  453. package/skills/single-work-analysis/references/prompt-contracts/style.md +0 -27
  454. package/skills/single-work-analysis/references/prompt-contracts/summary.md +0 -29
  455. package/skills/single-work-analysis/references/prompt-contracts/topic.md +0 -29
  456. package/skills/single-work-analysis/references/schemas/work-card.schema.json +0 -39
  457. package/skills/single-work-analysis/references/service-guides/asr-u2-u3-fallback.md +0 -75
  458. package/skills/single-work-analysis/scripts/__init__.py +0 -0
  459. package/skills/single-work-analysis/scripts/core/__init__.py +0 -0
  460. package/skills/single-work-analysis/scripts/core/analysis_pipeline.py +0 -133
  461. package/skills/single-work-analysis/scripts/core/bootstrap_env.py +0 -35
  462. package/skills/single-work-analysis/scripts/core/extract_pipeline.py +0 -173
  463. package/skills/single-work-analysis/scripts/core/storage_router.py +0 -253
  464. package/skills/single-work-analysis/scripts/core/tikomni_common.py +0 -588
  465. package/skills/single-work-analysis/scripts/pipeline/__init__.py +0 -0
  466. package/skills/single-work-analysis/scripts/pipeline/asr/__init__.py +0 -0
  467. package/skills/single-work-analysis/scripts/pipeline/asr/asr_pipeline.py +0 -1189
  468. package/skills/single-work-analysis/scripts/pipeline/asr/poll_u2_task.py +0 -95
  469. package/skills/single-work-analysis/scripts/platform/__init__.py +0 -0
  470. package/skills/single-work-analysis/scripts/platform/douyin/__init__.py +0 -0
  471. package/skills/single-work-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +0 -224
  472. package/skills/single-work-analysis/scripts/platform/douyin/select_low_quality_video_url.py +0 -200
  473. package/skills/single-work-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
  474. package/skills/single-work-analysis/scripts/writers/__init__.py +0 -0
  475. package/skills/single-work-analysis/scripts/writers/write_benchmark_card.py +0 -1402
  476. /package/skills/{creator-analysis → social-media-crawl}/scripts/core/bootstrap_env.py +0 -0
  477. /package/skills/{creator-analysis → social-media-crawl}/scripts/core/extract_pipeline.py +0 -0
  478. /package/skills/{creator-analysis/scripts/platform/douyin → social-media-crawl/scripts/pipelines}/douyin_video_type_matrix.py +0 -0
  479. /package/skills/{creator-analysis/scripts/author_home/collectors → social-media-crawl/scripts/pipelines}/homepage_collectors.py +0 -0
  480. /package/skills/{creator-analysis/scripts/platform/douyin → social-media-crawl/scripts/pipelines}/select_low_quality_video_url.py +0 -0
@@ -1,1683 +0,0 @@
1
- # Xiaohongshu-App-V2-API Full Contract
2
-
3
- - Back to index: [`api-capability-index.md`](../api-capability-index.md)
4
- - Back to route summary: [`api-tags/xiaohongshu-app-v2-api.md`](../api-tags/xiaohongshu-app-v2-api.md)
5
- - Current contract file: `api-contracts/xiaohongshu-app-v2-api.md`
6
- - Source: `https://app.tikomni.com/openapi/tikomni-openapi.full.with-u2.public.latest.json`
7
- - Fetched at: `2026-03-08T06:54:04+00:00`
8
- - Route count: `21`
9
- - Default auth: Header `Authorization` Bearer
10
- - Read this file only when you need precise auth notes, parameter descriptions, defaults, examples, or success-response fields.
11
- - Tag description: **(小红书App V2数据接口/Xiaohongshu-App-V2-API data endpoints)** ⭐ 推荐优先使用/Recommended first choice - 稳定性最高、功能最全/Most stable and feature-rich
12
-
13
- ## Route Contracts
14
-
15
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-creator-hot-inspiration-feed"></a>
16
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_creator_hot_inspiration_feed`
17
-
18
- - Summary: 获取创作者热点灵感列表/Get creator hot inspiration feed
19
- - Capabilities: trends / rankings / creators
20
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
21
- - operationId: `get_creator_hot_inspiration_feed_api_v1_xiaohongshu_app_v2_get_creator_hot_inspiration_feed_get`
22
-
23
- #### Notes
24
-
25
- > # [中文]
26
- > ### 用途:
27
- > - 获取创作者中心的热点创作灵感流,使用游标分页
28
- > ### 参数:
29
- > - cursor: 分页游标,首次请求留空,翻页时传入上一次响应中返回的 cursor 值(如 "1", "2"...)
30
- > ### 返回:
31
- > - 热点灵感列表数据
32
- > ### 翻页说明:
33
- > - 首次请求:cursor 留空
34
- > - 翻页请求:传入上一次响应中返回的 cursor 值
35
- >
36
- > # [English]
37
- > ### Purpose:
38
- > - Get creator center hot inspiration feed, using cursor pagination
39
- > ### Parameters:
40
- > - cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response (e.g. "1", "2"...)
41
- > ### Return:
42
- > - Hot inspiration feed data
43
- > ### Pagination Guide:
44
- > - First request: leave cursor empty
45
- > - Next page: pass cursor value from previous response
46
- >
47
- > # [示例/Example]
48
- > cursor=""
49
-
50
- #### Parameters
51
-
52
- | Field | In | Type | Required | Description | Default | Example | Enum |
53
- | --- | --- | --- | --- | --- | --- | --- | --- |
54
- | cursor | query | string | No | 分页游标,首次请求留空/Pagination cursor, leave empty for first request | None | None | None |
55
-
56
- #### Request Body
57
-
58
- None
59
-
60
- #### Success Response
61
-
62
- ##### `200 application/json`
63
-
64
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
65
-
66
- | Field | Type | Required | Description | Default | Example | Enum |
67
- | --- | --- | --- | --- | --- | --- | --- |
68
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
69
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
70
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
71
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
72
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
73
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
74
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
75
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
76
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
77
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
78
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
79
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
80
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
81
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
82
- | data | null | No | The response data \| 响应数据 | None | None | None |
83
-
84
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-creator-inspiration-feed"></a>
85
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_creator_inspiration_feed`
86
-
87
- - Summary: 获取创作者推荐灵感列表/Get creator inspiration feed
88
- - Capabilities: creators
89
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
90
- - operationId: `get_creator_inspiration_feed_api_v1_xiaohongshu_app_v2_get_creator_inspiration_feed_get`
91
-
92
- #### Notes
93
-
94
- > # [中文]
95
- > ### 用途:
96
- > - 获取创作者中心的推荐创作灵感流,使用游标分页
97
- > ### 参数:
98
- > - cursor: 分页游标,首次请求留空,翻页时传入上一次响应中返回的 cursor 值(如 "r_1", "r_2"...)
99
- > - tab: 标签类型,默认 0
100
- > - source: 来源,默认 "creator_center"
101
- > ### 返回:
102
- > - 推荐灵感列表数据
103
- > ### 翻页说明:
104
- > - 首次请求:cursor 留空
105
- > - 翻页请求:传入上一次响应中返回的 cursor 值
106
- >
107
- > # [English]
108
- > ### Purpose:
109
- > - Get creator center recommended inspiration feed, using cursor pagination
110
- > ### Parameters:
111
- > - cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response (e.g. "r_1", "r_2"...)
112
- > - tab: Tab type, default 0
113
- > - source: Source, default "creator_center"
114
- > ### Return:
115
- > - Recommended inspiration feed data
116
- > ### Pagination Guide:
117
- > - First request: leave cursor empty
118
- > - Next page: pass cursor value from previous response
119
- >
120
- > # [示例/Example]
121
- > cursor=""
122
-
123
- #### Parameters
124
-
125
- | Field | In | Type | Required | Description | Default | Example | Enum |
126
- | --- | --- | --- | --- | --- | --- | --- | --- |
127
- | cursor | query | string | No | 分页游标,首次请求留空/Pagination cursor, leave empty for first request | None | None | None |
128
- | tab | query | integer | No | 标签类型/Tab type | 0 | 0 | None |
129
- | source | query | string | No | 来源/Source | creator_center | creator_center | None |
130
-
131
- #### Request Body
132
-
133
- None
134
-
135
- #### Success Response
136
-
137
- ##### `200 application/json`
138
-
139
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
140
-
141
- | Field | Type | Required | Description | Default | Example | Enum |
142
- | --- | --- | --- | --- | --- | --- | --- |
143
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
144
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
145
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
146
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
147
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
148
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
149
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
150
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
151
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
152
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
153
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
154
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
155
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
156
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
157
- | data | null | No | The response data \| 响应数据 | None | None | None |
158
-
159
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-image-note-detail"></a>
160
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_image_note_detail`
161
-
162
- - Summary: 获取图文笔记详情/Get image note detail
163
- - Capabilities: content details / details
164
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
165
- - operationId: `get_image_note_detail_api_v1_xiaohongshu_app_v2_get_image_note_detail_get`
166
-
167
- #### Notes
168
-
169
- > # [中文]
170
- > ### 用途:
171
- > - 获取图文笔记的完整详情数据
172
- > ### 接口优先级:
173
- > - ⭐ 小红书接口推荐优先级: `App V2(本接口)` > `App` > `Web V2` > `Web`
174
- > ### 参数:
175
- > - note_id: 笔记ID,如 "697c0eee000000000a03c308"
176
- > - share_text: 小红书分享链接(支持APP和Web端分享链接)
177
- > - 优先使用`note_id`,如果没有则使用`share_text`,两个参数二选一,如都携带则以`note_id`为准。
178
- > ### 返回:
179
- > - 图文笔记详情数据,包含笔记内容、图片列表、作者信息、互动数据等
180
- >
181
- > # [English]
182
- > ### Purpose:
183
- > - Get full detail data of an image note
184
- > ### API Priority:
185
- > - ⭐ Xiaohongshu API priority: `App V2 (this)` > `App` > `Web V2` > `Web`
186
- > ### Parameters:
187
- > - note_id: Note ID, e.g. "697c0eee000000000a03c308"
188
- > - share_text: Xiaohongshu sharing link (support APP and Web sharing link)
189
- > - Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.
190
- > ### Return:
191
- > - Image note detail data, including note content, image list, author info, interaction data, etc.
192
- >
193
- > # [示例/Example]
194
- > note_id="697c0eee000000000a03c308"
195
-
196
- #### Parameters
197
-
198
- | Field | In | Type | Required | Description | Default | Example | Enum |
199
- | --- | --- | --- | --- | --- | --- | --- | --- |
200
- | note_id | query | string | No | 笔记ID/Note ID | None | 697c0eee000000000a03c308 | None |
201
- | share_text | query | string | No | 分享链接/Share link | None | http://xhslink.com/o/8GqargIxrko | None |
202
-
203
- #### Request Body
204
-
205
- None
206
-
207
- #### Success Response
208
-
209
- ##### `200 application/json`
210
-
211
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
212
-
213
- | Field | Type | Required | Description | Default | Example | Enum |
214
- | --- | --- | --- | --- | --- | --- | --- |
215
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
216
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
217
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
218
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
219
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
220
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
221
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
222
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
223
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
224
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
225
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
226
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
227
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
228
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
229
- | data | null | No | The response data \| 响应数据 | None | None | None |
230
-
231
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-mixed-note-detail"></a>
232
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_mixed_note_detail`
233
-
234
- - Summary: 获取首页推荐流笔记详情/Get mixed note detail from feed
235
- - Capabilities: content details / details
236
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
237
- - operationId: `get_mixed_note_detail_api_v1_xiaohongshu_app_v2_get_mixed_note_detail_get`
238
-
239
- #### Notes
240
-
241
- > # [中文]
242
- > ### 用途:
243
- > - 从首页推荐流中获取指定笔记的详情
244
- > - 返回的数据结构与图文/视频接口不同,包含推荐流上下文信息
245
- > ### 参数:
246
- > - note_id: 笔记ID(可选),如 "697c0eee000000000a03c308",为空则返回首页推荐流数据
247
- > - share_text: 小红书分享链接(支持APP和Web端分享链接)
248
- > - 优先使用`note_id`,如果没有则使用`share_text`,两个参数二选一,如都携带则以`note_id`为准。
249
- > ### 返回:
250
- > - 推荐流笔记详情数据,包含推荐流上下文信息
251
- >
252
- > # [English]
253
- > ### Purpose:
254
- > - Get note detail from homepage feed
255
- > - The returned data structure differs from image/video endpoints, including feed context info
256
- > ### Parameters:
257
- > - note_id: Note ID (optional), e.g. "697c0eee000000000a03c308", returns homepage feed data if empty
258
- > - share_text: Xiaohongshu sharing link (support APP and Web sharing link)
259
- > - Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.
260
- > ### Return:
261
- > - Feed note detail data, including feed context info
262
- >
263
- > # [示例/Example]
264
- > note_id="697c0eee000000000a03c308"
265
-
266
- #### Parameters
267
-
268
- | Field | In | Type | Required | Description | Default | Example | Enum |
269
- | --- | --- | --- | --- | --- | --- | --- | --- |
270
- | note_id | query | string | No | 笔记ID/Note ID | None | 697c0eee000000000a03c308 | None |
271
- | share_text | query | string | No | 分享链接/Share link | None | http://xhslink.com/o/8GqargIxrko | None |
272
-
273
- #### Request Body
274
-
275
- None
276
-
277
- #### Success Response
278
-
279
- ##### `200 application/json`
280
-
281
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
282
-
283
- | Field | Type | Required | Description | Default | Example | Enum |
284
- | --- | --- | --- | --- | --- | --- | --- |
285
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
286
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
287
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
288
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
289
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
290
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
291
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
292
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
293
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
294
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
295
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
296
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
297
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
298
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
299
- | data | null | No | The response data \| 响应数据 | None | None | None |
300
-
301
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-note-comments"></a>
302
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_note_comments`
303
-
304
- - Summary: 获取笔记评论列表/Get note comments
305
- - Capabilities: comments / content details
306
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
307
- - operationId: `get_note_comments_api_v1_xiaohongshu_app_v2_get_note_comments_get`
308
-
309
- #### Notes
310
-
311
- > # [中文]
312
- > ### 用途:
313
- > - 获取指定笔记的评论列表,支持分页和多种排序方式
314
- > ### 参数:
315
- > - note_id: 笔记ID,如 "697c0eee000000000a03c308"
316
- > - share_text: 小红书分享链接(支持APP和Web端分享链接)
317
- > - 优先使用`note_id`,如果没有则使用`share_text`,两个参数二选一,如都携带则以`note_id`为准。
318
- > - cursor: 分页游标,首次请求留空,翻页时传入上一次响应中返回的 cursor 值
319
- > - index: 评论索引,首次请求传 0,翻页时传入上一次响应中返回的 index 值
320
- > - sort_strategy: 排序策略
321
- > - "default": 默认排序(推荐)
322
- > - "latest_v2": 按时间倒序(最新)
323
- > - "like_count": 按点赞数排序(最热)
324
- > ### 返回:
325
- > - 评论数据对象,包含评论列表、分页游标等
326
- > ### 翻页说明:
327
- > - 首次请求:cursor留空,index传0
328
- > - 翻页请求:传入上一次响应中返回的 cursor 和 index 值
329
- >
330
- > # [English]
331
- > ### Purpose:
332
- > - Get comment list for a specified note, supports pagination and multiple sort strategies
333
- > ### Parameters:
334
- > - note_id: Note ID, e.g. "697c0eee000000000a03c308"
335
- > - share_text: Xiaohongshu sharing link (support APP and Web sharing link)
336
- > - Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.
337
- > - cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response for next page
338
- > - index: Comment index, pass 0 for first request, pass index value from previous response for next page
339
- > - sort_strategy: Sort strategy
340
- > - "default": Default sort (recommended)
341
- > - "latest_v2": Sort by time descending (latest)
342
- > - "like_count": Sort by like count (most popular)
343
- > ### Return:
344
- > - Comments data object, including comment list, pagination cursor, etc.
345
- > ### Pagination Guide:
346
- > - First request: leave cursor empty, pass index as 0
347
- > - Next page: pass cursor and index values from previous response
348
- >
349
- > # [示例/Example]
350
- > note_id="697c0eee000000000a03c308"
351
- > sort_strategy="default"
352
-
353
- #### Parameters
354
-
355
- | Field | In | Type | Required | Description | Default | Example | Enum |
356
- | --- | --- | --- | --- | --- | --- | --- | --- |
357
- | note_id | query | string | No | 笔记ID/Note ID | None | 697c0eee000000000a03c308 | None |
358
- | share_text | query | string | No | 分享链接/Share link | None | http://xhslink.com/o/8GqargIxrko | None |
359
- | cursor | query | string | No | 分页游标,首次请求留空/Pagination cursor, leave empty for first request | None | None | None |
360
- | index | query | integer | No | 评论索引,首次请求传0/Comment index, pass 0 for first request | 0 | 0 | None |
361
- | sort_strategy | query | string | No | 排序策略/Sort strategy: default, latest_v2, like_count | default | default | None |
362
-
363
- #### Request Body
364
-
365
- None
366
-
367
- #### Success Response
368
-
369
- ##### `200 application/json`
370
-
371
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
372
-
373
- | Field | Type | Required | Description | Default | Example | Enum |
374
- | --- | --- | --- | --- | --- | --- | --- |
375
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
376
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
377
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
378
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
379
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
380
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
381
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
382
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
383
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
384
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
385
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
386
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
387
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
388
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
389
- | data | null | No | The response data \| 响应数据 | None | None | None |
390
-
391
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-note-sub-comments"></a>
392
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_note_sub_comments`
393
-
394
- - Summary: 获取笔记二级评论列表/Get note sub comments
395
- - Capabilities: comments / content details
396
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
397
- - operationId: `get_note_sub_comments_api_v1_xiaohongshu_app_v2_get_note_sub_comments_get`
398
-
399
- #### Notes
400
-
401
- > # [中文]
402
- > ### 用途:
403
- > - 获取指定笔记某条评论下的子评论(回复)列表,使用游标分页
404
- > ### 参数:
405
- > - note_id: 笔记ID,如 "699916e6000000001d0253da"
406
- > - share_text: 小红书分享链接(支持APP和Web端分享链接)
407
- > - 优先使用`note_id`,如果没有则使用`share_text`,两个参数二选一,如都携带则以`note_id`为准。
408
- > - comment_id: 父评论ID(必需),如 "699fb9930000000008030db6"
409
- > - cursor: 分页游标,首次请求留空,翻页时从上一次响应的 `$.data.data.cursor` 中提取 `cursor` 字段的值
410
- > - index: 分页索引,首次请求传 1,翻页时从上一次响应的 `$.data.data.cursor` 中提取 `index` 字段的值
411
- > ### 返回:
412
- > - 子评论数据对象,包含子评论列表、分页游标等
413
- > ### 翻页说明:
414
- > - 响应中的 `$.data.data.cursor` 是一个 JSON 对象,示例: `{"cursor":"69a0c134000000000c00910d","index":3}`
415
- > - 首次请求:cursor留空,index传1
416
- > - 翻页请求:从 `$.data.data.cursor` 中提取 `cursor` 和 `index` 分别传入对应参数
417
- >
418
- > # [English]
419
- > ### Purpose:
420
- > - Get sub-comment (reply) list under a specific comment of a note, using cursor pagination
421
- > ### Parameters:
422
- > - note_id: Note ID, e.g. "699916e6000000001d0253da"
423
- > - share_text: Xiaohongshu sharing link (support APP and Web sharing link)
424
- > - Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.
425
- > - comment_id: Parent comment ID (required), e.g. "699fb9930000000008030db6"
426
- > - cursor: Pagination cursor, leave empty for first request, extract `cursor` value from `$.data.cursor` of previous response for next page
427
- > - index: Pagination index, pass 1 for first request, extract `index` value from `$.data.cursor` of previous response for next page
428
- > ### Return:
429
- > - Sub-comments data object, including sub-comment list, pagination cursor, etc.
430
- > ### Pagination Guide:
431
- > - The `$.data.data.cursor` in response is a JSON object, e.g. `{"cursor":"69a0c134000000000c00910d","index":3}`
432
- > - First request: leave cursor empty, pass index as 1
433
- > - Next page: extract `cursor` and `index` from `$.data.data.cursor` and pass them as corresponding parameters
434
- >
435
- > # [示例/Example]
436
- > note_id="699916e6000000001d0253da"
437
- > comment_id="699fb9930000000008030db6"
438
-
439
- #### Parameters
440
-
441
- | Field | In | Type | Required | Description | Default | Example | Enum |
442
- | --- | --- | --- | --- | --- | --- | --- | --- |
443
- | note_id | query | string | No | 笔记ID/Note ID | None | 699916e6000000001d0253da | None |
444
- | share_text | query | string | No | 分享链接/Share link | None | http://xhslink.com/o/8GqargIxrko | None |
445
- | comment_id | query | string | Yes | 父评论ID/Parent comment ID | None | 699fb9930000000008030db6 | None |
446
- | cursor | query | string | No | 分页游标,首次留空,翻页时从$.data.data.cursor中提取cursor值/Pagination cursor, leave empty for first request, extract cursor from $.data.cursor for next page | None | None | None |
447
- | index | query | integer | No | 分页索引,首次传1,翻页时从$.data.data.cursor中提取index值/Pagination index, pass 1 for first request, extract index from $.data.cursor for next page | 1 | 1 | None |
448
-
449
- #### Request Body
450
-
451
- None
452
-
453
- #### Success Response
454
-
455
- ##### `200 application/json`
456
-
457
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
458
-
459
- | Field | Type | Required | Description | Default | Example | Enum |
460
- | --- | --- | --- | --- | --- | --- | --- |
461
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
462
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
463
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
464
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
465
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
466
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
467
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
468
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
469
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
470
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
471
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
472
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
473
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
474
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
475
- | data | null | No | The response data \| 响应数据 | None | None | None |
476
-
477
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-product-detail"></a>
478
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_product_detail`
479
-
480
- - Summary: 获取商品详情/Get product detail
481
- - Capabilities: details / commerce
482
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
483
- - operationId: `get_product_detail_api_v1_xiaohongshu_app_v2_get_product_detail_get`
484
-
485
- #### Notes
486
-
487
- > # [中文]
488
- > ### 用途:
489
- > - 通过 SKU ID 获取商品的详细信息,包括价格、规格、库存、商品描述等
490
- > ### 参数:
491
- > - sku_id: 商品 SKU ID(必需),如 "669ddd44e05f3700011067ed"
492
- > - source: 来源,默认 "mall_search"
493
- > - pre_page: 前置页面,默认 "mall_search"
494
- > ### 返回:
495
- > - 商品详情数据,包含价格、规格、库存、商品描述等
496
- >
497
- > # [English]
498
- > ### Purpose:
499
- > - Get product detail by SKU ID, including price, specifications, stock, description, etc.
500
- > ### Parameters:
501
- > - sku_id: Product SKU ID (required), e.g. "669ddd44e05f3700011067ed"
502
- > - source: Source, default "mall_search"
503
- > - pre_page: Previous page, default "mall_search"
504
- > ### Return:
505
- > - Product detail data, including price, specifications, stock, description, etc.
506
- >
507
- > # [示例/Example]
508
- > sku_id="669ddd44e05f3700011067ed"
509
-
510
- #### Parameters
511
-
512
- | Field | In | Type | Required | Description | Default | Example | Enum |
513
- | --- | --- | --- | --- | --- | --- | --- | --- |
514
- | sku_id | query | string | Yes | 商品SKU ID/Product SKU ID | None | 669ddd44e05f3700011067ed | None |
515
- | source | query | string | No | 来源/Source | mall_search | mall_search | None |
516
- | pre_page | query | string | No | 前置页面/Previous page | mall_search | mall_search | None |
517
-
518
- #### Request Body
519
-
520
- None
521
-
522
- #### Success Response
523
-
524
- ##### `200 application/json`
525
-
526
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
527
-
528
- | Field | Type | Required | Description | Default | Example | Enum |
529
- | --- | --- | --- | --- | --- | --- | --- |
530
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
531
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
532
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
533
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
534
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
535
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
536
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
537
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
538
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
539
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
540
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
541
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
542
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
543
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
544
- | data | null | No | The response data \| 响应数据 | None | None | None |
545
-
546
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-product-recommendations"></a>
547
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_product_recommendations`
548
-
549
- - Summary: 获取商品推荐列表/Get product recommendations
550
- - Capabilities: commerce
551
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
552
- - operationId: `get_product_recommendations_api_v1_xiaohongshu_app_v2_get_product_recommendations_get`
553
-
554
- #### Notes
555
-
556
- > # [中文]
557
- > ### 用途:
558
- > - 根据商品 SKU ID 获取相关推荐商品列表,使用游标分页
559
- > ### 参数:
560
- > - sku_id: 商品 SKU ID(必需),如 "669ddd44e05f3700011067ed"
561
- > - cursor_score: 分页游标,首次请求留空,翻页时传入上一次响应中返回的 cursor_score 值
562
- > - region: 地区,默认 "US"
563
- > ### 返回:
564
- > - 推荐商品列表数据
565
- > ### 翻页说明:
566
- > - 首次请求:cursor_score 留空
567
- > - 翻页请求:传入上一次响应中返回的 cursor_score 值
568
- >
569
- > # [English]
570
- > ### Purpose:
571
- > - Get recommended products list by SKU ID, using cursor pagination
572
- > ### Parameters:
573
- > - sku_id: Product SKU ID (required), e.g. "669ddd44e05f3700011067ed"
574
- > - cursor_score: Pagination cursor, leave empty for first request, pass cursor_score value from previous response for next page
575
- > - region: Region, default "US"
576
- > ### Return:
577
- > - Recommended products list data
578
- > ### Pagination Guide:
579
- > - First request: leave cursor_score empty
580
- > - Next page: pass cursor_score value from previous response
581
- >
582
- > # [示例/Example]
583
- > sku_id="669ddd44e05f3700011067ed"
584
-
585
- #### Parameters
586
-
587
- | Field | In | Type | Required | Description | Default | Example | Enum |
588
- | --- | --- | --- | --- | --- | --- | --- | --- |
589
- | sku_id | query | string | Yes | 商品SKU ID/Product SKU ID | None | 669ddd44e05f3700011067ed | None |
590
- | cursor_score | query | string | No | 分页游标,首次请求留空/Pagination cursor, leave empty for first request | None | None | None |
591
- | region | query | string | No | 地区/Region | US | US | None |
592
-
593
- #### Request Body
594
-
595
- None
596
-
597
- #### Success Response
598
-
599
- ##### `200 application/json`
600
-
601
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
602
-
603
- | Field | Type | Required | Description | Default | Example | Enum |
604
- | --- | --- | --- | --- | --- | --- | --- |
605
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
606
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
607
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
608
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
609
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
610
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
611
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
612
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
613
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
614
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
615
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
616
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
617
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
618
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
619
- | data | null | No | The response data \| 响应数据 | None | None | None |
620
-
621
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-product-review-overview"></a>
622
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_product_review_overview`
623
-
624
- - Summary: 获取商品评论总览/Get product review overview
625
- - Capabilities: commerce
626
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
627
- - operationId: `get_product_review_overview_api_v1_xiaohongshu_app_v2_get_product_review_overview_get`
628
-
629
- #### Notes
630
-
631
- > # [中文]
632
- > ### 用途:
633
- > - 获取商品的评论统计信息,包括评分分布、好评率、评论标签等
634
- > ### 参数:
635
- > - sku_id: 商品 SKU ID(必需),如 "669ddd44e05f3700011067ed"
636
- > - tab: 标签类型,默认 2
637
- > ### 返回:
638
- > - 商品评论总览数据,包含评分分布、好评率、评论标签等
639
- >
640
- > # [English]
641
- > ### Purpose:
642
- > - Get product review statistics, including rating distribution, positive rate, review tags, etc.
643
- > ### Parameters:
644
- > - sku_id: Product SKU ID (required), e.g. "669ddd44e05f3700011067ed"
645
- > - tab: Tab type, default 2
646
- > ### Return:
647
- > - Product review overview data, including rating distribution, positive rate, review tags, etc.
648
- >
649
- > # [示例/Example]
650
- > sku_id="669ddd44e05f3700011067ed"
651
-
652
- #### Parameters
653
-
654
- | Field | In | Type | Required | Description | Default | Example | Enum |
655
- | --- | --- | --- | --- | --- | --- | --- | --- |
656
- | sku_id | query | string | Yes | 商品SKU ID/Product SKU ID | None | 669ddd44e05f3700011067ed | None |
657
- | tab | query | integer | No | 标签类型/Tab type | 2 | 2 | None |
658
-
659
- #### Request Body
660
-
661
- None
662
-
663
- #### Success Response
664
-
665
- ##### `200 application/json`
666
-
667
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
668
-
669
- | Field | Type | Required | Description | Default | Example | Enum |
670
- | --- | --- | --- | --- | --- | --- | --- |
671
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
672
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
673
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
674
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
675
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
676
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
677
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
678
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
679
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
680
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
681
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
682
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
683
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
684
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
685
- | data | null | No | The response data \| 响应数据 | None | None | None |
686
-
687
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-product-reviews"></a>
688
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_product_reviews`
689
-
690
- - Summary: 获取商品评论列表/Get product reviews
691
- - Capabilities: commerce
692
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
693
- - operationId: `get_product_reviews_api_v1_xiaohongshu_app_v2_get_product_reviews_get`
694
-
695
- #### Notes
696
-
697
- > # [中文]
698
- > ### 用途:
699
- > - 获取商品的用户评论列表,支持分页、排序和筛选有图评论
700
- > ### 参数:
701
- > - sku_id: 商品 SKU ID(必需),如 "669ddd44e05f3700011067ed"
702
- > - page: 页码,从 0 开始
703
- > - sort_strategy_type: 排序策略
704
- > - 0: 综合排序(默认)
705
- > - 1: 最新排序
706
- > - share_pics_only: 仅看有图评论,0=否, 1=是
707
- > - from_page: 来源页面,默认 "score_page"
708
- > ### 返回:
709
- > - 商品评论列表数据
710
- > ### 翻页说明:
711
- > - page 从 0 开始递增
712
- >
713
- > # [English]
714
- > ### Purpose:
715
- > - Get product user reviews list, supports pagination, sorting, and filtering reviews with images
716
- > ### Parameters:
717
- > - sku_id: Product SKU ID (required), e.g. "669ddd44e05f3700011067ed"
718
- > - page: Page number, start from 0
719
- > - sort_strategy_type: Sort strategy
720
- > - 0: General sort (default)
721
- > - 1: Latest sort
722
- > - share_pics_only: Show reviews with images only, 0=no, 1=yes
723
- > - from_page: From page, default "score_page"
724
- > ### Return:
725
- > - Product reviews list data
726
- > ### Pagination Guide:
727
- > - page starts from 0 and increments
728
- >
729
- > # [示例/Example]
730
- > sku_id="669ddd44e05f3700011067ed"
731
- > page=0
732
-
733
- #### Parameters
734
-
735
- | Field | In | Type | Required | Description | Default | Example | Enum |
736
- | --- | --- | --- | --- | --- | --- | --- | --- |
737
- | sku_id | query | string | Yes | 商品SKU ID/Product SKU ID | None | 669ddd44e05f3700011067ed | None |
738
- | page | query | integer | No | 页码,从0开始/Page number, start from 0 | 0 | 0 | None |
739
- | sort_strategy_type | query | integer | No | 排序策略:0=综合排序, 1=最新排序/Sort strategy: 0=general, 1=latest | 0 | 0 | None |
740
- | share_pics_only | query | integer | No | 仅看有图评论:0=否, 1=是/Show reviews with images only: 0=no, 1=yes | 0 | 0 | None |
741
- | from_page | query | string | No | 来源页面/From page | score_page | score_page | None |
742
-
743
- #### Request Body
744
-
745
- None
746
-
747
- #### Success Response
748
-
749
- ##### `200 application/json`
750
-
751
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
752
-
753
- | Field | Type | Required | Description | Default | Example | Enum |
754
- | --- | --- | --- | --- | --- | --- | --- |
755
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
756
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
757
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
758
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
759
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
760
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
761
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
762
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
763
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
764
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
765
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
766
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
767
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
768
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
769
- | data | null | No | The response data \| 响应数据 | None | None | None |
770
-
771
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-topic-feed"></a>
772
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_topic_feed`
773
-
774
- - Summary: 获取话题笔记列表/Get topic feed
775
- - Capabilities: topics
776
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
777
- - operationId: `get_topic_feed_api_v1_xiaohongshu_app_v2_get_topic_feed_get`
778
-
779
- #### Notes
780
-
781
- > # [中文]
782
- > ### 用途:
783
- > - 获取指定话题下的笔记列表,支持按最热或最新排序,使用游标分页
784
- > ### 参数:
785
- > - page_id: 话题页面ID(必需),如 "5c1cc866febed9000184b7c1"
786
- > - sort: 排序方式
787
- > - "trend": 最热(默认)
788
- > - "time": 最新
789
- > - cursor_score: 分页游标分数,翻页时传入上一页最后一个 item 的 cursor_score
790
- > - last_note_id: 上一页最后一条笔记ID,翻页时传入
791
- > - last_note_ct: 上一页最后一条笔记创建时间,翻页时传入
792
- > - session_id: 会话ID,翻页时保持一致
793
- > - first_load_time: 首次加载时间戳,翻页时保持一致
794
- > - source: 来源,默认 "normal"
795
- > ### 返回:
796
- > - 话题笔记列表数据
797
- > ### 翻页说明:
798
- > - 首次请求:只传 page_id 和 sort,其余留空
799
- > - 翻页请求:取上一次响应最后一个 item 的字段:
800
- > - cursor_score ← items[-1].cursor_score
801
- > - last_note_id ← items[-1].id
802
- > - last_note_ct ← items[-1].create_time
803
- > - 建议同时回传 session_id 和 first_load_time 保持会话一致
804
- >
805
- > # [English]
806
- > ### Purpose:
807
- > - Get notes list under a specified topic, supports sorting by trending or latest, using cursor pagination
808
- > ### Parameters:
809
- > - page_id: Topic page ID (required), e.g. "5c1cc866febed9000184b7c1"
810
- > - sort: Sort type
811
- > - "trend": Trending (default)
812
- > - "time": Latest
813
- > - cursor_score: Pagination cursor score, pass last item's cursor_score from previous response
814
- > - last_note_id: Last note ID from previous page
815
- > - last_note_ct: Last note create time from previous page
816
- > - session_id: Session ID, keep consistent for pagination
817
- > - first_load_time: First load timestamp, keep consistent for pagination
818
- > - source: Source, default "normal"
819
- > ### Return:
820
- > - Topic notes list data
821
- > ### Pagination Guide:
822
- > - First request: only pass page_id and sort, leave others empty
823
- > - Next page: pass fields from last item of previous response:
824
- > - cursor_score ← items[-1].cursor_score
825
- > - last_note_id ← items[-1].id
826
- > - last_note_ct ← items[-1].create_time
827
- > - Recommended to also pass session_id and first_load_time for session consistency
828
- >
829
- > # [示例/Example]
830
- > page_id="5c1cc866febed9000184b7c1"
831
- > sort="trend"
832
-
833
- #### Parameters
834
-
835
- | Field | In | Type | Required | Description | Default | Example | Enum |
836
- | --- | --- | --- | --- | --- | --- | --- | --- |
837
- | page_id | query | string | Yes | 话题页面ID/Topic page ID | None | 5c1cc866febed9000184b7c1 | None |
838
- | sort | query | string | No | 排序方式/Sort: trend(最热), time(最新) | trend | trend | None |
839
- | cursor_score | query | string | No | 分页游标分数,翻页时传入/Pagination cursor score for next page | None | None | None |
840
- | last_note_id | query | string | No | 上一页最后一条笔记ID,翻页时传入/Last note ID from previous page | None | None | None |
841
- | last_note_ct | query | string | No | 上一页最后一条笔记创建时间,翻页时传入/Last note create time from previous page | None | None | None |
842
- | session_id | query | string | No | 会话ID,翻页时保持一致/Session ID, keep consistent for pagination | None | None | None |
843
- | first_load_time | query | string | No | 首次加载时间戳,翻页时保持一致/First load timestamp, keep consistent for pagination | None | None | None |
844
- | source | query | string | No | 来源/Source | normal | normal | None |
845
-
846
- #### Request Body
847
-
848
- None
849
-
850
- #### Success Response
851
-
852
- ##### `200 application/json`
853
-
854
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
855
-
856
- | Field | Type | Required | Description | Default | Example | Enum |
857
- | --- | --- | --- | --- | --- | --- | --- |
858
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
859
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
860
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
861
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
862
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
863
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
864
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
865
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
866
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
867
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
868
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
869
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
870
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
871
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
872
- | data | null | No | The response data \| 响应数据 | None | None | None |
873
-
874
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-topic-info"></a>
875
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_topic_info`
876
-
877
- - Summary: 获取话题详情/Get topic info
878
- - Capabilities: topics
879
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
880
- - operationId: `get_topic_info_api_v1_xiaohongshu_app_v2_get_topic_info_get`
881
-
882
- #### Notes
883
-
884
- > # [中文]
885
- > ### 用途:
886
- > - 获取指定话题的详细信息,包括话题名称、浏览量、讨论数、分享信息等
887
- > ### 参数:
888
- > - page_id: 话题页面ID(必需),如 "5c1cc866febed9000184b7c1"
889
- > - source: 来源,默认 "normal"
890
- > - note_id: 来源笔记ID,从笔记跳转到话题时传入(可选)
891
- > ### 返回:
892
- > - 话题详情数据,包含 page_info(名称/浏览量/讨论数)、tabs、share_info 等
893
- >
894
- > # [English]
895
- > ### Purpose:
896
- > - Get topic detail info, including topic name, view count, discussion count, share info, etc.
897
- > ### Parameters:
898
- > - page_id: Topic page ID (required), e.g. "5c1cc866febed9000184b7c1"
899
- > - source: Source, default "normal"
900
- > - note_id: Source note ID, pass when jumping from note to topic (optional)
901
- > ### Return:
902
- > - Topic detail data, including page_info (name/view count/discussion count), tabs, share_info, etc.
903
- >
904
- > # [示例/Example]
905
- > page_id="5c1cc866febed9000184b7c1"
906
-
907
- #### Parameters
908
-
909
- | Field | In | Type | Required | Description | Default | Example | Enum |
910
- | --- | --- | --- | --- | --- | --- | --- | --- |
911
- | page_id | query | string | Yes | 话题页面ID/Topic page ID | None | 5c1cc866febed9000184b7c1 | None |
912
- | source | query | string | No | 来源/Source | normal | normal | None |
913
- | note_id | query | string | No | 来源笔记ID,从笔记跳转到话题时传入/Source note ID, pass when jumping from note to topic | None | None | None |
914
-
915
- #### Request Body
916
-
917
- None
918
-
919
- #### Success Response
920
-
921
- ##### `200 application/json`
922
-
923
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
924
-
925
- | Field | Type | Required | Description | Default | Example | Enum |
926
- | --- | --- | --- | --- | --- | --- | --- |
927
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
928
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
929
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
930
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
931
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
932
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
933
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
934
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
935
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
936
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
937
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
938
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
939
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
940
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
941
- | data | null | No | The response data \| 响应数据 | None | None | None |
942
-
943
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-user-faved-notes"></a>
944
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_user_faved_notes`
945
-
946
- - Summary: 获取用户收藏笔记列表/Get user faved notes
947
- - Capabilities: profiles / accounts / content details
948
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
949
- - operationId: `get_user_faved_notes_api_v1_xiaohongshu_app_v2_get_user_faved_notes_get`
950
-
951
- #### Notes
952
-
953
- > # [中文]
954
- > ### 用途:
955
- > - 获取指定用户公开收藏的笔记列表,使用游标分页
956
- > ### 参数:
957
- > - user_id: 用户ID,如 "5a8cf39111be10466d285d6b"
958
- > - share_text: 小红书分享链接(支持APP和Web端分享链接)
959
- > - 优先使用`user_id`,如果没有则使用`share_text`,两个参数二选一,如都携带则以`user_id`为准。
960
- > - cursor: 分页游标,首次请求留空,翻页时传入上一页列表中最后一条笔记的 note_id
961
- > ### 返回:
962
- > - 用户收藏笔记列表数据,包含笔记基本信息和分页信息
963
- > ### 翻页说明:
964
- > - 首次请求:cursor留空
965
- > - 翻页请求:传入上一页列表中最后一条笔记的 note_id
966
- >
967
- > # [English]
968
- > ### Purpose:
969
- > - Get list of notes faved by a specified user, using cursor pagination
970
- > ### Parameters:
971
- > - user_id: User ID, e.g. "5a8cf39111be10466d285d6b"
972
- > - share_text: Xiaohongshu sharing link (support APP and Web sharing link)
973
- > - Prefer to use `user_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `user_id` shall prevail.
974
- > - cursor: Pagination cursor, leave empty for first request, pass last note_id from previous page for next page
975
- > ### Return:
976
- > - User faved notes list data, including basic note info and pagination info
977
- > ### Pagination Guide:
978
- > - First request: leave cursor empty
979
- > - Next page: pass last note_id from previous page
980
- >
981
- > # [示例/Example]
982
- > user_id="5a8cf39111be10466d285d6b"
983
-
984
- #### Parameters
985
-
986
- | Field | In | Type | Required | Description | Default | Example | Enum |
987
- | --- | --- | --- | --- | --- | --- | --- | --- |
988
- | user_id | query | string | No | 用户ID/User ID | None | 5a8cf39111be10466d285d6b | None |
989
- | share_text | query | string | No | 分享链接/Share link | None | https://xhslink.com/a/EZ4M9TwMA6c3 | None |
990
- | cursor | query | string | No | 分页游标,首次请求留空,翻页时传入上一页最后一条笔记的note_id/Pagination cursor, leave empty for first request, pass last note_id from previous page for next page | None | None | None |
991
-
992
- #### Request Body
993
-
994
- None
995
-
996
- #### Success Response
997
-
998
- ##### `200 application/json`
999
-
1000
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1001
-
1002
- | Field | Type | Required | Description | Default | Example | Enum |
1003
- | --- | --- | --- | --- | --- | --- | --- |
1004
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1005
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1006
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1007
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1008
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1009
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1010
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1011
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1012
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1013
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1014
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1015
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1016
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1017
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1018
- | data | null | No | The response data \| 响应数据 | None | None | None |
1019
-
1020
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-user-info"></a>
1021
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_user_info`
1022
-
1023
- - Summary: 获取用户信息/Get user info
1024
- - Capabilities: profiles / accounts
1025
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1026
- - operationId: `get_user_info_api_v1_xiaohongshu_app_v2_get_user_info_get`
1027
-
1028
- #### Notes
1029
-
1030
- > # [中文]
1031
- > ### 用途:
1032
- > - 获取指定用户的详细信息
1033
- > ### 参数:
1034
- > - user_id: 用户ID,如 "61b46d790000000010008153"
1035
- > - share_text: 小红书分享链接(支持APP和Web端分享链接)
1036
- > - 优先使用`user_id`,如果没有则使用`share_text`,两个参数二选一,如都携带则以`user_id`为准。
1037
- > ### 返回:
1038
- > - 用户详细信息,包含昵称、头像、简介、粉丝数、关注数、笔记数等
1039
- >
1040
- > # [English]
1041
- > ### Purpose:
1042
- > - Get detailed info of a specified user
1043
- > ### Parameters:
1044
- > - user_id: User ID, e.g. "61b46d790000000010008153"
1045
- > - share_text: Xiaohongshu sharing link (support APP and Web sharing link)
1046
- > - Prefer to use `user_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `user_id` shall prevail.
1047
- > ### Return:
1048
- > - User detailed info, including nickname, avatar, bio, follower count, following count, note count, etc.
1049
- >
1050
- > # [示例/Example]
1051
- > user_id="61b46d790000000010008153"
1052
-
1053
- #### Parameters
1054
-
1055
- | Field | In | Type | Required | Description | Default | Example | Enum |
1056
- | --- | --- | --- | --- | --- | --- | --- | --- |
1057
- | user_id | query | string | No | 用户ID/User ID | None | 61b46d790000000010008153 | None |
1058
- | share_text | query | string | No | 分享链接/Share link | None | https://xhslink.com/m/3ZSCJZAMz0a | None |
1059
-
1060
- #### Request Body
1061
-
1062
- None
1063
-
1064
- #### Success Response
1065
-
1066
- ##### `200 application/json`
1067
-
1068
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1069
-
1070
- | Field | Type | Required | Description | Default | Example | Enum |
1071
- | --- | --- | --- | --- | --- | --- | --- |
1072
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1073
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1074
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1075
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1076
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1077
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1078
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1079
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1080
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1081
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1082
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1083
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1084
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1085
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1086
- | data | null | No | The response data \| 响应数据 | None | None | None |
1087
-
1088
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-user-posted-notes"></a>
1089
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_user_posted_notes`
1090
-
1091
- - Summary: 获取用户笔记列表/Get user posted notes
1092
- - Capabilities: profiles / accounts / content details
1093
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1094
- - operationId: `get_user_posted_notes_api_v1_xiaohongshu_app_v2_get_user_posted_notes_get`
1095
-
1096
- #### Notes
1097
-
1098
- > # [中文]
1099
- > ### 用途:
1100
- > - 获取指定用户已发布的笔记列表,使用游标分页
1101
- > ### 参数:
1102
- > - user_id: 用户ID,如 "61b46d790000000010008153"
1103
- > - share_text: 小红书分享链接(支持APP和Web端分享链接)
1104
- > - 优先使用`user_id`,如果没有则使用`share_text`,两个参数二选一,如都携带则以`user_id`为准。
1105
- > - cursor: 分页游标,首次请求留空,翻页时传入上一次响应中返回的 cursor 值
1106
- > - 通常cursor取值方式为notes列表的最后一条笔记的 note_id
1107
- > - JSON路径示例: `$.data.data.notes[-1].cursor`
1108
- > ### 返回:
1109
- > - 用户笔记列表数据,包含笔记基本信息和分页信息
1110
- > ### 翻页说明:
1111
- > - 首次请求:cursor留空
1112
- > - 翻页请求:传入上一次响应中返回的 cursor 值
1113
- >
1114
- > # [English]
1115
- > ### Purpose:
1116
- > - Get list of notes posted by a specified user, using cursor pagination
1117
- > ### Parameters:
1118
- > - user_id: User ID, e.g. "61b46d790000000010008153"
1119
- > - share_text: Xiaohongshu sharing link (support APP and Web sharing link)
1120
- > - Prefer to use `user_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `user_id` shall prevail.
1121
- > - cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response for next page
1122
- > - The cursor is usually the note_id of the last note in the notes list
1123
- > - JSON path example: `$.data.data.notes[-1].cursor`
1124
- > ### Return:
1125
- > - User posted notes list data, including basic note info and pagination info
1126
- > ### Pagination Guide:
1127
- > - First request: leave cursor empty
1128
- > - Next page: pass cursor value from previous response
1129
- >
1130
- > # [示例/Example]
1131
- > user_id="61b46d790000000010008153"
1132
-
1133
- #### Parameters
1134
-
1135
- | Field | In | Type | Required | Description | Default | Example | Enum |
1136
- | --- | --- | --- | --- | --- | --- | --- | --- |
1137
- | user_id | query | string | No | 用户ID/User ID | None | 61b46d790000000010008153 | None |
1138
- | share_text | query | string | No | 分享链接/Share link | None | http://xhslink.com/o/8GqargIxrko | None |
1139
- | cursor | query | string | No | 分页游标,首次请求留空/Pagination cursor, leave empty for first request | None | None | None |
1140
-
1141
- #### Request Body
1142
-
1143
- None
1144
-
1145
- #### Success Response
1146
-
1147
- ##### `200 application/json`
1148
-
1149
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1150
-
1151
- | Field | Type | Required | Description | Default | Example | Enum |
1152
- | --- | --- | --- | --- | --- | --- | --- |
1153
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1154
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1155
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1156
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1157
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1158
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1159
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1160
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1161
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1162
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1163
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1164
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1165
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1166
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1167
- | data | null | No | The response data \| 响应数据 | None | None | None |
1168
-
1169
- <a id="get-api-u1-v1-xiaohongshu-app-v2-get-video-note-detail"></a>
1170
- ### `GET /api/u1/v1/xiaohongshu/app_v2/get_video_note_detail`
1171
-
1172
- - Summary: 获取视频笔记详情/Get video note detail
1173
- - Capabilities: content details / details
1174
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1175
- - operationId: `get_video_note_detail_api_v1_xiaohongshu_app_v2_get_video_note_detail_get`
1176
-
1177
- #### Notes
1178
-
1179
- > # [中文]
1180
- > ### 用途:
1181
- > - 获取视频笔记的完整详情数据
1182
- > ### 参数:
1183
- > - note_id: 笔记ID,如 "697c0eee000000000a03c308"
1184
- > - share_text: 小红书分享链接(支持APP和Web端分享链接)
1185
- > - 优先使用`note_id`,如果没有则使用`share_text`,两个参数二选一,如都携带则以`note_id`为准。
1186
- > ### 返回:
1187
- > - 视频笔记详情数据,包含视频播放地址、封面图、作者信息、互动数据等
1188
- >
1189
- > # [English]
1190
- > ### Purpose:
1191
- > - Get full detail data of a video note
1192
- > ### Parameters:
1193
- > - note_id: Note ID, e.g. "697c0eee000000000a03c308"
1194
- > - share_text: Xiaohongshu sharing link (support APP and Web sharing link)
1195
- > - Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.
1196
- > ### Return:
1197
- > - Video note detail data, including video play URL, cover image, author info, interaction data, etc.
1198
- >
1199
- > # [示例/Example]
1200
- > note_id="697c0eee000000000a03c308"
1201
-
1202
- #### Parameters
1203
-
1204
- | Field | In | Type | Required | Description | Default | Example | Enum |
1205
- | --- | --- | --- | --- | --- | --- | --- | --- |
1206
- | note_id | query | string | No | 笔记ID/Note ID | None | 697c0eee000000000a03c308 | None |
1207
- | share_text | query | string | No | 分享链接/Share link | None | http://xhslink.com/o/8GqargIxrko | None |
1208
-
1209
- #### Request Body
1210
-
1211
- None
1212
-
1213
- #### Success Response
1214
-
1215
- ##### `200 application/json`
1216
-
1217
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1218
-
1219
- | Field | Type | Required | Description | Default | Example | Enum |
1220
- | --- | --- | --- | --- | --- | --- | --- |
1221
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1222
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1223
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1224
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1225
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1226
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1227
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1228
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1229
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1230
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1231
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1232
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1233
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1234
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1235
- | data | null | No | The response data \| 响应数据 | None | None | None |
1236
-
1237
- <a id="get-api-u1-v1-xiaohongshu-app-v2-search-groups"></a>
1238
- ### `GET /api/u1/v1/xiaohongshu/app_v2/search_groups`
1239
-
1240
- - Summary: 搜索群聊/Search groups
1241
- - Capabilities: search
1242
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1243
- - operationId: `search_groups_api_v1_xiaohongshu_app_v2_search_groups_get`
1244
-
1245
- #### Notes
1246
-
1247
- > # [中文]
1248
- > ### 用途:
1249
- > - 根据关键词搜索小红书群聊列表,支持分页
1250
- > ### 参数:
1251
- > - keyword: 搜索关键词(必需),如 "上海"
1252
- > - page_no: 页码,从 0 开始
1253
- > - search_id: 搜索ID,翻页时传入首次搜索返回的值
1254
- > - source: 来源,默认 "unifiedSearchGroup"
1255
- > - is_recommend: 是否推荐,0=否, 1=是
1256
- > ### 返回:
1257
- > - 搜索结果数据,包含群聊列表和分页信息
1258
- > ### 翻页说明:
1259
- > - 首次请求:search_id 留空(自动生成),page_no 传 0
1260
- > - 翻页请求:传入首次搜索返回的 search_id,page_no 递增
1261
- >
1262
- > # [English]
1263
- > ### Purpose:
1264
- > - Search Xiaohongshu groups by keyword, supports pagination
1265
- > ### Parameters:
1266
- > - keyword: Search keyword (required), e.g. "上海"
1267
- > - page_no: Page number, start from 0
1268
- > - search_id: Search ID, pass value from first search response for pagination
1269
- > - source: Source, default "unifiedSearchGroup"
1270
- > - is_recommend: Is recommend, 0=no, 1=yes
1271
- > ### Return:
1272
- > - Search result data, including group list and pagination info
1273
- > ### Pagination Guide:
1274
- > - First request: leave search_id empty (auto-generated), page_no pass 0
1275
- > - Next page: pass search_id from first search response, increment page_no
1276
- >
1277
- > # [示例/Example]
1278
- > keyword="上海"
1279
- > page_no=0
1280
-
1281
- #### Parameters
1282
-
1283
- | Field | In | Type | Required | Description | Default | Example | Enum |
1284
- | --- | --- | --- | --- | --- | --- | --- | --- |
1285
- | keyword | query | string | Yes | 搜索关键词/Search keyword | None | 上海 | None |
1286
- | page_no | query | integer | No | 页码,从0开始/Page number, start from 0 | 0 | 0 | None |
1287
- | search_id | query | string | No | 搜索ID,翻页时传入首次搜索返回的值/Search ID for pagination | None | None | None |
1288
- | source | query | string | No | 来源/Source | unifiedSearchGroup | unifiedSearchGroup | None |
1289
- | is_recommend | query | integer | No | 是否推荐:0=否, 1=是/Is recommend: 0=no, 1=yes | 0 | 0 | None |
1290
-
1291
- #### Request Body
1292
-
1293
- None
1294
-
1295
- #### Success Response
1296
-
1297
- ##### `200 application/json`
1298
-
1299
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1300
-
1301
- | Field | Type | Required | Description | Default | Example | Enum |
1302
- | --- | --- | --- | --- | --- | --- | --- |
1303
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1304
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1305
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1306
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1307
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1308
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1309
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1310
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1311
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1312
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1313
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1314
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1315
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1316
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1317
- | data | null | No | The response data \| 响应数据 | None | None | None |
1318
-
1319
- <a id="get-api-u1-v1-xiaohongshu-app-v2-search-images"></a>
1320
- ### `GET /api/u1/v1/xiaohongshu/app_v2/search_images`
1321
-
1322
- - Summary: 搜索图片/Search images
1323
- - Capabilities: search
1324
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1325
- - operationId: `search_images_api_v1_xiaohongshu_app_v2_search_images_get`
1326
-
1327
- #### Notes
1328
-
1329
- > # [中文]
1330
- > ### 用途:
1331
- > - 根据关键词搜索小红书图片,每页返回 20 条结果,支持分页
1332
- > ### 参数:
1333
- > - keyword: 搜索关键词(必需),如 "壁纸"
1334
- > - page: 页码,从 1 开始
1335
- > - search_id: 搜索ID,翻页时传入首次搜索返回的值
1336
- > - search_session_id: 搜索会话ID,翻页时传入首次搜索返回的值
1337
- > - word_request_id: 词请求ID,翻页时传入首次搜索返回的值
1338
- > - source: 来源,默认 "explore_feed"
1339
- > ### 返回:
1340
- > - 搜索结果数据,包含图片列表和分页信息
1341
- > ### 翻页说明:
1342
- > - 首次请求:只传keyword和page
1343
- > - 翻页请求:传入首次搜索返回的 search_id、search_session_id 和 word_request_id
1344
- >
1345
- > # [English]
1346
- > ### Purpose:
1347
- > - Search Xiaohongshu images by keyword, returns 20 results per page, supports pagination
1348
- > ### Parameters:
1349
- > - keyword: Search keyword (required), e.g. "壁纸"
1350
- > - page: Page number, start from 1
1351
- > - search_id: Search ID, pass value from first search response for pagination
1352
- > - search_session_id: Search session ID, pass value from first search response for pagination
1353
- > - word_request_id: Word request ID, pass value from first search response for pagination
1354
- > - source: Source, default "explore_feed"
1355
- > ### Return:
1356
- > - Search result data, including image list and pagination info
1357
- > ### Pagination Guide:
1358
- > - First request: only pass keyword and page
1359
- > - Next page: pass search_id, search_session_id, and word_request_id from first search response
1360
- >
1361
- > # [示例/Example]
1362
- > keyword="壁纸"
1363
- > page=1
1364
-
1365
- #### Parameters
1366
-
1367
- | Field | In | Type | Required | Description | Default | Example | Enum |
1368
- | --- | --- | --- | --- | --- | --- | --- | --- |
1369
- | keyword | query | string | Yes | 搜索关键词/Search keyword | None | 壁纸 | None |
1370
- | page | query | integer | No | 页码,从1开始/Page number, start from 1 | 1 | 1 | None |
1371
- | search_id | query | string | No | 搜索ID,翻页时传入首次搜索返回的值/Search ID for pagination | None | None | None |
1372
- | search_session_id | query | string | No | 搜索会话ID,翻页时传入首次搜索返回的值/Search session ID for pagination | None | None | None |
1373
- | word_request_id | query | string | No | 词请求ID,翻页时传入首次搜索返回的值/Word request ID for pagination | None | None | None |
1374
- | source | query | string | No | 来源/Source | explore_feed | explore_feed | None |
1375
-
1376
- #### Request Body
1377
-
1378
- None
1379
-
1380
- #### Success Response
1381
-
1382
- ##### `200 application/json`
1383
-
1384
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1385
-
1386
- | Field | Type | Required | Description | Default | Example | Enum |
1387
- | --- | --- | --- | --- | --- | --- | --- |
1388
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1389
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1390
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1391
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1392
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1393
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1394
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1395
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1396
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1397
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1398
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1399
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1400
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1401
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1402
- | data | null | No | The response data \| 响应数据 | None | None | None |
1403
-
1404
- <a id="get-api-u1-v1-xiaohongshu-app-v2-search-notes"></a>
1405
- ### `GET /api/u1/v1/xiaohongshu/app_v2/search_notes`
1406
-
1407
- - Summary: 搜索笔记/Search notes
1408
- - Capabilities: search / content details
1409
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1410
- - operationId: `search_notes_api_v1_xiaohongshu_app_v2_search_notes_get`
1411
-
1412
- #### Notes
1413
-
1414
- > # [中文]
1415
- > ### 用途:
1416
- > - 根据关键词搜索小红书笔记,支持多种排序方式、笔记类型筛选和发布时间筛选
1417
- > ### 参数:
1418
- > - keyword: 搜索关键词(必需),如 "美食推荐"
1419
- > - page: 页码,从 1 开始
1420
- > - sort_type: 排序方式
1421
- > - "general": 综合排序(默认)
1422
- > - "time_descending": 按时间倒序(最新)
1423
- > - "popularity_descending": 按点赞数排序(最多点赞)
1424
- > - "comment_descending": 按评论数排序(最多评论)
1425
- > - "collect_descending": 按收藏数排序(最多收藏)
1426
- > - "english_preferred": 英文优先
1427
- > - note_type: 笔记类型筛选
1428
- > - "不限": 所有类型(默认)
1429
- > - "视频笔记": 仅视频
1430
- > - "普通笔记": 仅图文
1431
- > - "直播笔记": 仅直播
1432
- > - time_filter: 发布时间筛选
1433
- > - "不限": 所有时间(默认)
1434
- > - "一天内": 24小时内
1435
- > - "一周内": 7天内
1436
- > - "半年内": 6个月内
1437
- > - search_id: 搜索ID,翻页时传入首次搜索返回的值
1438
- > - search_session_id: 搜索会话ID,翻页时传入首次搜索返回的值
1439
- > - source: 来源,默认 "explore_feed"
1440
- > - ai_mode: AI模式,0=关闭, 1=开启
1441
- > ### 返回:
1442
- > - 搜索结果数据,包含笔记列表和分页信息
1443
- > ### 翻页说明:
1444
- > - 首次请求:只传keyword和page
1445
- > - 翻页请求:传入首次搜索返回的 search_id 和 search_session_id
1446
- >
1447
- > # [English]
1448
- > ### Purpose:
1449
- > - Search Xiaohongshu notes by keyword, supports multiple sort types, note type filters, and time filters
1450
- > ### Parameters:
1451
- > - keyword: Search keyword (required), e.g. "美食推荐"
1452
- > - page: Page number, start from 1
1453
- > - sort_type: Sort type
1454
- > - "general": General sort (default)
1455
- > - "time_descending": Sort by time descending (latest)
1456
- > - "popularity_descending": Sort by like count (most liked)
1457
- > - "comment_descending": Sort by comment count (most commented)
1458
- > - "collect_descending": Sort by collect count (most collected)
1459
- > - "english_preferred": English preferred
1460
- > - note_type: Note type filter
1461
- > - "不限": All types (default)
1462
- > - "视频笔记": Video notes only
1463
- > - "普通笔记": Image notes only
1464
- > - "直播笔记": Live notes only
1465
- > - time_filter: Time filter
1466
- > - "不限": All time (default)
1467
- > - "一天内": Within 24 hours
1468
- > - "一周内": Within 7 days
1469
- > - "半年内": Within 6 months
1470
- > - search_id: Search ID, pass value from first search response for pagination
1471
- > - search_session_id: Search session ID, pass value from first search response for pagination
1472
- > - source: Source, default "explore_feed"
1473
- > - ai_mode: AI mode, 0=off, 1=on
1474
- > ### Return:
1475
- > - Search result data, including note list and pagination info
1476
- > ### Pagination Guide:
1477
- > - First request: only pass keyword and page
1478
- > - Next page: pass search_id and search_session_id from first search response
1479
- >
1480
- > # [示例/Example]
1481
- > keyword="美食推荐"
1482
- > page=1
1483
- > sort_type="general"
1484
-
1485
- #### Parameters
1486
-
1487
- | Field | In | Type | Required | Description | Default | Example | Enum |
1488
- | --- | --- | --- | --- | --- | --- | --- | --- |
1489
- | keyword | query | string | Yes | 搜索关键词/Search keyword | None | 美食推荐 | None |
1490
- | page | query | integer | No | 页码,从1开始/Page number, start from 1 | 1 | 1 | None |
1491
- | sort_type | query | string | No | 排序方式/Sort type | general | general | None |
1492
- | note_type | query | string | No | 笔记类型/Note type: 不限, 视频笔记, 普通笔记, 直播笔记 | 不限 | 不限 | None |
1493
- | time_filter | query | string | No | 发布时间筛选/Time filter: 不限, 一天内, 一周内, 半年内 | 不限 | 不限 | None |
1494
- | search_id | query | string | No | 搜索ID,翻页时传入首次搜索返回的值/Search ID for pagination | None | None | None |
1495
- | search_session_id | query | string | No | 搜索会话ID,翻页时传入首次搜索返回的值/Search session ID for pagination | None | None | None |
1496
- | source | query | string | No | 来源/Source | explore_feed | explore_feed | None |
1497
- | ai_mode | query | integer | No | AI模式:0=关闭, 1=开启/AI mode: 0=off, 1=on | 0 | 0 | None |
1498
-
1499
- #### Request Body
1500
-
1501
- None
1502
-
1503
- #### Success Response
1504
-
1505
- ##### `200 application/json`
1506
-
1507
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1508
-
1509
- | Field | Type | Required | Description | Default | Example | Enum |
1510
- | --- | --- | --- | --- | --- | --- | --- |
1511
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1512
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1513
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1514
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1515
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1516
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1517
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1518
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1519
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1520
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1521
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1522
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1523
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1524
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1525
- | data | null | No | The response data \| 响应数据 | None | None | None |
1526
-
1527
- <a id="get-api-u1-v1-xiaohongshu-app-v2-search-products"></a>
1528
- ### `GET /api/u1/v1/xiaohongshu/app_v2/search_products`
1529
-
1530
- - Summary: 搜索商品/Search products
1531
- - Capabilities: search / commerce
1532
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1533
- - operationId: `search_products_api_v1_xiaohongshu_app_v2_search_products_get`
1534
-
1535
- #### Notes
1536
-
1537
- > # [中文]
1538
- > ### 用途:
1539
- > - 根据关键词搜索小红书商品,每页返回 20 条结果,支持分页
1540
- > ### 参数:
1541
- > - keyword: 搜索关键词(必需),如 "手机壳"
1542
- > - page: 页码,从 1 开始
1543
- > - search_id: 搜索ID,翻页时传入首次搜索返回的值
1544
- > - source: 来源,默认 "explore_feed"
1545
- > ### 返回:
1546
- > - 搜索结果数据,包含商品列表和分页信息
1547
- > ### 翻页说明:
1548
- > - 首次请求:只传keyword和page
1549
- > - 翻页请求:传入首次搜索返回的 search_id
1550
- >
1551
- > # [English]
1552
- > ### Purpose:
1553
- > - Search Xiaohongshu products by keyword, returns 20 results per page, supports pagination
1554
- > ### Parameters:
1555
- > - keyword: Search keyword (required), e.g. "手机壳"
1556
- > - page: Page number, start from 1
1557
- > - search_id: Search ID, pass value from first search response for pagination
1558
- > - source: Source, default "explore_feed"
1559
- > ### Return:
1560
- > - Search result data, including product list and pagination info
1561
- > ### Pagination Guide:
1562
- > - First request: only pass keyword and page
1563
- > - Next page: pass search_id from first search response
1564
- >
1565
- > # [示例/Example]
1566
- > keyword="手机壳"
1567
- > page=1
1568
-
1569
- #### Parameters
1570
-
1571
- | Field | In | Type | Required | Description | Default | Example | Enum |
1572
- | --- | --- | --- | --- | --- | --- | --- | --- |
1573
- | keyword | query | string | Yes | 搜索关键词/Search keyword | None | 手机壳 | None |
1574
- | page | query | integer | No | 页码,从1开始/Page number, start from 1 | 1 | 1 | None |
1575
- | search_id | query | string | No | 搜索ID,翻页时传入首次搜索返回的值/Search ID for pagination | None | None | None |
1576
- | source | query | string | No | 来源/Source | explore_feed | explore_feed | None |
1577
-
1578
- #### Request Body
1579
-
1580
- None
1581
-
1582
- #### Success Response
1583
-
1584
- ##### `200 application/json`
1585
-
1586
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1587
-
1588
- | Field | Type | Required | Description | Default | Example | Enum |
1589
- | --- | --- | --- | --- | --- | --- | --- |
1590
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1591
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1592
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1593
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1594
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1595
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1596
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1597
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1598
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1599
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1600
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1601
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1602
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1603
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1604
- | data | null | No | The response data \| 响应数据 | None | None | None |
1605
-
1606
- <a id="get-api-u1-v1-xiaohongshu-app-v2-search-users"></a>
1607
- ### `GET /api/u1/v1/xiaohongshu/app_v2/search_users`
1608
-
1609
- - Summary: 搜索用户/Search users
1610
- - Capabilities: search / profiles / accounts
1611
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1612
- - operationId: `search_users_api_v1_xiaohongshu_app_v2_search_users_get`
1613
-
1614
- #### Notes
1615
-
1616
- > # [中文]
1617
- > ### 用途:
1618
- > - 根据关键词搜索小红书用户,每页返回 20 条结果,支持分页
1619
- > ### 参数:
1620
- > - keyword: 搜索关键词(必需),如 "美食博主"
1621
- > - page: 页码,从 1 开始
1622
- > - search_id: 搜索ID,翻页时传入首次搜索返回的值
1623
- > - source: 来源,默认 "explore_feed"
1624
- > ### 返回:
1625
- > - 搜索结果数据,包含用户列表和分页信息
1626
- > ### 翻页说明:
1627
- > - 首次请求:只传keyword和page
1628
- > - 翻页请求:传入首次搜索返回的 search_id
1629
- >
1630
- > # [English]
1631
- > ### Purpose:
1632
- > - Search Xiaohongshu users by keyword, returns 20 results per page, supports pagination
1633
- > ### Parameters:
1634
- > - keyword: Search keyword (required), e.g. "美食博主"
1635
- > - page: Page number, start from 1
1636
- > - search_id: Search ID, pass value from first search response for pagination
1637
- > - source: Source, default "explore_feed"
1638
- > ### Return:
1639
- > - Search result data, including user list and pagination info
1640
- > ### Pagination Guide:
1641
- > - First request: only pass keyword and page
1642
- > - Next page: pass search_id from first search response
1643
- >
1644
- > # [示例/Example]
1645
- > keyword="美食博主"
1646
- > page=1
1647
-
1648
- #### Parameters
1649
-
1650
- | Field | In | Type | Required | Description | Default | Example | Enum |
1651
- | --- | --- | --- | --- | --- | --- | --- | --- |
1652
- | keyword | query | string | Yes | 搜索关键词/Search keyword | None | 美食博主 | None |
1653
- | page | query | integer | No | 页码,从1开始/Page number, start from 1 | 1 | 1 | None |
1654
- | search_id | query | string | No | 搜索ID,翻页时传入首次搜索返回的值/Search ID for pagination | None | None | None |
1655
- | source | query | string | No | 来源/Source | explore_feed | explore_feed | None |
1656
-
1657
- #### Request Body
1658
-
1659
- None
1660
-
1661
- #### Success Response
1662
-
1663
- ##### `200 application/json`
1664
-
1665
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1666
-
1667
- | Field | Type | Required | Description | Default | Example | Enum |
1668
- | --- | --- | --- | --- | --- | --- | --- |
1669
- | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1670
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1671
- | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1672
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1673
- | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1674
- | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1675
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1676
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1677
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1678
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1679
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1680
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1681
- | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1682
- | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1683
- | data | null | No | The response data \| 响应数据 | None | None | None |