@tikomni/skills 0.1.0
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.
- package/.skill-package-allowlist.txt +4 -0
- package/LICENSE +21 -0
- package/README.md +167 -0
- package/README.zh-CN.md +167 -0
- package/bin/tikomni-skills.js +127 -0
- package/env.example +160 -0
- package/lib/installer.js +176 -0
- package/package.json +44 -0
- package/skills/creator-analysis/SKILL.md +71 -0
- package/skills/creator-analysis/agents/openai.yaml +4 -0
- package/skills/creator-analysis/env.example +36 -0
- package/skills/creator-analysis/references/api-capability-index.md +92 -0
- package/skills/creator-analysis/references/api-contracts/asr-api.md +130 -0
- package/skills/creator-analysis/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/creator-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/creator-analysis/references/api-contracts/demo-api.md +717 -0
- package/skills/creator-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/creator-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/creator-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/creator-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/creator-analysis/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/creator-analysis/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/creator-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/creator-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/creator-analysis/references/api-contracts/health-check.md +69 -0
- package/skills/creator-analysis/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/creator-analysis/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/creator-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/creator-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/creator-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/creator-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/creator-analysis/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/creator-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/creator-analysis/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/creator-analysis/references/api-contracts/sora2-api.md +2266 -0
- package/skills/creator-analysis/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/creator-analysis/references/api-contracts/threads-web-api.md +897 -0
- package/skills/creator-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/creator-analysis/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/creator-analysis/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/creator-analysis/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/creator-analysis/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/creator-analysis/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/creator-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/creator-analysis/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/creator-analysis/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/creator-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/creator-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/creator-analysis/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/creator-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/creator-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/creator-analysis/references/api-tags/asr-api.md +100 -0
- package/skills/creator-analysis/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/creator-analysis/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/creator-analysis/references/api-tags/demo-api.md +365 -0
- package/skills/creator-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/creator-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/creator-analysis/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/creator-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/creator-analysis/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/creator-analysis/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/creator-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/creator-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/creator-analysis/references/api-tags/health-check.md +40 -0
- package/skills/creator-analysis/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/creator-analysis/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/creator-analysis/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/creator-analysis/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/creator-analysis/references/api-tags/ios-shortcut.md +45 -0
- package/skills/creator-analysis/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/creator-analysis/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/creator-analysis/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/creator-analysis/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/creator-analysis/references/api-tags/media-ingest-api.md +112 -0
- package/skills/creator-analysis/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/creator-analysis/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/creator-analysis/references/api-tags/sora2-api.md +737 -0
- package/skills/creator-analysis/references/api-tags/temp-mail-api.md +136 -0
- package/skills/creator-analysis/references/api-tags/threads-web-api.md +472 -0
- package/skills/creator-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/creator-analysis/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/creator-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/creator-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/creator-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/creator-analysis/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/creator-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/creator-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/creator-analysis/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/creator-analysis/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/creator-analysis/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/creator-analysis/references/api-tags/twitter-web-api.md +562 -0
- package/skills/creator-analysis/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/creator-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/creator-analysis/references/api-tags/weibo-app-api.md +851 -0
- package/skills/creator-analysis/references/api-tags/weibo-web-api.md +470 -0
- package/skills/creator-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/creator-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/creator-analysis/references/api-tags/youtube-web-api.md +934 -0
- package/skills/creator-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/creator-analysis/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/creator-analysis/references/asr-orchestration.md +33 -0
- package/skills/creator-analysis/references/config-templates/defaults.yaml +60 -0
- package/skills/creator-analysis/references/contracts/creator-card-fields.md +23 -0
- package/skills/creator-analysis/references/contracts/work-card-fields.md +32 -0
- package/skills/creator-analysis/references/platform-guides/douyin.md +49 -0
- package/skills/creator-analysis/references/platform-guides/generic.md +46 -0
- package/skills/creator-analysis/references/platform-guides/xiaohongshu.md +54 -0
- package/skills/creator-analysis/references/prompt-contracts/asr-clean.md +28 -0
- package/skills/creator-analysis/references/prompt-contracts/author-analysis-v2.md +46 -0
- package/skills/creator-analysis/references/prompt-contracts/author-analysis.md +49 -0
- package/skills/creator-analysis/references/prompt-contracts/cta.md +24 -0
- package/skills/creator-analysis/references/prompt-contracts/hook.md +25 -0
- package/skills/creator-analysis/references/prompt-contracts/insight.md +47 -0
- package/skills/creator-analysis/references/prompt-contracts/sampled-work-batch-explanations.md +30 -0
- package/skills/creator-analysis/references/prompt-contracts/structure.md +25 -0
- package/skills/creator-analysis/references/prompt-contracts/style.md +27 -0
- package/skills/creator-analysis/references/prompt-contracts/summary.md +29 -0
- package/skills/creator-analysis/references/prompt-contracts/topic.md +29 -0
- package/skills/creator-analysis/references/schemas/author-analysis-input-v1.schema.json +325 -0
- package/skills/creator-analysis/references/schemas/author-analysis-v2.schema.json +158 -0
- package/skills/creator-analysis/references/schemas/sampled-work-batch-explanations.schema.json +41 -0
- package/skills/creator-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/creator-analysis/references/workflow.md +18 -0
- package/skills/creator-analysis/scripts/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/adapters/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/adapters/platform_adapters.py +299 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/author_analysis_v2_support.py +1122 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/prompt_first_analyzers.py +260 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/sampled_work_batch_explainer.py +260 -0
- package/skills/creator-analysis/scripts/author_home/asr/__init__.py +5 -0
- package/skills/creator-analysis/scripts/author_home/asr/home_asr.py +961 -0
- package/skills/creator-analysis/scripts/author_home/builders/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/builders/home_builders.py +149 -0
- package/skills/creator-analysis/scripts/author_home/collectors/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/collectors/homepage_collectors.py +636 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/run_author_analysis.py +491 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/work_analysis_artifacts.py +553 -0
- package/skills/creator-analysis/scripts/author_home/schema.py +417 -0
- package/skills/creator-analysis/scripts/core/__init__.py +0 -0
- package/skills/creator-analysis/scripts/core/analysis_pipeline.py +133 -0
- package/skills/creator-analysis/scripts/core/bootstrap_env.py +35 -0
- package/skills/creator-analysis/scripts/core/config_loader.py +418 -0
- package/skills/creator-analysis/scripts/core/extract_pipeline.py +173 -0
- package/skills/creator-analysis/scripts/core/progress_report.py +111 -0
- package/skills/creator-analysis/scripts/core/storage_router.py +253 -0
- package/skills/creator-analysis/scripts/core/tikomni_common.py +588 -0
- package/skills/creator-analysis/scripts/pipeline/__init__.py +0 -0
- package/skills/creator-analysis/scripts/pipeline/asr/__init__.py +0 -0
- package/skills/creator-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
- package/skills/creator-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
- package/skills/creator-analysis/scripts/platform/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/douyin/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
- package/skills/creator-analysis/scripts/platform/douyin/run_douyin_single_video.py +1208 -0
- package/skills/creator-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
- package/skills/creator-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2128 -0
- package/skills/creator-analysis/scripts/writers/__init__.py +0 -0
- package/skills/creator-analysis/scripts/writers/write_author_homepage_samples.py +106 -0
- package/skills/creator-analysis/scripts/writers/write_benchmark_card.py +1402 -0
- package/skills/meta-capability/SKILL.md +69 -0
- package/skills/meta-capability/agents/openai.yaml +4 -0
- package/skills/meta-capability/env.example +42 -0
- package/skills/meta-capability/references/api-capability-index.md +92 -0
- package/skills/meta-capability/references/api-contracts/asr-api.md +130 -0
- package/skills/meta-capability/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/meta-capability/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/meta-capability/references/api-contracts/demo-api.md +717 -0
- package/skills/meta-capability/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/meta-capability/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/meta-capability/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/meta-capability/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/meta-capability/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/meta-capability/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/meta-capability/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/meta-capability/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/meta-capability/references/api-contracts/health-check.md +69 -0
- package/skills/meta-capability/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/meta-capability/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/meta-capability/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/meta-capability/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/meta-capability/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/meta-capability/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/meta-capability/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/meta-capability/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/meta-capability/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/meta-capability/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/meta-capability/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/meta-capability/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/meta-capability/references/api-contracts/sora2-api.md +2266 -0
- package/skills/meta-capability/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/meta-capability/references/api-contracts/threads-web-api.md +897 -0
- package/skills/meta-capability/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/meta-capability/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/meta-capability/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/meta-capability/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/meta-capability/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/meta-capability/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/meta-capability/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/meta-capability/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/meta-capability/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/meta-capability/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/meta-capability/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/meta-capability/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/meta-capability/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/meta-capability/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/meta-capability/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/meta-capability/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/meta-capability/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/meta-capability/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/meta-capability/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/meta-capability/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/meta-capability/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/meta-capability/references/api-tags/asr-api.md +100 -0
- package/skills/meta-capability/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/meta-capability/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/meta-capability/references/api-tags/demo-api.md +365 -0
- package/skills/meta-capability/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/meta-capability/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/meta-capability/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/meta-capability/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/meta-capability/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/meta-capability/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/meta-capability/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/meta-capability/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/meta-capability/references/api-tags/health-check.md +40 -0
- package/skills/meta-capability/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/meta-capability/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/meta-capability/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/meta-capability/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/meta-capability/references/api-tags/ios-shortcut.md +45 -0
- package/skills/meta-capability/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/meta-capability/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/meta-capability/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/meta-capability/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/meta-capability/references/api-tags/media-ingest-api.md +112 -0
- package/skills/meta-capability/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/meta-capability/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/meta-capability/references/api-tags/sora2-api.md +737 -0
- package/skills/meta-capability/references/api-tags/temp-mail-api.md +136 -0
- package/skills/meta-capability/references/api-tags/threads-web-api.md +472 -0
- package/skills/meta-capability/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/meta-capability/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/meta-capability/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/meta-capability/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/meta-capability/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/meta-capability/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/meta-capability/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/meta-capability/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/meta-capability/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/meta-capability/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/meta-capability/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/meta-capability/references/api-tags/twitter-web-api.md +562 -0
- package/skills/meta-capability/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/meta-capability/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/meta-capability/references/api-tags/weibo-app-api.md +851 -0
- package/skills/meta-capability/references/api-tags/weibo-web-api.md +470 -0
- package/skills/meta-capability/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/meta-capability/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/meta-capability/references/api-tags/youtube-web-api.md +934 -0
- package/skills/meta-capability/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/meta-capability/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/meta-capability/references/config-templates/defaults.yaml +18 -0
- package/skills/meta-capability/references/dispatch.md +27 -0
- package/skills/meta-capability/references/execution-guidelines.md +25 -0
- package/skills/meta-capability/references/implemented-route-map.md +177 -0
- package/skills/meta-capability/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/meta-capability/scripts/__init__.py +1 -0
- package/skills/meta-capability/scripts/call_route.py +141 -0
- package/skills/meta-capability/scripts/core/__init__.py +1 -0
- package/skills/meta-capability/scripts/core/bootstrap_env.py +32 -0
- package/skills/meta-capability/scripts/core/config_loader.py +204 -0
- package/skills/meta-capability/scripts/core/tikomni_common.py +443 -0
- package/skills/meta-capability/scripts/test_auth.py +98 -0
- package/skills/single-work-analysis/SKILL.md +62 -0
- package/skills/single-work-analysis/agents/openai.yaml +4 -0
- package/skills/single-work-analysis/env.example +36 -0
- package/skills/single-work-analysis/references/api-capability-index.md +92 -0
- package/skills/single-work-analysis/references/api-contracts/asr-api.md +130 -0
- package/skills/single-work-analysis/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/single-work-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/single-work-analysis/references/api-contracts/demo-api.md +717 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/single-work-analysis/references/api-contracts/health-check.md +69 -0
- package/skills/single-work-analysis/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/single-work-analysis/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/single-work-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/single-work-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/single-work-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/single-work-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/single-work-analysis/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/single-work-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/single-work-analysis/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/single-work-analysis/references/api-contracts/sora2-api.md +2266 -0
- package/skills/single-work-analysis/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/single-work-analysis/references/api-contracts/threads-web-api.md +897 -0
- package/skills/single-work-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/single-work-analysis/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/single-work-analysis/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/single-work-analysis/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/single-work-analysis/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/single-work-analysis/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/single-work-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/single-work-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/single-work-analysis/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/single-work-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/single-work-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/single-work-analysis/references/api-tags/asr-api.md +100 -0
- package/skills/single-work-analysis/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/single-work-analysis/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/single-work-analysis/references/api-tags/demo-api.md +365 -0
- package/skills/single-work-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/single-work-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/single-work-analysis/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/single-work-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/single-work-analysis/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/single-work-analysis/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/single-work-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/single-work-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/single-work-analysis/references/api-tags/health-check.md +40 -0
- package/skills/single-work-analysis/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/single-work-analysis/references/api-tags/ios-shortcut.md +45 -0
- package/skills/single-work-analysis/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/single-work-analysis/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/single-work-analysis/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/single-work-analysis/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/single-work-analysis/references/api-tags/media-ingest-api.md +112 -0
- package/skills/single-work-analysis/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/single-work-analysis/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/single-work-analysis/references/api-tags/sora2-api.md +737 -0
- package/skills/single-work-analysis/references/api-tags/temp-mail-api.md +136 -0
- package/skills/single-work-analysis/references/api-tags/threads-web-api.md +472 -0
- package/skills/single-work-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/single-work-analysis/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/single-work-analysis/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/single-work-analysis/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/single-work-analysis/references/api-tags/twitter-web-api.md +562 -0
- package/skills/single-work-analysis/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/single-work-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/single-work-analysis/references/api-tags/weibo-app-api.md +851 -0
- package/skills/single-work-analysis/references/api-tags/weibo-web-api.md +470 -0
- package/skills/single-work-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/single-work-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/single-work-analysis/references/api-tags/youtube-web-api.md +934 -0
- package/skills/single-work-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/single-work-analysis/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/single-work-analysis/references/asr-and-fallback.md +20 -0
- package/skills/single-work-analysis/references/config-templates/defaults.yaml +58 -0
- package/skills/single-work-analysis/references/contracts/work-card-fields.md +41 -0
- package/skills/single-work-analysis/references/platform-guides/douyin.md +47 -0
- package/skills/single-work-analysis/references/platform-guides/generic.md +43 -0
- package/skills/single-work-analysis/references/platform-guides/xiaohongshu.md +54 -0
- package/skills/single-work-analysis/references/prompt-contracts/asr-clean.md +28 -0
- package/skills/single-work-analysis/references/prompt-contracts/cta.md +24 -0
- package/skills/single-work-analysis/references/prompt-contracts/hook.md +25 -0
- package/skills/single-work-analysis/references/prompt-contracts/insight.md +47 -0
- package/skills/single-work-analysis/references/prompt-contracts/structure.md +25 -0
- package/skills/single-work-analysis/references/prompt-contracts/style.md +27 -0
- package/skills/single-work-analysis/references/prompt-contracts/summary.md +29 -0
- package/skills/single-work-analysis/references/prompt-contracts/topic.md +29 -0
- package/skills/single-work-analysis/references/schemas/work-card.schema.json +39 -0
- package/skills/single-work-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/single-work-analysis/scripts/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/core/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/core/analysis_pipeline.py +133 -0
- package/skills/single-work-analysis/scripts/core/bootstrap_env.py +35 -0
- package/skills/single-work-analysis/scripts/core/config_loader.py +418 -0
- package/skills/single-work-analysis/scripts/core/extract_pipeline.py +173 -0
- package/skills/single-work-analysis/scripts/core/progress_report.py +111 -0
- package/skills/single-work-analysis/scripts/core/storage_router.py +253 -0
- package/skills/single-work-analysis/scripts/core/tikomni_common.py +588 -0
- package/skills/single-work-analysis/scripts/pipeline/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
- package/skills/single-work-analysis/scripts/platform/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/douyin/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
- package/skills/single-work-analysis/scripts/platform/douyin/run_douyin_single_video.py +1233 -0
- package/skills/single-work-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
- package/skills/single-work-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2156 -0
- package/skills/single-work-analysis/scripts/writers/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/writers/write_benchmark_card.py +1402 -0
|
@@ -0,0 +1,1291 @@
|
|
|
1
|
+
# Xiaohongshu-App-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-api.md`](../api-tags/xiaohongshu-app-api.md)
|
|
5
|
+
- Current contract file: `api-contracts/xiaohongshu-app-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: `12`
|
|
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数据接口/Xiaohongshu-App-API data endpoints)** - 第二优先/Second choice
|
|
12
|
+
|
|
13
|
+
## Route Contracts
|
|
14
|
+
|
|
15
|
+
<a id="get-api-u1-v1-xiaohongshu-app-extract-share-info"></a>
|
|
16
|
+
### `GET /api/u1/v1/xiaohongshu/app/extract_share_info`
|
|
17
|
+
|
|
18
|
+
- Summary: 提取分享链接信息/Extract share link info
|
|
19
|
+
- Capabilities: general
|
|
20
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
21
|
+
- operationId: `extract_share_info_api_v1_xiaohongshu_app_extract_share_info_get`
|
|
22
|
+
|
|
23
|
+
#### Notes
|
|
24
|
+
|
|
25
|
+
> # [中文]
|
|
26
|
+
> ### 用途:
|
|
27
|
+
> - 从分享链接中提取笔记ID和xsec_token
|
|
28
|
+
> ### 参数:
|
|
29
|
+
> - share_link: 小红书分享链接,支持短链接和长链接
|
|
30
|
+
> ### 返回:
|
|
31
|
+
> - 提取的信息对象,包含:
|
|
32
|
+
> - note_id: 笔记ID
|
|
33
|
+
> - xsec_token: 安全令牌(如果URL中包含)
|
|
34
|
+
>
|
|
35
|
+
> ### 使用说明:
|
|
36
|
+
> - 支持短链接格式:https://xhslink.com/a/xxxxx
|
|
37
|
+
> - 支持长链接格式:
|
|
38
|
+
> - https://www.xiaohongshu.com/discovery/item/xxxxx
|
|
39
|
+
> - https://www.xiaohongshu.com/explore/xxxxx
|
|
40
|
+
> - 短链接会自动重定向获取真实链接
|
|
41
|
+
> - 提取的note_id可用于get_note_info接口
|
|
42
|
+
>
|
|
43
|
+
> # [English]
|
|
44
|
+
> ### Purpose:
|
|
45
|
+
> - Extract note ID and xsec_token from share link
|
|
46
|
+
> ### Parameters:
|
|
47
|
+
> - share_link: Xiaohongshu share link, support short and long links
|
|
48
|
+
> ### Return:
|
|
49
|
+
> - Extracted info object containing:
|
|
50
|
+
> - note_id: Note ID
|
|
51
|
+
> - xsec_token: Security token (if exists in URL)
|
|
52
|
+
>
|
|
53
|
+
> ### Usage Guide:
|
|
54
|
+
> - Supports short link format: https://xhslink.com/a/xxxxx
|
|
55
|
+
> - Supports long link formats:
|
|
56
|
+
> - https://www.xiaohongshu.com/discovery/item/xxxxx
|
|
57
|
+
> - https://www.xiaohongshu.com/explore/xxxxx
|
|
58
|
+
> - Short links will be auto-redirected to get real link
|
|
59
|
+
> - Extracted note_id can be used in get_note_info endpoint
|
|
60
|
+
>
|
|
61
|
+
> # [示例/Example]
|
|
62
|
+
> share_link="https://xhslink.com/a/EZ4M9TwMA6c3"
|
|
63
|
+
|
|
64
|
+
#### Parameters
|
|
65
|
+
|
|
66
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
67
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
68
|
+
| share_link | query | string | Yes | 分享链接/Share link | None | https://xhslink.com/a/EZ4M9TwMA6c3 | None |
|
|
69
|
+
|
|
70
|
+
#### Request Body
|
|
71
|
+
|
|
72
|
+
None
|
|
73
|
+
|
|
74
|
+
#### Success Response
|
|
75
|
+
|
|
76
|
+
##### `200 application/json`
|
|
77
|
+
|
|
78
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
79
|
+
|
|
80
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
81
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
82
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
83
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
84
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
85
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
86
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
87
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
88
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
89
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
90
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
91
|
+
| 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 |
|
|
92
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
93
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
94
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
95
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
96
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
97
|
+
|
|
98
|
+
<a id="get-api-u1-v1-xiaohongshu-app-get-note-comments"></a>
|
|
99
|
+
### `GET /api/u1/v1/xiaohongshu/app/get_note_comments`
|
|
100
|
+
|
|
101
|
+
- Summary: 获取笔记评论/Get note comments
|
|
102
|
+
- Capabilities: comments / content details
|
|
103
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
104
|
+
- operationId: `get_note_comments_api_v1_xiaohongshu_app_get_note_comments_get`
|
|
105
|
+
|
|
106
|
+
#### Notes
|
|
107
|
+
|
|
108
|
+
> # [中文]
|
|
109
|
+
> ### 用途:
|
|
110
|
+
> - 获取笔记的评论列表
|
|
111
|
+
> ### 参数:
|
|
112
|
+
> - note_id: 笔记ID(必需)
|
|
113
|
+
> - start: 翻页游标,从上一次请求的响应中获取,支持两种格式:
|
|
114
|
+
> 1. 简单格式: "682b0133000000001c03618d"
|
|
115
|
+
> 2. JSON格式: {"cursor":"682b0133000000001c03618d","index":2,"pageArea":"ALL"}
|
|
116
|
+
> - sort_strategy: 排序策略
|
|
117
|
+
> - 1: 默认排序(默认值)
|
|
118
|
+
> - 2: 按最新评论排序
|
|
119
|
+
> ### 返回:
|
|
120
|
+
> - 评论数据对象,包含:
|
|
121
|
+
> - comments: 评论列表数组,每个评论包含:
|
|
122
|
+
> - id: 评论ID
|
|
123
|
+
> - content: 评论内容
|
|
124
|
+
> - create_time: 创建时间戳
|
|
125
|
+
> - user_info: 评论者信息
|
|
126
|
+
> - user_id: 用户ID
|
|
127
|
+
> - nickname: 昵称
|
|
128
|
+
> - image: 头像URL
|
|
129
|
+
> - interact_info: 互动数据
|
|
130
|
+
> - liked_count: 点赞数
|
|
131
|
+
> - sub_comment_count: 子评论数量
|
|
132
|
+
> - sub_comment_cursor: 子评论翻页游标(如有子评论)
|
|
133
|
+
> - cursor: 翻页游标,用于获取下一页
|
|
134
|
+
> - has_more: 是否有更多数据(布尔值)
|
|
135
|
+
> - total: 总评论数
|
|
136
|
+
>
|
|
137
|
+
> ### 翻页说明:
|
|
138
|
+
> - 首次请求不传start参数
|
|
139
|
+
> - 获取下一页时,将上一次返回的cursor作为start参数传入
|
|
140
|
+
> - 当has_more为false时,表示没有更多数据
|
|
141
|
+
>
|
|
142
|
+
> # [English]
|
|
143
|
+
> ### Purpose:
|
|
144
|
+
> - Get note comments list
|
|
145
|
+
> ### Parameters:
|
|
146
|
+
> - note_id: Note ID (required)
|
|
147
|
+
> - start: Pagination cursor from previous response, supports two formats:
|
|
148
|
+
> 1. Simple format: "682b0133000000001c03618d"
|
|
149
|
+
> 2. JSON format: {"cursor":"682b0133000000001c03618d","index":2,"pageArea":"ALL"}
|
|
150
|
+
> - sort_strategy: Sort strategy
|
|
151
|
+
> - 1: Default sort (default)
|
|
152
|
+
> - 2: Sort by latest comments
|
|
153
|
+
> ### Return:
|
|
154
|
+
> - Comments data object containing:
|
|
155
|
+
> - comments: Comment list array, each comment includes:
|
|
156
|
+
> - id: Comment ID
|
|
157
|
+
> - content: Comment content
|
|
158
|
+
> - create_time: Creation timestamp
|
|
159
|
+
> - user_info: Commenter info
|
|
160
|
+
> - user_id: User ID
|
|
161
|
+
> - nickname: Nickname
|
|
162
|
+
> - image: Avatar URL
|
|
163
|
+
> - interact_info: Interaction data
|
|
164
|
+
> - liked_count: Like count
|
|
165
|
+
> - sub_comment_count: Sub-comment count
|
|
166
|
+
> - sub_comment_cursor: Sub-comment pagination cursor (if has sub-comments)
|
|
167
|
+
> - cursor: Pagination cursor for next page
|
|
168
|
+
> - has_more: Whether has more data (boolean)
|
|
169
|
+
> - total: Total comment count
|
|
170
|
+
>
|
|
171
|
+
> ### Pagination Guide:
|
|
172
|
+
> - Don't pass start parameter for first request
|
|
173
|
+
> - For next page, pass cursor from previous response as start parameter
|
|
174
|
+
> - When has_more is false, no more data available
|
|
175
|
+
>
|
|
176
|
+
> # [示例/Example]
|
|
177
|
+
> note_id="677d1909000000002002a892"
|
|
178
|
+
> sort_strategy=1
|
|
179
|
+
|
|
180
|
+
#### Parameters
|
|
181
|
+
|
|
182
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
183
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
184
|
+
| note_id | query | string | Yes | 笔记ID/Note ID | None | 677d1909000000002002a892 | None |
|
|
185
|
+
| start | query | string | No | 翻页游标/Pagination cursor | None | 682b0133000000001c03618d | None |
|
|
186
|
+
| sort_strategy | query | integer | No | 排序策略:1-默认排序,2-最新评论/Sort strategy: 1-default, 2-latest | 1 | 1 | None |
|
|
187
|
+
|
|
188
|
+
#### Request Body
|
|
189
|
+
|
|
190
|
+
None
|
|
191
|
+
|
|
192
|
+
#### Success Response
|
|
193
|
+
|
|
194
|
+
##### `200 application/json`
|
|
195
|
+
|
|
196
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
197
|
+
|
|
198
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
199
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
200
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
201
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
202
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
203
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
204
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
205
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
206
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
207
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
208
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
209
|
+
| 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 |
|
|
210
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
211
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
212
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
213
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
214
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
215
|
+
|
|
216
|
+
<a id="get-api-u1-v1-xiaohongshu-app-get-note-info"></a>
|
|
217
|
+
### `GET /api/u1/v1/xiaohongshu/app/get_note_info`
|
|
218
|
+
|
|
219
|
+
- Summary: 获取笔记信息 V1/Get note info V1
|
|
220
|
+
- Capabilities: content details
|
|
221
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
222
|
+
- operationId: `get_note_info_v1_api_v1_xiaohongshu_app_get_note_info_get`
|
|
223
|
+
|
|
224
|
+
#### Notes
|
|
225
|
+
|
|
226
|
+
> # [中文]
|
|
227
|
+
> ### 用途:
|
|
228
|
+
> - 获取笔记信息 V1
|
|
229
|
+
> ### 接口优先级:
|
|
230
|
+
> - 小红书接口推荐优先级: `App V2` > `App(本接口)` > `Web V2` > `Web`
|
|
231
|
+
> ### 参数:
|
|
232
|
+
> - note_id: 笔记ID,可以从小红书的分享链接中获取
|
|
233
|
+
> - share_text: 小红书分享链接(支持APP和Web端分享链接)
|
|
234
|
+
> - 优先使用`note_id`,如果没有则使用`share_text`,两个参数二选一,如都携带则以`note_id`为准。
|
|
235
|
+
> ### 返回:
|
|
236
|
+
> - 笔记详情数据,包含以下主要字段:
|
|
237
|
+
> - note_id: 笔记ID
|
|
238
|
+
> - title: 笔记标题
|
|
239
|
+
> - desc: 笔记内容描述
|
|
240
|
+
> - type: 笔记类型(normal=图文笔记,video=视频笔记)
|
|
241
|
+
> - user: 作者信息对象
|
|
242
|
+
> - user_id: 用户ID
|
|
243
|
+
> - nickname: 用户昵称
|
|
244
|
+
> - avatar: 用户头像URL
|
|
245
|
+
> - image_list: 图片列表(图文笔记)
|
|
246
|
+
> - video_info: 视频信息(视频笔记)
|
|
247
|
+
> - interact_info: 互动数据
|
|
248
|
+
> - liked_count: 点赞数
|
|
249
|
+
> - collected_count: 收藏数
|
|
250
|
+
> - comment_count: 评论数
|
|
251
|
+
> - share_count: 分享数
|
|
252
|
+
> - tag_list: 话题标签列表
|
|
253
|
+
> - time: 发布时间戳
|
|
254
|
+
> - ip_location: IP属地
|
|
255
|
+
>
|
|
256
|
+
> # [English]
|
|
257
|
+
> ### Purpose:
|
|
258
|
+
> - Get note info V1
|
|
259
|
+
> ### API Priority:
|
|
260
|
+
> - Xiaohongshu API priority: `App V2` > `App (this)` > `Web V2` > `Web`
|
|
261
|
+
> ### Parameters:
|
|
262
|
+
> - note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.
|
|
263
|
+
> - share_text: Xiaohongshu sharing link (support APP and Web sharing link)
|
|
264
|
+
> - 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.
|
|
265
|
+
> ### Return:
|
|
266
|
+
> - Note detail data with main fields:
|
|
267
|
+
> - note_id: Note ID
|
|
268
|
+
> - title: Note title
|
|
269
|
+
> - desc: Note content description
|
|
270
|
+
> - type: Note type (normal=image note, video=video note)
|
|
271
|
+
> - user: Author info object
|
|
272
|
+
> - user_id: User ID
|
|
273
|
+
> - nickname: User nickname
|
|
274
|
+
> - avatar: User avatar URL
|
|
275
|
+
> - image_list: Image list (for image notes)
|
|
276
|
+
> - video_info: Video info (for video notes)
|
|
277
|
+
> - interact_info: Interaction data
|
|
278
|
+
> - liked_count: Like count
|
|
279
|
+
> - collected_count: Collect count
|
|
280
|
+
> - comment_count: Comment count
|
|
281
|
+
> - share_count: Share count
|
|
282
|
+
> - tag_list: Topic tag list
|
|
283
|
+
> - time: Publish timestamp
|
|
284
|
+
> - ip_location: IP location
|
|
285
|
+
>
|
|
286
|
+
> # [示例/Example]
|
|
287
|
+
> note_id="665f95200000000006005624"
|
|
288
|
+
|
|
289
|
+
#### Parameters
|
|
290
|
+
|
|
291
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
292
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
293
|
+
| note_id | query | string | No | 笔记ID/Note ID | None | 665f95200000000006005624 | None |
|
|
294
|
+
| share_text | query | string | No | 分享链接/Share link | None | https://xhslink.com/a/EZ4M9TwMA6c3 | None |
|
|
295
|
+
|
|
296
|
+
#### Request Body
|
|
297
|
+
|
|
298
|
+
None
|
|
299
|
+
|
|
300
|
+
#### Success Response
|
|
301
|
+
|
|
302
|
+
##### `200 application/json`
|
|
303
|
+
|
|
304
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
305
|
+
|
|
306
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
307
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
308
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
309
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
310
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
311
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
312
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
313
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
314
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
315
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
316
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
317
|
+
| 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 |
|
|
318
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
319
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
320
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
321
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
322
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
323
|
+
|
|
324
|
+
<a id="get-api-u1-v1-xiaohongshu-app-get-note-info-v2"></a>
|
|
325
|
+
### `GET /api/u1/v1/xiaohongshu/app/get_note_info_v2`
|
|
326
|
+
|
|
327
|
+
- Summary: 获取笔记信息 V2 (蒲公英商家后台)/Get note info V2 (Pugongying Business Backend)
|
|
328
|
+
- Capabilities: content details
|
|
329
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
330
|
+
- operationId: `get_note_info_v2_api_v1_xiaohongshu_app_get_note_info_v2_get`
|
|
331
|
+
|
|
332
|
+
#### Notes
|
|
333
|
+
|
|
334
|
+
> # [中文]
|
|
335
|
+
> ### 用途:
|
|
336
|
+
> - 获取笔记信息 V2
|
|
337
|
+
> - 除赞、评、藏数据之外此接口能获取到笔记的曝光量(impNum)、阅读量(readNum)、关注量(followCnt)。
|
|
338
|
+
> - 但是不是每一篇都有,如果是没有被小红书后台收录的笔记,赞评藏数据返回为0,但是笔记内容是完整的。
|
|
339
|
+
> - 通过作者userId,可以去作品列表接口拿到赞、评、藏数据
|
|
340
|
+
> ### 参数:
|
|
341
|
+
> - note_id: 笔记ID,可以从小红书的分享链接中获取
|
|
342
|
+
> - share_text: 小红书分享链接(支持APP和Web端分享链接)
|
|
343
|
+
> - 优先使用`note_id`,如果没有则使用`share_text`,两个参数二选一,如都携带则以`note_id`为准。
|
|
344
|
+
> ### 返回:
|
|
345
|
+
> - 笔记详情数据,包含以下主要字段:
|
|
346
|
+
> - note_id: 笔记ID
|
|
347
|
+
> - title: 笔记标题
|
|
348
|
+
> - desc: 笔记内容描述
|
|
349
|
+
> - type: 笔记类型(normal=图文笔记,video=视频笔记)
|
|
350
|
+
> - user: 作者信息对象
|
|
351
|
+
> - user_id: 用户ID
|
|
352
|
+
> - nickname: 用户昵称
|
|
353
|
+
> - avatar: 用户头像URL
|
|
354
|
+
> - image_list: 图片列表(图文笔记)
|
|
355
|
+
> - video_info: 视频信息(视频笔记)
|
|
356
|
+
> - interact_info: 互动数据
|
|
357
|
+
> - liked_count: 点赞数
|
|
358
|
+
> - collected_count: 收藏数
|
|
359
|
+
> - comment_count: 评论数
|
|
360
|
+
> - share_count: 分享数
|
|
361
|
+
> - tag_list: 话题标签列表
|
|
362
|
+
> - time: 发布时间戳
|
|
363
|
+
> - ip_location: IP属地
|
|
364
|
+
>
|
|
365
|
+
> # [English]
|
|
366
|
+
> ### Purpose:
|
|
367
|
+
> - Get note info V2
|
|
368
|
+
> - This interface can get note exposure (impNum), read count (readNum), and follow count (followCnt) in addition to like, comment, and collect data.
|
|
369
|
+
> - However, not every note has this data. If the note is not indexed by Xiaohongshu backend, like, comment, and collect data will return 0, but the note content is complete.
|
|
370
|
+
> - You can get like, comment, and collect data from the note list interface using the author's userId.
|
|
371
|
+
> ### Parameters:
|
|
372
|
+
> - note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.
|
|
373
|
+
> - share_text: Xiaohongshu sharing link (support APP and Web sharing link)
|
|
374
|
+
> - 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.
|
|
375
|
+
> ### Return:
|
|
376
|
+
> - Note detail data with main fields:
|
|
377
|
+
> - note_id: Note ID
|
|
378
|
+
> - title: Note title
|
|
379
|
+
> - desc: Note content description
|
|
380
|
+
> - type: Note type (normal=image note, video=video note)
|
|
381
|
+
> - user: Author info object
|
|
382
|
+
> - user_id: User ID
|
|
383
|
+
> - nickname: User nickname
|
|
384
|
+
> - avatar: User avatar URL
|
|
385
|
+
> - image_list: Image list (for image notes)
|
|
386
|
+
> - video_info: Video info (for video notes)
|
|
387
|
+
> - interact_info: Interaction data
|
|
388
|
+
> - liked_count: Like count
|
|
389
|
+
> - collected_count: Collect count
|
|
390
|
+
> - comment_count: Comment count
|
|
391
|
+
> - share_count: Share count
|
|
392
|
+
> - tag_list: Topic tag list
|
|
393
|
+
> - time: Publish timestamp
|
|
394
|
+
> - ip_location: IP location
|
|
395
|
+
>
|
|
396
|
+
> # [示例/Example]
|
|
397
|
+
> note_id="665f95200000000006005624"
|
|
398
|
+
|
|
399
|
+
#### Parameters
|
|
400
|
+
|
|
401
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
402
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
403
|
+
| note_id | query | string | No | 笔记ID/Note ID | None | 665f95200000000006005624 | None |
|
|
404
|
+
| share_text | query | string | No | 分享链接/Share link | None | https://xhslink.com/a/EZ4M9TwMA6c3 | None |
|
|
405
|
+
|
|
406
|
+
#### Request Body
|
|
407
|
+
|
|
408
|
+
None
|
|
409
|
+
|
|
410
|
+
#### Success Response
|
|
411
|
+
|
|
412
|
+
##### `200 application/json`
|
|
413
|
+
|
|
414
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
415
|
+
|
|
416
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
417
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
418
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
419
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
420
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
421
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
422
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
423
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
424
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
425
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
426
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
427
|
+
| 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 |
|
|
428
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
429
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
430
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
431
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
432
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
433
|
+
|
|
434
|
+
<a id="get-api-u1-v1-xiaohongshu-app-get-notes-by-topic"></a>
|
|
435
|
+
### `GET /api/u1/v1/xiaohongshu/app/get_notes_by_topic`
|
|
436
|
+
|
|
437
|
+
- Summary: [已弃用/Deprecated] 根据话题标签获取作品/Get notes by topic
|
|
438
|
+
- Capabilities: content details / topics
|
|
439
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
440
|
+
- operationId: `get_notes_by_topic_api_v1_xiaohongshu_app_get_notes_by_topic_get`
|
|
441
|
+
|
|
442
|
+
#### Notes
|
|
443
|
+
|
|
444
|
+
> # [中文]
|
|
445
|
+
> ## ⚠️ 此接口已弃用,不再维护,可能无法正常使用。
|
|
446
|
+
> ### 用途:
|
|
447
|
+
> - 根据话题标签获取相关笔记
|
|
448
|
+
> ### 参数:
|
|
449
|
+
> - page_id: 话题标签ID(必需)
|
|
450
|
+
> - first_load_time: 首次请求的时间戳,毫秒级时间戳(必需)
|
|
451
|
+
> - 例子: 1698647850000
|
|
452
|
+
> - Python获取当前时间戳: `int(time.time() * 1000)`
|
|
453
|
+
> - sort: 排序方式
|
|
454
|
+
> - "hot": 综合排序(默认)
|
|
455
|
+
> - "time": 最新发布
|
|
456
|
+
> - "trend": 最热门
|
|
457
|
+
> - session_id: 会话ID,首次不传,由服务端生成,翻页时传入
|
|
458
|
+
> - last_note_ct: 最后一条笔记的create_time字段,首次不传,翻页时传入
|
|
459
|
+
> - last_note_id: 最后一条笔记的ID,首次不传,翻页时传入
|
|
460
|
+
> - cursor_score: 最后一条笔记的cursor_score字段,首次不传,翻页时传入
|
|
461
|
+
> ### 返回:
|
|
462
|
+
> - 话题笔记数据,包含:
|
|
463
|
+
> - notes: 笔记列表数组,每个元素包含:
|
|
464
|
+
> - id: 元素ID
|
|
465
|
+
> - model_type: 模型类型(通常为"note")
|
|
466
|
+
> - note: 笔记详情对象
|
|
467
|
+
> - note_id: 笔记ID
|
|
468
|
+
> - title: 标题
|
|
469
|
+
> - desc: 描述
|
|
470
|
+
> - type: 类型(normal/video)
|
|
471
|
+
> - user: 作者信息
|
|
472
|
+
> - interact_info: 互动数据
|
|
473
|
+
> - cover: 封面图
|
|
474
|
+
> - create_time: 创建时间戳
|
|
475
|
+
> - cursor_score: 游标分数(用于翻页)
|
|
476
|
+
> - session_id: 会话ID(翻页必需)
|
|
477
|
+
> - has_more: 是否有更多数据
|
|
478
|
+
>
|
|
479
|
+
> ### 翻页说明:
|
|
480
|
+
> - 首次请求:只传page_id和first_load_time
|
|
481
|
+
> - 翻页请求:需要传入
|
|
482
|
+
> 1. 上一次返回的session_id
|
|
483
|
+
> 2. 最后一条笔记的last_note_ct(create_time)
|
|
484
|
+
> 3. 最后一条笔记的last_note_id(id)
|
|
485
|
+
> 4. 最后一条笔记的cursor_score
|
|
486
|
+
>
|
|
487
|
+
> # [English]
|
|
488
|
+
> ## ⚠️ This endpoint is deprecated, no longer maintained, and may not work properly.
|
|
489
|
+
> ### Purpose:
|
|
490
|
+
> - Get notes by topic tag
|
|
491
|
+
> ### Parameters:
|
|
492
|
+
> - page_id: Topic tag ID (required)
|
|
493
|
+
> - first_load_time: First load timestamp in milliseconds (required)
|
|
494
|
+
> - Example: 1698647850000
|
|
495
|
+
> - Get current timestamp in Python: `int(time.time() * 1000)`
|
|
496
|
+
> - sort: Sort method
|
|
497
|
+
> - "hot": Comprehensive (default)
|
|
498
|
+
> - "time": Latest published
|
|
499
|
+
> - "trend": Trending
|
|
500
|
+
> - session_id: Session ID, not required for first request, use returned value for pagination
|
|
501
|
+
> - last_note_ct: Last note create_time field for pagination
|
|
502
|
+
> - last_note_id: Last note ID for pagination
|
|
503
|
+
> - cursor_score: Last note cursor_score field for pagination
|
|
504
|
+
> ### Return:
|
|
505
|
+
> - Topic notes data containing:
|
|
506
|
+
> - notes: Notes list array, each element includes:
|
|
507
|
+
> - id: Element ID
|
|
508
|
+
> - model_type: Model type (usually "note")
|
|
509
|
+
> - note: Note detail object
|
|
510
|
+
> - note_id: Note ID
|
|
511
|
+
> - title: Title
|
|
512
|
+
> - desc: Description
|
|
513
|
+
> - type: Type (normal/video)
|
|
514
|
+
> - user: Author info
|
|
515
|
+
> - interact_info: Interaction data
|
|
516
|
+
> - cover: Cover image
|
|
517
|
+
> - create_time: Creation timestamp
|
|
518
|
+
> - cursor_score: Cursor score (for pagination)
|
|
519
|
+
> - session_id: Session ID (required for pagination)
|
|
520
|
+
> - has_more: Whether has more data
|
|
521
|
+
>
|
|
522
|
+
> ### Pagination Guide:
|
|
523
|
+
> - First request: Only pass page_id and first_load_time
|
|
524
|
+
> - Next requests: Need to pass
|
|
525
|
+
> 1. session_id from previous response
|
|
526
|
+
> 2. last_note_ct (create_time of last note)
|
|
527
|
+
> 3. last_note_id (id of last note)
|
|
528
|
+
> 4. cursor_score of last note
|
|
529
|
+
>
|
|
530
|
+
> # [示例/Example]
|
|
531
|
+
> page_id="5c014b045b29cb0001ead530"
|
|
532
|
+
> first_load_time="1698647850000"
|
|
533
|
+
> sort="hot"
|
|
534
|
+
|
|
535
|
+
#### Parameters
|
|
536
|
+
|
|
537
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
538
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
539
|
+
| page_id | query | string | Yes | 话题标签ID/Topic tag ID | None | 5c014b045b29cb0001ead530 | None |
|
|
540
|
+
| first_load_time | query | string | Yes | 首次请求时间戳(毫秒)/First load timestamp (ms) | None | 1698647850000 | None |
|
|
541
|
+
| sort | query | string | No | 排序方式:hot-综合,time-最新,trend-最热/Sort: hot-comprehensive, time-latest, trend-trending | hot | hot | None |
|
|
542
|
+
| session_id | query | string | No | 会话ID/Session ID | None | 989615e2-ce54-414a-9c7a-6c1e5e79c5f7 | None |
|
|
543
|
+
| last_note_ct | query | string | No | 最后一条笔记创建时间/Last note create time | None | 1698647850000 | None |
|
|
544
|
+
| last_note_id | query | string | No | 最后一条笔记ID/Last note ID | None | 653f4f2a0000000025017109 | None |
|
|
545
|
+
| cursor_score | query | string | No | 游标分数/Cursor score | None | rNqgDUXZhHqdL4z4kKah5Lw6P_OSU9_fgubmTsiop_s | None |
|
|
546
|
+
|
|
547
|
+
#### Request Body
|
|
548
|
+
|
|
549
|
+
None
|
|
550
|
+
|
|
551
|
+
#### Success Response
|
|
552
|
+
|
|
553
|
+
##### `200 application/json`
|
|
554
|
+
|
|
555
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
556
|
+
|
|
557
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
558
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
559
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
560
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
561
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
562
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
563
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
564
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
565
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
566
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
567
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
568
|
+
| 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 |
|
|
569
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
570
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
571
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
572
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
573
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
574
|
+
|
|
575
|
+
<a id="get-api-u1-v1-xiaohongshu-app-get-product-detail"></a>
|
|
576
|
+
### `GET /api/u1/v1/xiaohongshu/app/get_product_detail`
|
|
577
|
+
|
|
578
|
+
- Summary: 获取商品详情/Get product detail
|
|
579
|
+
- Capabilities: details / commerce
|
|
580
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
581
|
+
- operationId: `get_product_detail_api_v1_xiaohongshu_app_get_product_detail_get`
|
|
582
|
+
|
|
583
|
+
#### Notes
|
|
584
|
+
|
|
585
|
+
> # [中文]
|
|
586
|
+
> ### 用途:
|
|
587
|
+
> - 获取小红书商品详情信息
|
|
588
|
+
> ### 参数:
|
|
589
|
+
> - sku_id: 商品skuId(必需)
|
|
590
|
+
> ### 返回:
|
|
591
|
+
> - 商品详情数据
|
|
592
|
+
>
|
|
593
|
+
> # [English]
|
|
594
|
+
> ### Purpose:
|
|
595
|
+
> - Get Xiaohongshu product detail info
|
|
596
|
+
> ### Parameters:
|
|
597
|
+
> - sku_id: Product SKU ID (required)
|
|
598
|
+
> ### Return:
|
|
599
|
+
> - Product detail data
|
|
600
|
+
>
|
|
601
|
+
> # [示例/Example]
|
|
602
|
+
> sku_id="68be7cbc8c331700011f89d1"
|
|
603
|
+
|
|
604
|
+
#### Parameters
|
|
605
|
+
|
|
606
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
607
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
608
|
+
| sku_id | query | string | Yes | 商品skuId/Product SKU ID | None | 68be7cbc8c331700011f89d1 | None |
|
|
609
|
+
|
|
610
|
+
#### Request Body
|
|
611
|
+
|
|
612
|
+
None
|
|
613
|
+
|
|
614
|
+
#### Success Response
|
|
615
|
+
|
|
616
|
+
##### `200 application/json`
|
|
617
|
+
|
|
618
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
619
|
+
|
|
620
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
621
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
622
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
623
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
624
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
625
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
626
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
627
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
628
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
629
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
630
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
631
|
+
| 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 |
|
|
632
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
633
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
634
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
635
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
636
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
637
|
+
|
|
638
|
+
<a id="get-api-u1-v1-xiaohongshu-app-get-sub-comments"></a>
|
|
639
|
+
### `GET /api/u1/v1/xiaohongshu/app/get_sub_comments`
|
|
640
|
+
|
|
641
|
+
- Summary: 获取子评论/Get sub comments
|
|
642
|
+
- Capabilities: comments
|
|
643
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
644
|
+
- operationId: `get_sub_comments_api_v1_xiaohongshu_app_get_sub_comments_get`
|
|
645
|
+
|
|
646
|
+
#### Notes
|
|
647
|
+
|
|
648
|
+
> # [中文]
|
|
649
|
+
> ### 用途:
|
|
650
|
+
> - 获取评论的子评论(回复)列表
|
|
651
|
+
> ### 参数:
|
|
652
|
+
> - note_id: 笔记ID(必需)
|
|
653
|
+
> - comment_id: 一级评论ID,要查看哪条评论的子评论(必需)
|
|
654
|
+
> - start: 翻页游标,从上一次请求的响应中获取,从评论列表的最后一条子评论ID获取:
|
|
655
|
+
> 格式如下: "6806642d000000001f01991b"
|
|
656
|
+
> ### 返回:
|
|
657
|
+
> - 子评论列表数组,每个子评论包含:
|
|
658
|
+
> - id: 子评论ID
|
|
659
|
+
> - content: 评论内容
|
|
660
|
+
> - create_time: 创建时间戳
|
|
661
|
+
> - user_info: 评论者信息
|
|
662
|
+
> - user_id: 用户ID
|
|
663
|
+
> - nickname: 昵称
|
|
664
|
+
> - image: 头像URL
|
|
665
|
+
> - target_comment: 被回复的评论信息(如果是回复其他子评论)
|
|
666
|
+
> - id: 被回复评论ID
|
|
667
|
+
> - user_info: 被回复者信息
|
|
668
|
+
> - nickname: 被回复者昵称
|
|
669
|
+
>
|
|
670
|
+
> ### 翻页说明:
|
|
671
|
+
> - 首次请求不传start参数
|
|
672
|
+
> - 获取更多时,将上一次请求返回的最后一条子评论ID作为start参数
|
|
673
|
+
>
|
|
674
|
+
> # [English]
|
|
675
|
+
> ### Purpose:
|
|
676
|
+
> - Get sub comments (replies) list
|
|
677
|
+
> ### Parameters:
|
|
678
|
+
> - note_id: Note ID (required)
|
|
679
|
+
> - comment_id: Parent comment ID to get sub comments (required)
|
|
680
|
+
> - start: Pagination cursor from previous response, obtained from the last sub-comment ID in the comment list:
|
|
681
|
+
> Format: "6806642d000000001f01991b"
|
|
682
|
+
> ### Return:
|
|
683
|
+
> - Sub comments array list, each sub-comment includes:
|
|
684
|
+
> - id: Sub-comment ID
|
|
685
|
+
> - content: Comment content
|
|
686
|
+
> - create_time: Creation timestamp
|
|
687
|
+
> - user_info: Commenter info
|
|
688
|
+
> - user_id: User ID
|
|
689
|
+
> - nickname: Nickname
|
|
690
|
+
> - image: Avatar URL
|
|
691
|
+
> - target_comment: Replied comment info (if replying to other sub-comment)
|
|
692
|
+
> - id: Replied comment ID
|
|
693
|
+
> - user_info: Replied user info
|
|
694
|
+
> - nickname: Replied user nickname
|
|
695
|
+
>
|
|
696
|
+
> ### Pagination Guide:
|
|
697
|
+
> - Don't pass start parameter for first request
|
|
698
|
+
> - For more data, pass last sub-comment ID from previous response as start parameter
|
|
699
|
+
>
|
|
700
|
+
> # [示例/Example]
|
|
701
|
+
> note_id="677d1909000000002002a892"
|
|
702
|
+
> comment_id="677f67e400000000220013f3"
|
|
703
|
+
|
|
704
|
+
#### Parameters
|
|
705
|
+
|
|
706
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
707
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
708
|
+
| note_id | query | string | Yes | 笔记ID/Note ID | None | 677d1909000000002002a892 | None |
|
|
709
|
+
| comment_id | query | string | Yes | 一级评论ID/Parent comment ID | None | 677f67e400000000220013f3 | None |
|
|
710
|
+
| start | query | string | No | 翻页游标/Pagination cursor | None | 6806642d000000001f01991b | None |
|
|
711
|
+
|
|
712
|
+
#### Request Body
|
|
713
|
+
|
|
714
|
+
None
|
|
715
|
+
|
|
716
|
+
#### Success Response
|
|
717
|
+
|
|
718
|
+
##### `200 application/json`
|
|
719
|
+
|
|
720
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
721
|
+
|
|
722
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
723
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
724
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
725
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
726
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
727
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
728
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
729
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
730
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
731
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
732
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
733
|
+
| 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 |
|
|
734
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
735
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
736
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
737
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
738
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
739
|
+
|
|
740
|
+
<a id="get-api-u1-v1-xiaohongshu-app-get-user-id-and-xsec-token"></a>
|
|
741
|
+
### `GET /api/u1/v1/xiaohongshu/app/get_user_id_and_xsec_token`
|
|
742
|
+
|
|
743
|
+
- Summary: 从分享链接中提取用户ID和xsec_token/Extract user ID and xsec_token from share link
|
|
744
|
+
- Capabilities: profiles / accounts
|
|
745
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
746
|
+
- operationId: `get_user_id_and_xsec_token_api_v1_xiaohongshu_app_get_user_id_and_xsec_token_get`
|
|
747
|
+
|
|
748
|
+
#### Notes
|
|
749
|
+
|
|
750
|
+
> # [中文]
|
|
751
|
+
> ### 用途:
|
|
752
|
+
> - 从用户分享链接中提取用户ID和xsec_token
|
|
753
|
+
> ### 参数:
|
|
754
|
+
> - share_link: 小红书用户分享链接,支持短链接和长链接
|
|
755
|
+
> ### 返回:
|
|
756
|
+
> - 提取的信息对象,包含:
|
|
757
|
+
> - user_id: 用户ID
|
|
758
|
+
> - xsec_token: 安全令牌(如果URL中包含)
|
|
759
|
+
>
|
|
760
|
+
> ### 使用说明:
|
|
761
|
+
> - 支持短链接格式:https://xhslink.com/m/xxxxx
|
|
762
|
+
> - 支持长链接格式:https://www.xiaohongshu.com/user/profile/xxxxx
|
|
763
|
+
> - 提取的user_id可用于get_user_info接口
|
|
764
|
+
>
|
|
765
|
+
> # [English]
|
|
766
|
+
> ### Purpose:
|
|
767
|
+
> - Extract user ID and xsec_token from user share link
|
|
768
|
+
> ### Parameters:
|
|
769
|
+
> - share_link: Xiaohongshu user share link, support short and long links
|
|
770
|
+
> ### Return:
|
|
771
|
+
> - Extracted info object containing:
|
|
772
|
+
> - user_id: User ID
|
|
773
|
+
> - xsec_token: Security token (if exists in URL)
|
|
774
|
+
>
|
|
775
|
+
> ### Usage Guide:
|
|
776
|
+
> - Supports short link format: https://xhslink.com/m/xxxxx
|
|
777
|
+
> - Supports long link format: https://www.xiaohongshu.com/user/profile/xxxxx
|
|
778
|
+
> - Extracted user_id can be used in get_user_info endpoint
|
|
779
|
+
> # [示例/Example]
|
|
780
|
+
> share_link="https://xhslink.com/m/Ap1vXtgAixh"
|
|
781
|
+
|
|
782
|
+
#### Parameters
|
|
783
|
+
|
|
784
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
785
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
786
|
+
| share_link | query | string | Yes | 用户分享链接/User share link | None | https://xhslink.com/m/Ap1vXtgAixh | None |
|
|
787
|
+
|
|
788
|
+
#### Request Body
|
|
789
|
+
|
|
790
|
+
None
|
|
791
|
+
|
|
792
|
+
#### Success Response
|
|
793
|
+
|
|
794
|
+
##### `200 application/json`
|
|
795
|
+
|
|
796
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
797
|
+
|
|
798
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
799
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
800
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
801
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
802
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
803
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
804
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
805
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
806
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
807
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
808
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
809
|
+
| 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 |
|
|
810
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
811
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
812
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
813
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
814
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
815
|
+
|
|
816
|
+
<a id="get-api-u1-v1-xiaohongshu-app-get-user-info"></a>
|
|
817
|
+
### `GET /api/u1/v1/xiaohongshu/app/get_user_info`
|
|
818
|
+
|
|
819
|
+
- Summary: 获取用户信息/Get user info
|
|
820
|
+
- Capabilities: profiles / accounts
|
|
821
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
822
|
+
- operationId: `get_user_info_api_v1_xiaohongshu_app_get_user_info_get`
|
|
823
|
+
|
|
824
|
+
#### Notes
|
|
825
|
+
|
|
826
|
+
> # [中文]
|
|
827
|
+
> ### 用途:
|
|
828
|
+
> - 获取用户详情信息
|
|
829
|
+
> ### 参数:
|
|
830
|
+
> - user_id: 用户ID(必需)
|
|
831
|
+
> ### 返回:
|
|
832
|
+
> - 用户详情数据,包含:
|
|
833
|
+
> - user_id: 用户ID
|
|
834
|
+
> - nickname: 昵称
|
|
835
|
+
> - desc: 个人简介
|
|
836
|
+
> - gender: 性别(0=女,1=男,2=未知)
|
|
837
|
+
> - images: 头像URL
|
|
838
|
+
> - imageb: 背景图URL
|
|
839
|
+
> - red_official_verify_type: 官方认证类型(0=无,1=个人,2=机构)
|
|
840
|
+
> - red_official_verify_show: 是否显示认证标识
|
|
841
|
+
> - level: 等级信息
|
|
842
|
+
> - image: 等级图标URL
|
|
843
|
+
> - name: 等级名称
|
|
844
|
+
> - follows: 关注数
|
|
845
|
+
> - fans: 粉丝数
|
|
846
|
+
> - interaction: 获赞与收藏总数
|
|
847
|
+
> - notes: 笔记数
|
|
848
|
+
> - boards: 专辑数
|
|
849
|
+
> - location: 所在地
|
|
850
|
+
> - collected: 收藏数
|
|
851
|
+
> - liked: 点赞数
|
|
852
|
+
>
|
|
853
|
+
> # [English]
|
|
854
|
+
> ### Purpose:
|
|
855
|
+
> - Get user detail info
|
|
856
|
+
> ### Parameters:
|
|
857
|
+
> - user_id: User ID (required)
|
|
858
|
+
> ### Return:
|
|
859
|
+
> - User detail data including:
|
|
860
|
+
> - user_id: User ID
|
|
861
|
+
> - nickname: Nickname
|
|
862
|
+
> - desc: Personal bio
|
|
863
|
+
> - gender: Gender (0=female, 1=male, 2=unknown)
|
|
864
|
+
> - images: Avatar URL
|
|
865
|
+
> - imageb: Background image URL
|
|
866
|
+
> - red_official_verify_type: Official verify type (0=none, 1=personal, 2=organization)
|
|
867
|
+
> - red_official_verify_show: Whether show verify badge
|
|
868
|
+
> - level: Level info
|
|
869
|
+
> - image: Level icon URL
|
|
870
|
+
> - name: Level name
|
|
871
|
+
> - follows: Following count
|
|
872
|
+
> - fans: Fans count
|
|
873
|
+
> - interaction: Total likes & collects
|
|
874
|
+
> - notes: Notes count
|
|
875
|
+
> - boards: Album count
|
|
876
|
+
> - location: Location
|
|
877
|
+
> - collected: Collect count
|
|
878
|
+
> - liked: Like count
|
|
879
|
+
>
|
|
880
|
+
> # [示例/Example]
|
|
881
|
+
> user_id="5c2f338a000000000701e1c6"
|
|
882
|
+
|
|
883
|
+
#### Parameters
|
|
884
|
+
|
|
885
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
886
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
887
|
+
| user_id | query | string | Yes | 用户ID/User ID | None | 5c2f338a000000000701e1c6 | None |
|
|
888
|
+
|
|
889
|
+
#### Request Body
|
|
890
|
+
|
|
891
|
+
None
|
|
892
|
+
|
|
893
|
+
#### Success Response
|
|
894
|
+
|
|
895
|
+
##### `200 application/json`
|
|
896
|
+
|
|
897
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
898
|
+
|
|
899
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
900
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
901
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
902
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
903
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
904
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
905
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
906
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
907
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
908
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
909
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
910
|
+
| 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 |
|
|
911
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
912
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
913
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
914
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
915
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
916
|
+
|
|
917
|
+
<a id="get-api-u1-v1-xiaohongshu-app-get-user-notes"></a>
|
|
918
|
+
### `GET /api/u1/v1/xiaohongshu/app/get_user_notes`
|
|
919
|
+
|
|
920
|
+
- Summary: 获取用户作品列表/Get user notes
|
|
921
|
+
- Capabilities: profiles / accounts / content details
|
|
922
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
923
|
+
- operationId: `get_user_notes_api_v1_xiaohongshu_app_get_user_notes_get`
|
|
924
|
+
|
|
925
|
+
#### Notes
|
|
926
|
+
|
|
927
|
+
> # [中文]
|
|
928
|
+
> ### 用途:
|
|
929
|
+
> - 获取用户发布的笔记列表
|
|
930
|
+
> ### 参数:
|
|
931
|
+
> - user_id: 用户ID(必需)
|
|
932
|
+
> - cursor: 翻页索引,上一次请求返回的cursor字段,不传默认请求第一页
|
|
933
|
+
> - cursor取值方式为notes列表的最后一条笔记的note_id
|
|
934
|
+
> ### 返回:
|
|
935
|
+
> - 用户笔记列表数据,包含:
|
|
936
|
+
> - notes: 笔记数组,每个笔记包含:
|
|
937
|
+
> - note_id: 笔记ID
|
|
938
|
+
> - type: 类型(normal=图文,video=视频)
|
|
939
|
+
> - display_title: 标题
|
|
940
|
+
> - desc: 描述
|
|
941
|
+
> - liked_count: 点赞数
|
|
942
|
+
> - cover: 封面图信息
|
|
943
|
+
> - url: 图片URL
|
|
944
|
+
> - width: 宽度
|
|
945
|
+
> - height: 高度
|
|
946
|
+
> - user: 作者信息(通常与查询用户相同)
|
|
947
|
+
> - cursor: 翻页游标
|
|
948
|
+
> - has_more: 是否有更多数据
|
|
949
|
+
>
|
|
950
|
+
> ### 翻页说明:
|
|
951
|
+
> - 首次请求:只传user_id
|
|
952
|
+
> - 翻页请求:传入上一次返回的cursor
|
|
953
|
+
> - 当has_more为false时,表示没有更多笔记
|
|
954
|
+
>
|
|
955
|
+
> # [English]
|
|
956
|
+
> ### Purpose:
|
|
957
|
+
> - Get user's published notes list
|
|
958
|
+
> ### Parameters:
|
|
959
|
+
> - user_id: User ID (required)
|
|
960
|
+
> - cursor: Pagination cursor from previous response, omit for first page
|
|
961
|
+
> - Cursor value is the note_id of the last note in the notes list
|
|
962
|
+
> ### Return:
|
|
963
|
+
> - User notes data including:
|
|
964
|
+
> - notes: Notes array, each note contains:
|
|
965
|
+
> - note_id: Note ID
|
|
966
|
+
> - type: Type (normal=image, video=video)
|
|
967
|
+
> - display_title: Title
|
|
968
|
+
> - desc: Description
|
|
969
|
+
> - liked_count: Like count
|
|
970
|
+
> - cover: Cover image info
|
|
971
|
+
> - url: Image URL
|
|
972
|
+
> - width: Width
|
|
973
|
+
> - height: Height
|
|
974
|
+
> - user: Author info (usually same as queried user)
|
|
975
|
+
> - cursor: Pagination cursor
|
|
976
|
+
> - has_more: Whether has more data
|
|
977
|
+
>
|
|
978
|
+
> ### Pagination Guide:
|
|
979
|
+
> - First request: Only pass user_id
|
|
980
|
+
> - Next pages: Pass cursor from previous response
|
|
981
|
+
> - When has_more is false, no more notes available
|
|
982
|
+
>
|
|
983
|
+
> # [示例/Example]
|
|
984
|
+
> user_id="5c57e6a4000000001802a013"
|
|
985
|
+
> cursor="67ee399f000000001c02f36f"
|
|
986
|
+
|
|
987
|
+
#### Parameters
|
|
988
|
+
|
|
989
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
990
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
991
|
+
| user_id | query | string | Yes | 用户ID/User ID | None | 5c57e6a4000000001802a013 | None |
|
|
992
|
+
| cursor | query | string | No | 翻页游标/Pagination cursor | None | 67ee399f000000001c02f36f | None |
|
|
993
|
+
|
|
994
|
+
#### Request Body
|
|
995
|
+
|
|
996
|
+
None
|
|
997
|
+
|
|
998
|
+
#### Success Response
|
|
999
|
+
|
|
1000
|
+
##### `200 application/json`
|
|
1001
|
+
|
|
1002
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1003
|
+
|
|
1004
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1005
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1006
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1007
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1008
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1009
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1010
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1011
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1012
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1013
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1014
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1015
|
+
| 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 |
|
|
1016
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1017
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1018
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1019
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1020
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1021
|
+
|
|
1022
|
+
<a id="get-api-u1-v1-xiaohongshu-app-search-notes"></a>
|
|
1023
|
+
### `GET /api/u1/v1/xiaohongshu/app/search_notes`
|
|
1024
|
+
|
|
1025
|
+
- Summary: 搜索笔记/Search notes
|
|
1026
|
+
- Capabilities: search / content details
|
|
1027
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1028
|
+
- operationId: `search_notes_api_v1_xiaohongshu_app_search_notes_get`
|
|
1029
|
+
|
|
1030
|
+
#### Notes
|
|
1031
|
+
|
|
1032
|
+
> # [中文]
|
|
1033
|
+
> ### 用途:
|
|
1034
|
+
> - 搜索小红书笔记
|
|
1035
|
+
> ### 参数:
|
|
1036
|
+
> - keyword: 要搜索的关键词(必需)
|
|
1037
|
+
> - page: 第几页,从1开始(必需)
|
|
1038
|
+
> - search_id: 搜索ID,第一次请求可不传,服务端会生成searchId,翻页时需要携带服务端返回的searchId
|
|
1039
|
+
> - session_id: 会话ID,第一次请求可不传,服务端会生成sessionId,翻页时携带服务端返回的sessionId
|
|
1040
|
+
> - sort_type: 排序规则
|
|
1041
|
+
> - "general": 综合排序(默认)
|
|
1042
|
+
> - "time_descending": 最新发布
|
|
1043
|
+
> - "popularity_descending": 最多点赞
|
|
1044
|
+
> - "comment_descending": 最多评论
|
|
1045
|
+
> - "collect_descending": 最多收藏
|
|
1046
|
+
> - filter_note_type: 筛选笔记类型
|
|
1047
|
+
> - "不限": 所有类型(默认)
|
|
1048
|
+
> - "视频笔记": 仅视频
|
|
1049
|
+
> - "普通笔记": 仅图文
|
|
1050
|
+
> - filter_note_time: 筛选笔记发布时间
|
|
1051
|
+
> - "不限": 所有时间(默认)
|
|
1052
|
+
> - "一天内": 24小时内
|
|
1053
|
+
> - "一周内": 7天内
|
|
1054
|
+
> - "半年内": 6个月内
|
|
1055
|
+
> ### 返回:
|
|
1056
|
+
> - 搜索结果数据,包含:
|
|
1057
|
+
> - items: 搜索结果列表,每个元素包含:
|
|
1058
|
+
> - id: 元素ID
|
|
1059
|
+
> - model_type: 模型类型(通常为"note")
|
|
1060
|
+
> - note: 笔记详情
|
|
1061
|
+
> - note_id: 笔记ID
|
|
1062
|
+
> - type: 类型(normal=图文,video=视频)
|
|
1063
|
+
> - display_title: 标题(关键词会高亮)
|
|
1064
|
+
> - desc: 内容描述(搜索接口无法返回完整的 desc,仅部分内容,请使用笔记详情接口获取完整内容)
|
|
1065
|
+
> - user: 作者信息
|
|
1066
|
+
> - interact_info: 互动数据
|
|
1067
|
+
> - liked_count: 点赞数
|
|
1068
|
+
> - cover: 封面图信息
|
|
1069
|
+
> - searchId: 搜索ID(翻页必需,不同关键词不要复用)
|
|
1070
|
+
> - sessionId: 会话ID(翻页必需)
|
|
1071
|
+
> - has_more: 是否有更多数据
|
|
1072
|
+
> - total_count: 搜索结果总数
|
|
1073
|
+
>
|
|
1074
|
+
> ### 翻页说明:
|
|
1075
|
+
> - 首次搜索:只传keyword和page=1
|
|
1076
|
+
> - 翻页搜索:传入相同keyword,递增page,并携带首次返回的searchId和sessionId
|
|
1077
|
+
> - 注意:更换关键词时不要复用之前的searchId
|
|
1078
|
+
>
|
|
1079
|
+
> # [English]
|
|
1080
|
+
> ### Purpose:
|
|
1081
|
+
> - Search Xiaohongshu notes
|
|
1082
|
+
> ### Parameters:
|
|
1083
|
+
> - keyword: Search keyword (required)
|
|
1084
|
+
> - page: Page number, start from 1 (required)
|
|
1085
|
+
> - search_id: Search ID, optional for first request, required for pagination
|
|
1086
|
+
> - session_id: Session ID, optional for first request, required for pagination
|
|
1087
|
+
> - sort_type: Sort method
|
|
1088
|
+
> - "general": Comprehensive (default)
|
|
1089
|
+
> - "time_descending": Latest published
|
|
1090
|
+
> - "popularity_descending": Most liked
|
|
1091
|
+
> - "comment_descending": Most commented
|
|
1092
|
+
> - "collect_descending": Most collected
|
|
1093
|
+
> - filter_note_type: Note type filter
|
|
1094
|
+
> - "不限": All types (default)
|
|
1095
|
+
> - "视频笔记": Video only
|
|
1096
|
+
> - "普通笔记": Image & text only
|
|
1097
|
+
> - filter_note_time: Time filter
|
|
1098
|
+
> - "不限": All time (default)
|
|
1099
|
+
> - "一天内": Within 24 hours
|
|
1100
|
+
> - "一周内": Within 7 days
|
|
1101
|
+
> - "半年内": Within 6 months
|
|
1102
|
+
> ### Return:
|
|
1103
|
+
> - Search results data containing:
|
|
1104
|
+
> - items: Search results list, each element includes:
|
|
1105
|
+
> - id: Element ID
|
|
1106
|
+
> - model_type: Model type (usually "note")
|
|
1107
|
+
> - note: Note details
|
|
1108
|
+
> - note_id: Note ID
|
|
1109
|
+
> - type: Type (normal=image, video=video)
|
|
1110
|
+
> - display_title: Title (keywords highlighted)
|
|
1111
|
+
> - desc: Content description (incomplete in search results, use note detail API for full content)
|
|
1112
|
+
> - user: Author info
|
|
1113
|
+
> - interact_info: Interaction data
|
|
1114
|
+
> - liked_count: Like count
|
|
1115
|
+
> - cover: Cover image info
|
|
1116
|
+
> - searchId: Search ID (required for pagination, don't reuse for different keywords)
|
|
1117
|
+
> - sessionId: Session ID (required for pagination)
|
|
1118
|
+
> - has_more: Whether has more data
|
|
1119
|
+
> - total_count: Total search results count
|
|
1120
|
+
>
|
|
1121
|
+
> ### Pagination Guide:
|
|
1122
|
+
> - First search: Only pass keyword and page=1
|
|
1123
|
+
> - Next pages: Pass same keyword, increment page, include searchId and sessionId from first response
|
|
1124
|
+
> - Note: Don't reuse searchId when changing keywords
|
|
1125
|
+
>
|
|
1126
|
+
> # [示例/Example]
|
|
1127
|
+
> keyword="猫粮"
|
|
1128
|
+
> page=1
|
|
1129
|
+
> sort_type="general"
|
|
1130
|
+
|
|
1131
|
+
#### Parameters
|
|
1132
|
+
|
|
1133
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1134
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1135
|
+
| keyword | query | string | Yes | 搜索关键词/Search keyword | None | 猫粮 | None |
|
|
1136
|
+
| page | query | integer | Yes | 页码(从1开始)/Page number (start from 1) | None | 1 | None |
|
|
1137
|
+
| search_id | query | string | No | 搜索ID,翻页时使用/Search ID for pagination | None | 2egvdsiowvfm9thbt260w | None |
|
|
1138
|
+
| session_id | query | string | No | 会话ID,翻页时使用/Session ID for pagination | None | 2egvdt4sl2b7rnfg8zk00 | None |
|
|
1139
|
+
| sort_type | query | string | No | 排序方式/Sort type | general | general | None |
|
|
1140
|
+
| filter_note_type | query | string | No | 笔记类型筛选:不限、视频笔记、普通笔记/Note type filter | 不限 | 不限 | None |
|
|
1141
|
+
| filter_note_time | query | string | No | 发布时间筛选:不限、一天内、一周内、半年内/Time filter | 不限 | 不限 | None |
|
|
1142
|
+
|
|
1143
|
+
#### Request Body
|
|
1144
|
+
|
|
1145
|
+
None
|
|
1146
|
+
|
|
1147
|
+
#### Success Response
|
|
1148
|
+
|
|
1149
|
+
##### `200 application/json`
|
|
1150
|
+
|
|
1151
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1152
|
+
|
|
1153
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1154
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1155
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1156
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1157
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1158
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1159
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1160
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1161
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1162
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1163
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1164
|
+
| 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 |
|
|
1165
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1166
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1167
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1168
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1169
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1170
|
+
|
|
1171
|
+
<a id="get-api-u1-v1-xiaohongshu-app-search-products"></a>
|
|
1172
|
+
### `GET /api/u1/v1/xiaohongshu/app/search_products`
|
|
1173
|
+
|
|
1174
|
+
- Summary: 搜索商品/Search products
|
|
1175
|
+
- Capabilities: search / commerce
|
|
1176
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1177
|
+
- operationId: `search_products_api_v1_xiaohongshu_app_search_products_get`
|
|
1178
|
+
|
|
1179
|
+
#### Notes
|
|
1180
|
+
|
|
1181
|
+
> # [中文]
|
|
1182
|
+
> ### 用途:
|
|
1183
|
+
> - 搜索小红书商品
|
|
1184
|
+
> ### 参数:
|
|
1185
|
+
> - keyword: 搜索关键词(必需)
|
|
1186
|
+
> - page: 页码,从1开始(必需)
|
|
1187
|
+
> - search_id: 搜索ID,第一次请求可不传,翻页时需要携带服务端返回的searchId
|
|
1188
|
+
> - session_id: 会话ID,第一次请求可不传,翻页时携带服务端返回的sessionId
|
|
1189
|
+
> - sort: 排序规则,默认综合
|
|
1190
|
+
> - "sales_qty": 销量
|
|
1191
|
+
> - "price_asc": 价格升序
|
|
1192
|
+
> - "price_desc": 价格降序
|
|
1193
|
+
> - scope: 搜索范围,默认不限
|
|
1194
|
+
> - "purchased": 买过的店
|
|
1195
|
+
> - "following": 关注的店
|
|
1196
|
+
> - service_guarantee: 物流权益,多选用英文逗号分割
|
|
1197
|
+
> - 可选值: "24小时发货", "七天无理由", "现货", "退货包运费"
|
|
1198
|
+
> - min_price: 最低价
|
|
1199
|
+
> - max_price: 最高价
|
|
1200
|
+
> - super_promotion: 标签ID
|
|
1201
|
+
> ### 返回:
|
|
1202
|
+
> - 搜索结果数据,包含:
|
|
1203
|
+
> - items: 商品列表
|
|
1204
|
+
> - searchId: 搜索ID(翻页必需)
|
|
1205
|
+
> - sessionId: 会话ID(翻页必需)
|
|
1206
|
+
> - has_more: 是否有更多数据
|
|
1207
|
+
>
|
|
1208
|
+
> ### 翻页说明:
|
|
1209
|
+
> - 首次搜索:只传keyword和page=1
|
|
1210
|
+
> - 翻页搜索:传入相同keyword,递增page,并携带首次返回的searchId和sessionId
|
|
1211
|
+
> - 注意:更换关键词时不要复用之前的searchId
|
|
1212
|
+
>
|
|
1213
|
+
> # [English]
|
|
1214
|
+
> ### Purpose:
|
|
1215
|
+
> - Search Xiaohongshu products
|
|
1216
|
+
> ### Parameters:
|
|
1217
|
+
> - keyword: Search keyword (required)
|
|
1218
|
+
> - page: Page number, start from 1 (required)
|
|
1219
|
+
> - search_id: Search ID, optional for first request, required for pagination
|
|
1220
|
+
> - session_id: Session ID, optional for first request, required for pagination
|
|
1221
|
+
> - sort: Sort method
|
|
1222
|
+
> - "sales_qty": By sales
|
|
1223
|
+
> - "price_asc": Price ascending
|
|
1224
|
+
> - "price_desc": Price descending
|
|
1225
|
+
> - scope: Search scope
|
|
1226
|
+
> - "purchased": Shops you've bought from
|
|
1227
|
+
> - "following": Shops you follow
|
|
1228
|
+
> - service_guarantee: Service guarantees, comma separated
|
|
1229
|
+
> - Options: "24小时发货", "七天无理由", "现货", "退货包运费"
|
|
1230
|
+
> - min_price: Minimum price
|
|
1231
|
+
> - max_price: Maximum price
|
|
1232
|
+
> - super_promotion: Promotion tag ID
|
|
1233
|
+
> ### 返回:
|
|
1234
|
+
> - Search results containing:
|
|
1235
|
+
> - items: Product list
|
|
1236
|
+
> - searchId: Search ID (required for pagination)
|
|
1237
|
+
> - sessionId: Session ID (required for pagination)
|
|
1238
|
+
> - has_more: Whether has more data
|
|
1239
|
+
>
|
|
1240
|
+
> ### Pagination Guide:
|
|
1241
|
+
> - First search: Only pass keyword and page=1
|
|
1242
|
+
> - Next pages: Pass same keyword, increment page, include searchId and sessionId
|
|
1243
|
+
> - Note: Don't reuse searchId when changing keywords
|
|
1244
|
+
>
|
|
1245
|
+
> # [示例/Example]
|
|
1246
|
+
> keyword="充电宝"
|
|
1247
|
+
> page=1
|
|
1248
|
+
> sort="sales_qty"
|
|
1249
|
+
|
|
1250
|
+
#### Parameters
|
|
1251
|
+
|
|
1252
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1253
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1254
|
+
| keyword | query | string | Yes | 搜索关键词/Search keyword | None | 充电宝 | None |
|
|
1255
|
+
| page | query | integer | Yes | 页码(从1开始)/Page number (start from 1) | None | 1 | None |
|
|
1256
|
+
| search_id | query | string | No | 搜索ID,翻页时使用/Search ID for pagination | None | None | None |
|
|
1257
|
+
| session_id | query | string | No | 会话ID,翻页时使用/Session ID for pagination | None | None | None |
|
|
1258
|
+
| sort | query | string | No | 排序规则:sales_qty-销量、price_asc-价格升序、price_desc-价格降序/Sort: sales_qty, price_asc, price_desc | None | sales_qty | None |
|
|
1259
|
+
| scope | query | string | No | 搜索范围:purchased-买过的店、following-关注的店/Scope: purchased, following | None | purchased | None |
|
|
1260
|
+
| service_guarantee | query | string | No | 物流权益,多选用英文逗号分割/Service guarantee, comma separated | None | 24小时发货,七天无理由 | None |
|
|
1261
|
+
| min_price | query | string | No | 最低价/Min price | None | 1 | None |
|
|
1262
|
+
| max_price | query | string | No | 最高价/Max price | None | 100 | None |
|
|
1263
|
+
| super_promotion | query | string | No | 标签ID/Promotion tag ID | None | 695fb0a330425100017ff555 | None |
|
|
1264
|
+
|
|
1265
|
+
#### Request Body
|
|
1266
|
+
|
|
1267
|
+
None
|
|
1268
|
+
|
|
1269
|
+
#### Success Response
|
|
1270
|
+
|
|
1271
|
+
##### `200 application/json`
|
|
1272
|
+
|
|
1273
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1274
|
+
|
|
1275
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1276
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1277
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1278
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1279
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1280
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1281
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1282
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1283
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1284
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1285
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1286
|
+
| 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 |
|
|
1287
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1288
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1289
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1290
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1291
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|