@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.
Files changed (451) hide show
  1. package/.skill-package-allowlist.txt +4 -0
  2. package/LICENSE +21 -0
  3. package/README.md +167 -0
  4. package/README.zh-CN.md +167 -0
  5. package/bin/tikomni-skills.js +127 -0
  6. package/env.example +160 -0
  7. package/lib/installer.js +176 -0
  8. package/package.json +44 -0
  9. package/skills/creator-analysis/SKILL.md +71 -0
  10. package/skills/creator-analysis/agents/openai.yaml +4 -0
  11. package/skills/creator-analysis/env.example +36 -0
  12. package/skills/creator-analysis/references/api-capability-index.md +92 -0
  13. package/skills/creator-analysis/references/api-contracts/asr-api.md +130 -0
  14. package/skills/creator-analysis/references/api-contracts/bilibili-app-api.md +776 -0
  15. package/skills/creator-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
  16. package/skills/creator-analysis/references/api-contracts/demo-api.md +717 -0
  17. package/skills/creator-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
  18. package/skills/creator-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
  19. package/skills/creator-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
  20. package/skills/creator-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
  21. package/skills/creator-analysis/references/api-contracts/douyin-search-api.md +4118 -0
  22. package/skills/creator-analysis/references/api-contracts/douyin-web-api.md +5544 -0
  23. package/skills/creator-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
  24. package/skills/creator-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
  25. package/skills/creator-analysis/references/api-contracts/health-check.md +69 -0
  26. package/skills/creator-analysis/references/api-contracts/hybrid-parsing.md +78 -0
  27. package/skills/creator-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
  28. package/skills/creator-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
  29. package/skills/creator-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
  30. package/skills/creator-analysis/references/api-contracts/ios-shortcut.md +44 -0
  31. package/skills/creator-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
  32. package/skills/creator-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
  33. package/skills/creator-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
  34. package/skills/creator-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
  35. package/skills/creator-analysis/references/api-contracts/media-ingest-api.md +126 -0
  36. package/skills/creator-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
  37. package/skills/creator-analysis/references/api-contracts/reddit-app-api.md +2025 -0
  38. package/skills/creator-analysis/references/api-contracts/sora2-api.md +2266 -0
  39. package/skills/creator-analysis/references/api-contracts/temp-mail-api.md +208 -0
  40. package/skills/creator-analysis/references/api-contracts/threads-web-api.md +897 -0
  41. package/skills/creator-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
  42. package/skills/creator-analysis/references/api-contracts/tikhub-user-api.md +494 -0
  43. package/skills/creator-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
  44. package/skills/creator-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
  45. package/skills/creator-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
  46. package/skills/creator-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
  47. package/skills/creator-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
  48. package/skills/creator-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
  49. package/skills/creator-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
  50. package/skills/creator-analysis/references/api-contracts/toutiao-app-api.md +342 -0
  51. package/skills/creator-analysis/references/api-contracts/toutiao-web-api.md +143 -0
  52. package/skills/creator-analysis/references/api-contracts/twitter-web-api.md +989 -0
  53. package/skills/creator-analysis/references/api-contracts/wechat-channels-api.md +809 -0
  54. package/skills/creator-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
  55. package/skills/creator-analysis/references/api-contracts/weibo-app-api.md +1547 -0
  56. package/skills/creator-analysis/references/api-contracts/weibo-web-api.md +798 -0
  57. package/skills/creator-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
  58. package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
  59. package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
  60. package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
  61. package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
  62. package/skills/creator-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
  63. package/skills/creator-analysis/references/api-contracts/youtube-web-api.md +2636 -0
  64. package/skills/creator-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
  65. package/skills/creator-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
  66. package/skills/creator-analysis/references/api-tags/asr-api.md +100 -0
  67. package/skills/creator-analysis/references/api-tags/bilibili-app-api.md +482 -0
  68. package/skills/creator-analysis/references/api-tags/bilibili-web-api.md +1267 -0
  69. package/skills/creator-analysis/references/api-tags/demo-api.md +365 -0
  70. package/skills/creator-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
  71. package/skills/creator-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
  72. package/skills/creator-analysis/references/api-tags/douyin-creator-api.md +694 -0
  73. package/skills/creator-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
  74. package/skills/creator-analysis/references/api-tags/douyin-search-api.md +1059 -0
  75. package/skills/creator-analysis/references/api-tags/douyin-web-api.md +3314 -0
  76. package/skills/creator-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
  77. package/skills/creator-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
  78. package/skills/creator-analysis/references/api-tags/health-check.md +40 -0
  79. package/skills/creator-analysis/references/api-tags/hybrid-parsing.md +57 -0
  80. package/skills/creator-analysis/references/api-tags/instagram-v1-api.md +1224 -0
  81. package/skills/creator-analysis/references/api-tags/instagram-v2-api.md +1147 -0
  82. package/skills/creator-analysis/references/api-tags/instagram-v3-api.md +1123 -0
  83. package/skills/creator-analysis/references/api-tags/ios-shortcut.md +45 -0
  84. package/skills/creator-analysis/references/api-tags/kuaishou-app-api.md +846 -0
  85. package/skills/creator-analysis/references/api-tags/kuaishou-web-api.md +551 -0
  86. package/skills/creator-analysis/references/api-tags/lemon8-app-api.md +687 -0
  87. package/skills/creator-analysis/references/api-tags/linkedin-web-api.md +1105 -0
  88. package/skills/creator-analysis/references/api-tags/media-ingest-api.md +112 -0
  89. package/skills/creator-analysis/references/api-tags/pipixia-app-api.md +721 -0
  90. package/skills/creator-analysis/references/api-tags/reddit-app-api.md +1057 -0
  91. package/skills/creator-analysis/references/api-tags/sora2-api.md +737 -0
  92. package/skills/creator-analysis/references/api-tags/temp-mail-api.md +136 -0
  93. package/skills/creator-analysis/references/api-tags/threads-web-api.md +472 -0
  94. package/skills/creator-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
  95. package/skills/creator-analysis/references/api-tags/tikhub-user-api.md +253 -0
  96. package/skills/creator-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
  97. package/skills/creator-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
  98. package/skills/creator-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
  99. package/skills/creator-analysis/references/api-tags/tiktok-creator-api.md +709 -0
  100. package/skills/creator-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
  101. package/skills/creator-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
  102. package/skills/creator-analysis/references/api-tags/tiktok-web-api.md +2516 -0
  103. package/skills/creator-analysis/references/api-tags/toutiao-app-api.md +220 -0
  104. package/skills/creator-analysis/references/api-tags/toutiao-web-api.md +96 -0
  105. package/skills/creator-analysis/references/api-tags/twitter-web-api.md +562 -0
  106. package/skills/creator-analysis/references/api-tags/wechat-channels-api.md +405 -0
  107. package/skills/creator-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
  108. package/skills/creator-analysis/references/api-tags/weibo-app-api.md +851 -0
  109. package/skills/creator-analysis/references/api-tags/weibo-web-api.md +470 -0
  110. package/skills/creator-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
  111. package/skills/creator-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
  112. package/skills/creator-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
  113. package/skills/creator-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
  114. package/skills/creator-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
  115. package/skills/creator-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
  116. package/skills/creator-analysis/references/api-tags/youtube-web-api.md +934 -0
  117. package/skills/creator-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
  118. package/skills/creator-analysis/references/api-tags/zhihu-web-api.md +1384 -0
  119. package/skills/creator-analysis/references/asr-orchestration.md +33 -0
  120. package/skills/creator-analysis/references/config-templates/defaults.yaml +60 -0
  121. package/skills/creator-analysis/references/contracts/creator-card-fields.md +23 -0
  122. package/skills/creator-analysis/references/contracts/work-card-fields.md +32 -0
  123. package/skills/creator-analysis/references/platform-guides/douyin.md +49 -0
  124. package/skills/creator-analysis/references/platform-guides/generic.md +46 -0
  125. package/skills/creator-analysis/references/platform-guides/xiaohongshu.md +54 -0
  126. package/skills/creator-analysis/references/prompt-contracts/asr-clean.md +28 -0
  127. package/skills/creator-analysis/references/prompt-contracts/author-analysis-v2.md +46 -0
  128. package/skills/creator-analysis/references/prompt-contracts/author-analysis.md +49 -0
  129. package/skills/creator-analysis/references/prompt-contracts/cta.md +24 -0
  130. package/skills/creator-analysis/references/prompt-contracts/hook.md +25 -0
  131. package/skills/creator-analysis/references/prompt-contracts/insight.md +47 -0
  132. package/skills/creator-analysis/references/prompt-contracts/sampled-work-batch-explanations.md +30 -0
  133. package/skills/creator-analysis/references/prompt-contracts/structure.md +25 -0
  134. package/skills/creator-analysis/references/prompt-contracts/style.md +27 -0
  135. package/skills/creator-analysis/references/prompt-contracts/summary.md +29 -0
  136. package/skills/creator-analysis/references/prompt-contracts/topic.md +29 -0
  137. package/skills/creator-analysis/references/schemas/author-analysis-input-v1.schema.json +325 -0
  138. package/skills/creator-analysis/references/schemas/author-analysis-v2.schema.json +158 -0
  139. package/skills/creator-analysis/references/schemas/sampled-work-batch-explanations.schema.json +41 -0
  140. package/skills/creator-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
  141. package/skills/creator-analysis/references/workflow.md +18 -0
  142. package/skills/creator-analysis/scripts/__init__.py +0 -0
  143. package/skills/creator-analysis/scripts/author_home/__init__.py +0 -0
  144. package/skills/creator-analysis/scripts/author_home/adapters/__init__.py +0 -0
  145. package/skills/creator-analysis/scripts/author_home/adapters/platform_adapters.py +299 -0
  146. package/skills/creator-analysis/scripts/author_home/analyzers/__init__.py +0 -0
  147. package/skills/creator-analysis/scripts/author_home/analyzers/author_analysis_v2_support.py +1122 -0
  148. package/skills/creator-analysis/scripts/author_home/analyzers/prompt_first_analyzers.py +260 -0
  149. package/skills/creator-analysis/scripts/author_home/analyzers/sampled_work_batch_explainer.py +260 -0
  150. package/skills/creator-analysis/scripts/author_home/asr/__init__.py +5 -0
  151. package/skills/creator-analysis/scripts/author_home/asr/home_asr.py +961 -0
  152. package/skills/creator-analysis/scripts/author_home/builders/__init__.py +0 -0
  153. package/skills/creator-analysis/scripts/author_home/builders/home_builders.py +149 -0
  154. package/skills/creator-analysis/scripts/author_home/collectors/__init__.py +0 -0
  155. package/skills/creator-analysis/scripts/author_home/collectors/homepage_collectors.py +636 -0
  156. package/skills/creator-analysis/scripts/author_home/orchestrator/__init__.py +0 -0
  157. package/skills/creator-analysis/scripts/author_home/orchestrator/run_author_analysis.py +491 -0
  158. package/skills/creator-analysis/scripts/author_home/orchestrator/work_analysis_artifacts.py +553 -0
  159. package/skills/creator-analysis/scripts/author_home/schema.py +417 -0
  160. package/skills/creator-analysis/scripts/core/__init__.py +0 -0
  161. package/skills/creator-analysis/scripts/core/analysis_pipeline.py +133 -0
  162. package/skills/creator-analysis/scripts/core/bootstrap_env.py +35 -0
  163. package/skills/creator-analysis/scripts/core/config_loader.py +418 -0
  164. package/skills/creator-analysis/scripts/core/extract_pipeline.py +173 -0
  165. package/skills/creator-analysis/scripts/core/progress_report.py +111 -0
  166. package/skills/creator-analysis/scripts/core/storage_router.py +253 -0
  167. package/skills/creator-analysis/scripts/core/tikomni_common.py +588 -0
  168. package/skills/creator-analysis/scripts/pipeline/__init__.py +0 -0
  169. package/skills/creator-analysis/scripts/pipeline/asr/__init__.py +0 -0
  170. package/skills/creator-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
  171. package/skills/creator-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
  172. package/skills/creator-analysis/scripts/platform/__init__.py +0 -0
  173. package/skills/creator-analysis/scripts/platform/douyin/__init__.py +0 -0
  174. package/skills/creator-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
  175. package/skills/creator-analysis/scripts/platform/douyin/run_douyin_single_video.py +1208 -0
  176. package/skills/creator-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
  177. package/skills/creator-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
  178. package/skills/creator-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2128 -0
  179. package/skills/creator-analysis/scripts/writers/__init__.py +0 -0
  180. package/skills/creator-analysis/scripts/writers/write_author_homepage_samples.py +106 -0
  181. package/skills/creator-analysis/scripts/writers/write_benchmark_card.py +1402 -0
  182. package/skills/meta-capability/SKILL.md +69 -0
  183. package/skills/meta-capability/agents/openai.yaml +4 -0
  184. package/skills/meta-capability/env.example +42 -0
  185. package/skills/meta-capability/references/api-capability-index.md +92 -0
  186. package/skills/meta-capability/references/api-contracts/asr-api.md +130 -0
  187. package/skills/meta-capability/references/api-contracts/bilibili-app-api.md +776 -0
  188. package/skills/meta-capability/references/api-contracts/bilibili-web-api.md +2017 -0
  189. package/skills/meta-capability/references/api-contracts/demo-api.md +717 -0
  190. package/skills/meta-capability/references/api-contracts/douyin-app-v3-api.md +3594 -0
  191. package/skills/meta-capability/references/api-contracts/douyin-billboard-api.md +2274 -0
  192. package/skills/meta-capability/references/api-contracts/douyin-creator-api.md +1575 -0
  193. package/skills/meta-capability/references/api-contracts/douyin-creator-v2-api.md +3254 -0
  194. package/skills/meta-capability/references/api-contracts/douyin-search-api.md +4118 -0
  195. package/skills/meta-capability/references/api-contracts/douyin-web-api.md +5544 -0
  196. package/skills/meta-capability/references/api-contracts/douyin-xingtu-api.md +1916 -0
  197. package/skills/meta-capability/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
  198. package/skills/meta-capability/references/api-contracts/health-check.md +69 -0
  199. package/skills/meta-capability/references/api-contracts/hybrid-parsing.md +78 -0
  200. package/skills/meta-capability/references/api-contracts/instagram-v1-api.md +2256 -0
  201. package/skills/meta-capability/references/api-contracts/instagram-v2-api.md +2011 -0
  202. package/skills/meta-capability/references/api-contracts/instagram-v3-api.md +2630 -0
  203. package/skills/meta-capability/references/api-contracts/ios-shortcut.md +44 -0
  204. package/skills/meta-capability/references/api-contracts/kuaishou-app-api.md +1518 -0
  205. package/skills/meta-capability/references/api-contracts/kuaishou-web-api.md +1242 -0
  206. package/skills/meta-capability/references/api-contracts/lemon8-app-api.md +1088 -0
  207. package/skills/meta-capability/references/api-contracts/linkedin-web-api.md +1949 -0
  208. package/skills/meta-capability/references/api-contracts/media-ingest-api.md +126 -0
  209. package/skills/meta-capability/references/api-contracts/pipixia-app-api.md +1142 -0
  210. package/skills/meta-capability/references/api-contracts/reddit-app-api.md +2025 -0
  211. package/skills/meta-capability/references/api-contracts/sora2-api.md +2266 -0
  212. package/skills/meta-capability/references/api-contracts/temp-mail-api.md +208 -0
  213. package/skills/meta-capability/references/api-contracts/threads-web-api.md +897 -0
  214. package/skills/meta-capability/references/api-contracts/tikhub-downloader-api.md +134 -0
  215. package/skills/meta-capability/references/api-contracts/tikhub-user-api.md +494 -0
  216. package/skills/meta-capability/references/api-contracts/tiktok-ads-api.md +5947 -0
  217. package/skills/meta-capability/references/api-contracts/tiktok-analytics-api.md +968 -0
  218. package/skills/meta-capability/references/api-contracts/tiktok-app-v3-api.md +5735 -0
  219. package/skills/meta-capability/references/api-contracts/tiktok-creator-api.md +1951 -0
  220. package/skills/meta-capability/references/api-contracts/tiktok-interaction-api.md +742 -0
  221. package/skills/meta-capability/references/api-contracts/tiktok-shop-web-api.md +1890 -0
  222. package/skills/meta-capability/references/api-contracts/tiktok-web-api.md +4448 -0
  223. package/skills/meta-capability/references/api-contracts/toutiao-app-api.md +342 -0
  224. package/skills/meta-capability/references/api-contracts/toutiao-web-api.md +143 -0
  225. package/skills/meta-capability/references/api-contracts/twitter-web-api.md +989 -0
  226. package/skills/meta-capability/references/api-contracts/wechat-channels-api.md +809 -0
  227. package/skills/meta-capability/references/api-contracts/wechat-media-platform-web-api.md +677 -0
  228. package/skills/meta-capability/references/api-contracts/weibo-app-api.md +1547 -0
  229. package/skills/meta-capability/references/api-contracts/weibo-web-api.md +798 -0
  230. package/skills/meta-capability/references/api-contracts/weibo-web-v2-api.md +2459 -0
  231. package/skills/meta-capability/references/api-contracts/xiaohongshu-app-api.md +1291 -0
  232. package/skills/meta-capability/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
  233. package/skills/meta-capability/references/api-contracts/xiaohongshu-web-api.md +1324 -0
  234. package/skills/meta-capability/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
  235. package/skills/meta-capability/references/api-contracts/xigua-app-v2-api.md +489 -0
  236. package/skills/meta-capability/references/api-contracts/youtube-web-api.md +2636 -0
  237. package/skills/meta-capability/references/api-contracts/youtube-web-v2-api.md +2660 -0
  238. package/skills/meta-capability/references/api-contracts/zhihu-web-api.md +2315 -0
  239. package/skills/meta-capability/references/api-tags/asr-api.md +100 -0
  240. package/skills/meta-capability/references/api-tags/bilibili-app-api.md +482 -0
  241. package/skills/meta-capability/references/api-tags/bilibili-web-api.md +1267 -0
  242. package/skills/meta-capability/references/api-tags/demo-api.md +365 -0
  243. package/skills/meta-capability/references/api-tags/douyin-app-v3-api.md +2012 -0
  244. package/skills/meta-capability/references/api-tags/douyin-billboard-api.md +1428 -0
  245. package/skills/meta-capability/references/api-tags/douyin-creator-api.md +694 -0
  246. package/skills/meta-capability/references/api-tags/douyin-creator-v2-api.md +694 -0
  247. package/skills/meta-capability/references/api-tags/douyin-search-api.md +1059 -0
  248. package/skills/meta-capability/references/api-tags/douyin-web-api.md +3314 -0
  249. package/skills/meta-capability/references/api-tags/douyin-xingtu-api.md +935 -0
  250. package/skills/meta-capability/references/api-tags/douyin-xingtu-v2-api.md +925 -0
  251. package/skills/meta-capability/references/api-tags/health-check.md +40 -0
  252. package/skills/meta-capability/references/api-tags/hybrid-parsing.md +57 -0
  253. package/skills/meta-capability/references/api-tags/instagram-v1-api.md +1224 -0
  254. package/skills/meta-capability/references/api-tags/instagram-v2-api.md +1147 -0
  255. package/skills/meta-capability/references/api-tags/instagram-v3-api.md +1123 -0
  256. package/skills/meta-capability/references/api-tags/ios-shortcut.md +45 -0
  257. package/skills/meta-capability/references/api-tags/kuaishou-app-api.md +846 -0
  258. package/skills/meta-capability/references/api-tags/kuaishou-web-api.md +551 -0
  259. package/skills/meta-capability/references/api-tags/lemon8-app-api.md +687 -0
  260. package/skills/meta-capability/references/api-tags/linkedin-web-api.md +1105 -0
  261. package/skills/meta-capability/references/api-tags/media-ingest-api.md +112 -0
  262. package/skills/meta-capability/references/api-tags/pipixia-app-api.md +721 -0
  263. package/skills/meta-capability/references/api-tags/reddit-app-api.md +1057 -0
  264. package/skills/meta-capability/references/api-tags/sora2-api.md +737 -0
  265. package/skills/meta-capability/references/api-tags/temp-mail-api.md +136 -0
  266. package/skills/meta-capability/references/api-tags/threads-web-api.md +472 -0
  267. package/skills/meta-capability/references/api-tags/tikhub-downloader-api.md +65 -0
  268. package/skills/meta-capability/references/api-tags/tikhub-user-api.md +253 -0
  269. package/skills/meta-capability/references/api-tags/tiktok-ads-api.md +1393 -0
  270. package/skills/meta-capability/references/api-tags/tiktok-analytics-api.md +179 -0
  271. package/skills/meta-capability/references/api-tags/tiktok-app-v3-api.md +3264 -0
  272. package/skills/meta-capability/references/api-tags/tiktok-creator-api.md +709 -0
  273. package/skills/meta-capability/references/api-tags/tiktok-interaction-api.md +366 -0
  274. package/skills/meta-capability/references/api-tags/tiktok-shop-web-api.md +663 -0
  275. package/skills/meta-capability/references/api-tags/tiktok-web-api.md +2516 -0
  276. package/skills/meta-capability/references/api-tags/toutiao-app-api.md +220 -0
  277. package/skills/meta-capability/references/api-tags/toutiao-web-api.md +96 -0
  278. package/skills/meta-capability/references/api-tags/twitter-web-api.md +562 -0
  279. package/skills/meta-capability/references/api-tags/wechat-channels-api.md +405 -0
  280. package/skills/meta-capability/references/api-tags/wechat-media-platform-web-api.md +431 -0
  281. package/skills/meta-capability/references/api-tags/weibo-app-api.md +851 -0
  282. package/skills/meta-capability/references/api-tags/weibo-web-api.md +470 -0
  283. package/skills/meta-capability/references/api-tags/weibo-web-v2-api.md +1405 -0
  284. package/skills/meta-capability/references/api-tags/xiaohongshu-app-api.md +534 -0
  285. package/skills/meta-capability/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
  286. package/skills/meta-capability/references/api-tags/xiaohongshu-web-api.md +757 -0
  287. package/skills/meta-capability/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
  288. package/skills/meta-capability/references/api-tags/xigua-app-v2-api.md +308 -0
  289. package/skills/meta-capability/references/api-tags/youtube-web-api.md +934 -0
  290. package/skills/meta-capability/references/api-tags/youtube-web-v2-api.md +717 -0
  291. package/skills/meta-capability/references/api-tags/zhihu-web-api.md +1384 -0
  292. package/skills/meta-capability/references/config-templates/defaults.yaml +18 -0
  293. package/skills/meta-capability/references/dispatch.md +27 -0
  294. package/skills/meta-capability/references/execution-guidelines.md +25 -0
  295. package/skills/meta-capability/references/implemented-route-map.md +177 -0
  296. package/skills/meta-capability/references/service-guides/asr-u2-u3-fallback.md +75 -0
  297. package/skills/meta-capability/scripts/__init__.py +1 -0
  298. package/skills/meta-capability/scripts/call_route.py +141 -0
  299. package/skills/meta-capability/scripts/core/__init__.py +1 -0
  300. package/skills/meta-capability/scripts/core/bootstrap_env.py +32 -0
  301. package/skills/meta-capability/scripts/core/config_loader.py +204 -0
  302. package/skills/meta-capability/scripts/core/tikomni_common.py +443 -0
  303. package/skills/meta-capability/scripts/test_auth.py +98 -0
  304. package/skills/single-work-analysis/SKILL.md +62 -0
  305. package/skills/single-work-analysis/agents/openai.yaml +4 -0
  306. package/skills/single-work-analysis/env.example +36 -0
  307. package/skills/single-work-analysis/references/api-capability-index.md +92 -0
  308. package/skills/single-work-analysis/references/api-contracts/asr-api.md +130 -0
  309. package/skills/single-work-analysis/references/api-contracts/bilibili-app-api.md +776 -0
  310. package/skills/single-work-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
  311. package/skills/single-work-analysis/references/api-contracts/demo-api.md +717 -0
  312. package/skills/single-work-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
  313. package/skills/single-work-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
  314. package/skills/single-work-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
  315. package/skills/single-work-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
  316. package/skills/single-work-analysis/references/api-contracts/douyin-search-api.md +4118 -0
  317. package/skills/single-work-analysis/references/api-contracts/douyin-web-api.md +5544 -0
  318. package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
  319. package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
  320. package/skills/single-work-analysis/references/api-contracts/health-check.md +69 -0
  321. package/skills/single-work-analysis/references/api-contracts/hybrid-parsing.md +78 -0
  322. package/skills/single-work-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
  323. package/skills/single-work-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
  324. package/skills/single-work-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
  325. package/skills/single-work-analysis/references/api-contracts/ios-shortcut.md +44 -0
  326. package/skills/single-work-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
  327. package/skills/single-work-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
  328. package/skills/single-work-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
  329. package/skills/single-work-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
  330. package/skills/single-work-analysis/references/api-contracts/media-ingest-api.md +126 -0
  331. package/skills/single-work-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
  332. package/skills/single-work-analysis/references/api-contracts/reddit-app-api.md +2025 -0
  333. package/skills/single-work-analysis/references/api-contracts/sora2-api.md +2266 -0
  334. package/skills/single-work-analysis/references/api-contracts/temp-mail-api.md +208 -0
  335. package/skills/single-work-analysis/references/api-contracts/threads-web-api.md +897 -0
  336. package/skills/single-work-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
  337. package/skills/single-work-analysis/references/api-contracts/tikhub-user-api.md +494 -0
  338. package/skills/single-work-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
  339. package/skills/single-work-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
  340. package/skills/single-work-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
  341. package/skills/single-work-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
  342. package/skills/single-work-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
  343. package/skills/single-work-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
  344. package/skills/single-work-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
  345. package/skills/single-work-analysis/references/api-contracts/toutiao-app-api.md +342 -0
  346. package/skills/single-work-analysis/references/api-contracts/toutiao-web-api.md +143 -0
  347. package/skills/single-work-analysis/references/api-contracts/twitter-web-api.md +989 -0
  348. package/skills/single-work-analysis/references/api-contracts/wechat-channels-api.md +809 -0
  349. package/skills/single-work-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
  350. package/skills/single-work-analysis/references/api-contracts/weibo-app-api.md +1547 -0
  351. package/skills/single-work-analysis/references/api-contracts/weibo-web-api.md +798 -0
  352. package/skills/single-work-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
  353. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
  354. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
  355. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
  356. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
  357. package/skills/single-work-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
  358. package/skills/single-work-analysis/references/api-contracts/youtube-web-api.md +2636 -0
  359. package/skills/single-work-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
  360. package/skills/single-work-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
  361. package/skills/single-work-analysis/references/api-tags/asr-api.md +100 -0
  362. package/skills/single-work-analysis/references/api-tags/bilibili-app-api.md +482 -0
  363. package/skills/single-work-analysis/references/api-tags/bilibili-web-api.md +1267 -0
  364. package/skills/single-work-analysis/references/api-tags/demo-api.md +365 -0
  365. package/skills/single-work-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
  366. package/skills/single-work-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
  367. package/skills/single-work-analysis/references/api-tags/douyin-creator-api.md +694 -0
  368. package/skills/single-work-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
  369. package/skills/single-work-analysis/references/api-tags/douyin-search-api.md +1059 -0
  370. package/skills/single-work-analysis/references/api-tags/douyin-web-api.md +3314 -0
  371. package/skills/single-work-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
  372. package/skills/single-work-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
  373. package/skills/single-work-analysis/references/api-tags/health-check.md +40 -0
  374. package/skills/single-work-analysis/references/api-tags/hybrid-parsing.md +57 -0
  375. package/skills/single-work-analysis/references/api-tags/instagram-v1-api.md +1224 -0
  376. package/skills/single-work-analysis/references/api-tags/instagram-v2-api.md +1147 -0
  377. package/skills/single-work-analysis/references/api-tags/instagram-v3-api.md +1123 -0
  378. package/skills/single-work-analysis/references/api-tags/ios-shortcut.md +45 -0
  379. package/skills/single-work-analysis/references/api-tags/kuaishou-app-api.md +846 -0
  380. package/skills/single-work-analysis/references/api-tags/kuaishou-web-api.md +551 -0
  381. package/skills/single-work-analysis/references/api-tags/lemon8-app-api.md +687 -0
  382. package/skills/single-work-analysis/references/api-tags/linkedin-web-api.md +1105 -0
  383. package/skills/single-work-analysis/references/api-tags/media-ingest-api.md +112 -0
  384. package/skills/single-work-analysis/references/api-tags/pipixia-app-api.md +721 -0
  385. package/skills/single-work-analysis/references/api-tags/reddit-app-api.md +1057 -0
  386. package/skills/single-work-analysis/references/api-tags/sora2-api.md +737 -0
  387. package/skills/single-work-analysis/references/api-tags/temp-mail-api.md +136 -0
  388. package/skills/single-work-analysis/references/api-tags/threads-web-api.md +472 -0
  389. package/skills/single-work-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
  390. package/skills/single-work-analysis/references/api-tags/tikhub-user-api.md +253 -0
  391. package/skills/single-work-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
  392. package/skills/single-work-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
  393. package/skills/single-work-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
  394. package/skills/single-work-analysis/references/api-tags/tiktok-creator-api.md +709 -0
  395. package/skills/single-work-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
  396. package/skills/single-work-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
  397. package/skills/single-work-analysis/references/api-tags/tiktok-web-api.md +2516 -0
  398. package/skills/single-work-analysis/references/api-tags/toutiao-app-api.md +220 -0
  399. package/skills/single-work-analysis/references/api-tags/toutiao-web-api.md +96 -0
  400. package/skills/single-work-analysis/references/api-tags/twitter-web-api.md +562 -0
  401. package/skills/single-work-analysis/references/api-tags/wechat-channels-api.md +405 -0
  402. package/skills/single-work-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
  403. package/skills/single-work-analysis/references/api-tags/weibo-app-api.md +851 -0
  404. package/skills/single-work-analysis/references/api-tags/weibo-web-api.md +470 -0
  405. package/skills/single-work-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
  406. package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
  407. package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
  408. package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
  409. package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
  410. package/skills/single-work-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
  411. package/skills/single-work-analysis/references/api-tags/youtube-web-api.md +934 -0
  412. package/skills/single-work-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
  413. package/skills/single-work-analysis/references/api-tags/zhihu-web-api.md +1384 -0
  414. package/skills/single-work-analysis/references/asr-and-fallback.md +20 -0
  415. package/skills/single-work-analysis/references/config-templates/defaults.yaml +58 -0
  416. package/skills/single-work-analysis/references/contracts/work-card-fields.md +41 -0
  417. package/skills/single-work-analysis/references/platform-guides/douyin.md +47 -0
  418. package/skills/single-work-analysis/references/platform-guides/generic.md +43 -0
  419. package/skills/single-work-analysis/references/platform-guides/xiaohongshu.md +54 -0
  420. package/skills/single-work-analysis/references/prompt-contracts/asr-clean.md +28 -0
  421. package/skills/single-work-analysis/references/prompt-contracts/cta.md +24 -0
  422. package/skills/single-work-analysis/references/prompt-contracts/hook.md +25 -0
  423. package/skills/single-work-analysis/references/prompt-contracts/insight.md +47 -0
  424. package/skills/single-work-analysis/references/prompt-contracts/structure.md +25 -0
  425. package/skills/single-work-analysis/references/prompt-contracts/style.md +27 -0
  426. package/skills/single-work-analysis/references/prompt-contracts/summary.md +29 -0
  427. package/skills/single-work-analysis/references/prompt-contracts/topic.md +29 -0
  428. package/skills/single-work-analysis/references/schemas/work-card.schema.json +39 -0
  429. package/skills/single-work-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
  430. package/skills/single-work-analysis/scripts/__init__.py +0 -0
  431. package/skills/single-work-analysis/scripts/core/__init__.py +0 -0
  432. package/skills/single-work-analysis/scripts/core/analysis_pipeline.py +133 -0
  433. package/skills/single-work-analysis/scripts/core/bootstrap_env.py +35 -0
  434. package/skills/single-work-analysis/scripts/core/config_loader.py +418 -0
  435. package/skills/single-work-analysis/scripts/core/extract_pipeline.py +173 -0
  436. package/skills/single-work-analysis/scripts/core/progress_report.py +111 -0
  437. package/skills/single-work-analysis/scripts/core/storage_router.py +253 -0
  438. package/skills/single-work-analysis/scripts/core/tikomni_common.py +588 -0
  439. package/skills/single-work-analysis/scripts/pipeline/__init__.py +0 -0
  440. package/skills/single-work-analysis/scripts/pipeline/asr/__init__.py +0 -0
  441. package/skills/single-work-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
  442. package/skills/single-work-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
  443. package/skills/single-work-analysis/scripts/platform/__init__.py +0 -0
  444. package/skills/single-work-analysis/scripts/platform/douyin/__init__.py +0 -0
  445. package/skills/single-work-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
  446. package/skills/single-work-analysis/scripts/platform/douyin/run_douyin_single_video.py +1233 -0
  447. package/skills/single-work-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
  448. package/skills/single-work-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
  449. package/skills/single-work-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2156 -0
  450. package/skills/single-work-analysis/scripts/writers/__init__.py +0 -0
  451. package/skills/single-work-analysis/scripts/writers/write_benchmark_card.py +1402 -0
@@ -0,0 +1,2516 @@
1
+ # TikTok-Web-API Route Summary
2
+
3
+ - Back to index: [`api-capability-index.md`](../api-capability-index.md)
4
+ - Current tag file: `api-tags/tiktok-web-api.md`
5
+ - Full contract: [`api-contracts/tiktok-web-api.md`](../api-contracts/tiktok-web-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: `58`
9
+ - Common capabilities: general / profiles / accounts / livestream / content details / search / details
10
+ - Default auth: Header `Authorization` Bearer
11
+ - Common inputs: `count`, `cursor`, `cookie`, `secUid`, `url`, `keyword`, `search_id`, `user_agent`, `offset`, `coverFormat`
12
+ - Tag description: **(TikTok-Web-API数据接口/TikTok-Web-API data endpoints)**
13
+
14
+ ## Routes
15
+
16
+ ### `GET /api/u1/v1/tiktok/web/decrypt_strData`
17
+
18
+ - Summary: 解密strData/Decrypt strData
19
+ - Capabilities: general
20
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
21
+ - operationId: `decrypt_strData_api_v1_tiktok_web_decrypt_strData_get`
22
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-decrypt-strdata`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-decrypt-strdata)
23
+
24
+ #### Parameters
25
+
26
+ | Field | In | Type | Required | Description |
27
+ | --- | --- | --- | --- | --- |
28
+ | encrypted_data | query | string | Yes | 加密后的strData字符串/Encrypted strData string |
29
+
30
+ #### Request Body
31
+
32
+ None
33
+
34
+ #### Success Response
35
+
36
+ ##### `200 application/json`
37
+
38
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
39
+
40
+ | Field | Type | Required | Description |
41
+ | --- | --- | --- | --- |
42
+ | code | integer | No | HTTP status code \| HTTP状态码 |
43
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
44
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
45
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
46
+ | support | string | No | Support message \| 支持消息 |
47
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
48
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
49
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
50
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
51
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
52
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
53
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
54
+
55
+ - Fields truncated: this layer shows only the first `12` rows.
56
+
57
+ ### `GET /api/u1/v1/tiktok/web/device_register`
58
+
59
+ - Summary: 设备注册/Register device for TikTok Web
60
+ - Capabilities: general
61
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
62
+ - operationId: `device_register_api_v1_tiktok_web_device_register_get`
63
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-device-register`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-device-register)
64
+
65
+ #### Parameters
66
+
67
+ None
68
+
69
+ #### Request Body
70
+
71
+ None
72
+
73
+ #### Success Response
74
+
75
+ ##### `200 application/json`
76
+
77
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
78
+
79
+ | Field | Type | Required | Description |
80
+ | --- | --- | --- | --- |
81
+ | code | integer | No | HTTP status code \| HTTP状态码 |
82
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
83
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
84
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
85
+ | support | string | No | Support message \| 支持消息 |
86
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
87
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
88
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
89
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
90
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
91
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
92
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
93
+
94
+ - Fields truncated: this layer shows only the first `12` rows.
95
+
96
+ ### `GET /api/u1/v1/tiktok/web/encrypt_strData`
97
+
98
+ - Summary: 加密strData/Encrypt strData
99
+ - Capabilities: general
100
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
101
+ - operationId: `encrypt_strData_api_v1_tiktok_web_encrypt_strData_get`
102
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-encrypt-strdata`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-encrypt-strdata)
103
+
104
+ #### Parameters
105
+
106
+ | Field | In | Type | Required | Description |
107
+ | --- | --- | --- | --- | --- |
108
+ | data | query | string | Yes | 原始指纹数据字符串(JSON格式或字典字符串)/Raw fingerprint data string (JSON format or dict string) |
109
+
110
+ #### Request Body
111
+
112
+ None
113
+
114
+ #### Success Response
115
+
116
+ ##### `200 application/json`
117
+
118
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
119
+
120
+ | Field | Type | Required | Description |
121
+ | --- | --- | --- | --- |
122
+ | code | integer | No | HTTP status code \| HTTP状态码 |
123
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
124
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
125
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
126
+ | support | string | No | Support message \| 支持消息 |
127
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
128
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
129
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
130
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
131
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
132
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
133
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
134
+
135
+ - Fields truncated: this layer shows only the first `12` rows.
136
+
137
+ ### `GET /api/u1/v1/tiktok/web/fetch_batch_check_live_alive`
138
+
139
+ - Summary: 批量直播间开播状态检测/Batch live room start status check
140
+ - Capabilities: livestream
141
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
142
+ - operationId: `fetch_batch_check_live_alive_api_v1_tiktok_web_fetch_batch_check_live_alive_get`
143
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-batch-check-live-alive`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-batch-check-live-alive)
144
+
145
+ #### Parameters
146
+
147
+ | Field | In | Type | Required | Description |
148
+ | --- | --- | --- | --- | --- |
149
+ | room_ids | query | string | Yes | 直播间ID列表,用英文逗号分隔,最多支持50个/Live room ID list separated by commas, up to 50 IDs |
150
+
151
+ #### Request Body
152
+
153
+ None
154
+
155
+ #### Success Response
156
+
157
+ ##### `200 application/json`
158
+
159
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
160
+
161
+ | Field | Type | Required | Description |
162
+ | --- | --- | --- | --- |
163
+ | code | integer | No | HTTP status code \| HTTP状态码 |
164
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
165
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
166
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
167
+ | support | string | No | Support message \| 支持消息 |
168
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
169
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
170
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
171
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
172
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
173
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
174
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
175
+
176
+ - Fields truncated: this layer shows only the first `12` rows.
177
+
178
+ ### `GET /api/u1/v1/tiktok/web/fetch_check_live_alive`
179
+
180
+ - Summary: 直播间开播状态检测/Live room start status check
181
+ - Capabilities: livestream
182
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
183
+ - operationId: `fetch_check_live_alive_api_v1_tiktok_web_fetch_check_live_alive_get`
184
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-check-live-alive`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-check-live-alive)
185
+
186
+ #### Parameters
187
+
188
+ | Field | In | Type | Required | Description |
189
+ | --- | --- | --- | --- | --- |
190
+ | room_id | query | string | Yes | 直播间ID/Live room ID |
191
+
192
+ #### Request Body
193
+
194
+ None
195
+
196
+ #### Success Response
197
+
198
+ ##### `200 application/json`
199
+
200
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
201
+
202
+ | Field | Type | Required | Description |
203
+ | --- | --- | --- | --- |
204
+ | code | integer | No | HTTP status code \| HTTP状态码 |
205
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
206
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
207
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
208
+ | support | string | No | Support message \| 支持消息 |
209
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
210
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
211
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
212
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
213
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
214
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
215
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
216
+
217
+ - Fields truncated: this layer shows only the first `12` rows.
218
+
219
+ ### `GET /api/u1/v1/tiktok/web/fetch_explore_post`
220
+
221
+ - Summary: 获取探索作品数据/Get explore video data
222
+ - Capabilities: content details
223
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
224
+ - operationId: `fetch_explore_post_api_v1_tiktok_web_fetch_explore_post_get`
225
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-explore-post`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-explore-post)
226
+
227
+ #### Parameters
228
+
229
+ | Field | In | Type | Required | Description |
230
+ | --- | --- | --- | --- | --- |
231
+ | categoryType | query | string | No | 作品分类/Video category |
232
+ | count | query | integer | No | 每页数量/Number per page |
233
+
234
+ #### Request Body
235
+
236
+ None
237
+
238
+ #### Success Response
239
+
240
+ ##### `200 application/json`
241
+
242
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
243
+
244
+ | Field | Type | Required | Description |
245
+ | --- | --- | --- | --- |
246
+ | code | integer | No | HTTP status code \| HTTP状态码 |
247
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
248
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
249
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
250
+ | support | string | No | Support message \| 支持消息 |
251
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
252
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
253
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
254
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
255
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
256
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
257
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
258
+
259
+ - Fields truncated: this layer shows only the first `12` rows.
260
+
261
+ ### `GET /api/u1/v1/tiktok/web/fetch_general_search`
262
+
263
+ - Summary: 获取综合搜索列表/Get general search list
264
+ - Capabilities: search
265
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
266
+ - operationId: `fetch_general_search_api_v1_tiktok_web_fetch_general_search_get`
267
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-general-search`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-general-search)
268
+
269
+ #### Parameters
270
+
271
+ | Field | In | Type | Required | Description |
272
+ | --- | --- | --- | --- | --- |
273
+ | keyword | query | string | Yes | 搜索关键词/Search keyword |
274
+ | offset | query | integer | No | 翻页游标/Page cursor |
275
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging |
276
+ | cookie | query | string | No | 用户cookie(按需提供)/User cookie(if needed) |
277
+
278
+ #### Request Body
279
+
280
+ None
281
+
282
+ #### Success Response
283
+
284
+ ##### `200 application/json`
285
+
286
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
287
+
288
+ | Field | Type | Required | Description |
289
+ | --- | --- | --- | --- |
290
+ | code | integer | No | HTTP status code \| HTTP状态码 |
291
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
292
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
293
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
294
+ | support | string | No | Support message \| 支持消息 |
295
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
296
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
297
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
298
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
299
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
300
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
301
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
302
+
303
+ - Fields truncated: this layer shows only the first `12` rows.
304
+
305
+ ### `POST /api/u1/v1/tiktok/web/fetch_gift_name_by_id`
306
+
307
+ - Summary: 根据Gift ID查询礼物名称/Get gift name by gift ID
308
+ - Capabilities: general
309
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
310
+ - operationId: `fetch_gift_name_by_id_api_v1_tiktok_web_fetch_gift_name_by_id_post`
311
+ - Full contract: [`api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-fetch-gift-name-by-id`](../api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-fetch-gift-name-by-id)
312
+
313
+ #### Parameters
314
+
315
+ None
316
+
317
+ #### Request Body
318
+
319
+ - required: Yes
320
+
321
+ ##### `application/json`
322
+
323
+ - Schema summary: `gift_id*`:string
324
+
325
+ | Field | Type | Required | Description |
326
+ | --- | --- | --- | --- |
327
+ | gift_id | string | Yes | 礼物ID \| Gift ID |
328
+
329
+ #### Success Response
330
+
331
+ ##### `200 application/json`
332
+
333
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
334
+
335
+ | Field | Type | Required | Description |
336
+ | --- | --- | --- | --- |
337
+ | code | integer | No | HTTP status code \| HTTP状态码 |
338
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
339
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
340
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
341
+ | support | string | No | Support message \| 支持消息 |
342
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
343
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
344
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
345
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
346
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
347
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
348
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
349
+
350
+ - Fields truncated: this layer shows only the first `12` rows.
351
+
352
+ ### `POST /api/u1/v1/tiktok/web/fetch_gift_names_by_ids`
353
+
354
+ - Summary: 批量查询Gift ID对应的礼物名称($0.025/次,建议50个)/Batch get gift names by gift IDs ($0.025/call, suggest 50)
355
+ - Capabilities: general
356
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
357
+ - operationId: `fetch_gift_names_by_ids_api_v1_tiktok_web_fetch_gift_names_by_ids_post`
358
+ - Full contract: [`api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-fetch-gift-names-by-ids`](../api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-fetch-gift-names-by-ids)
359
+
360
+ #### Parameters
361
+
362
+ None
363
+
364
+ #### Request Body
365
+
366
+ - required: Yes
367
+
368
+ ##### `application/json`
369
+
370
+ - Schema summary: `gift_ids*`[string]
371
+
372
+ | Field | Type | Required | Description |
373
+ | --- | --- | --- | --- |
374
+ | gift_ids | array<string> | Yes | 礼物ID列表,建议50个/次获得最佳性价比($0.025),超过50个时自动处理前50个 \| Gift ID list, recommend 50/call for best value ($0.025), auto-process fi… |
375
+
376
+ #### Success Response
377
+
378
+ ##### `200 application/json`
379
+
380
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
381
+
382
+ | Field | Type | Required | Description |
383
+ | --- | --- | --- | --- |
384
+ | code | integer | No | HTTP status code \| HTTP状态码 |
385
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
386
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
387
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
388
+ | support | string | No | Support message \| 支持消息 |
389
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
390
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
391
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
392
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
393
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
394
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
395
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
396
+
397
+ - Fields truncated: this layer shows only the first `12` rows.
398
+
399
+ ### `POST /api/u1/v1/tiktok/web/fetch_home_feed`
400
+
401
+ - Summary: 首页推荐作品/Home Feed
402
+ - Capabilities: profiles / accounts
403
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
404
+ - operationId: `fetch_home_feed_api_v1_tiktok_web_fetch_home_feed_post`
405
+ - Full contract: [`api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-fetch-home-feed`](../api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-fetch-home-feed)
406
+
407
+ #### Parameters
408
+
409
+ None
410
+
411
+ #### Request Body
412
+
413
+ - required: No
414
+
415
+ ##### `application/json`
416
+
417
+ - Schema summary: `count`:integer, `cookie`:string
418
+
419
+ | Field | Type | Required | Description |
420
+ | --- | --- | --- | --- |
421
+ | count | integer | No | 每页数量/Number per page |
422
+ | cookie | string | No | 用户自己的cookie,可选参数,用于接口返回数据的个性化推荐。/ User's own cookie, optional parameter, used for personalized recommendations of inter… |
423
+
424
+ #### Success Response
425
+
426
+ ##### `200 application/json`
427
+
428
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
429
+
430
+ | Field | Type | Required | Description |
431
+ | --- | --- | --- | --- |
432
+ | code | integer | No | HTTP status code \| HTTP状态码 |
433
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
434
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
435
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
436
+ | support | string | No | Support message \| 支持消息 |
437
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
438
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
439
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
440
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
441
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
442
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
443
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
444
+
445
+ - Fields truncated: this layer shows only the first `12` rows.
446
+
447
+ ### `GET /api/u1/v1/tiktok/web/fetch_live_gift_list`
448
+
449
+ - Summary: 获取直播间礼物列表/Get live room gift list
450
+ - Capabilities: livestream
451
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
452
+ - operationId: `fetch_live_gift_list_api_v1_tiktok_web_fetch_live_gift_list_get`
453
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-live-gift-list`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-live-gift-list)
454
+
455
+ #### Parameters
456
+
457
+ | Field | In | Type | Required | Description |
458
+ | --- | --- | --- | --- | --- |
459
+ | room_id | query | string | No | 直播间ID,可选参数/Live room ID, optional parameter |
460
+
461
+ #### Request Body
462
+
463
+ None
464
+
465
+ #### Success Response
466
+
467
+ ##### `200 application/json`
468
+
469
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
470
+
471
+ | Field | Type | Required | Description |
472
+ | --- | --- | --- | --- |
473
+ | code | integer | No | HTTP status code \| HTTP状态码 |
474
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
475
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
476
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
477
+ | support | string | No | Support message \| 支持消息 |
478
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
479
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
480
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
481
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
482
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
483
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
484
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
485
+
486
+ - Fields truncated: this layer shows only the first `12` rows.
487
+
488
+ ### `GET /api/u1/v1/tiktok/web/fetch_live_im_fetch`
489
+
490
+ - Summary: TikTok直播间弹幕参数获取/tiktok live room danmaku parameters
491
+ - Capabilities: livestream
492
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
493
+ - operationId: `fetch_live_im_fetch_api_v1_tiktok_web_fetch_live_im_fetch_get`
494
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-live-im-fetch`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-live-im-fetch)
495
+
496
+ #### Parameters
497
+
498
+ | Field | In | Type | Required | Description |
499
+ | --- | --- | --- | --- | --- |
500
+ | room_id | query | string | Yes | 直播间号/Live room id |
501
+ | user_unique_id | query | string | Yes | 用户唯一ID/User unique ID |
502
+
503
+ #### Request Body
504
+
505
+ None
506
+
507
+ #### Success Response
508
+
509
+ ##### `200 application/json`
510
+
511
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
512
+
513
+ | Field | Type | Required | Description |
514
+ | --- | --- | --- | --- |
515
+ | code | integer | No | HTTP status code \| HTTP状态码 |
516
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
517
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
518
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
519
+ | support | string | No | Support message \| 支持消息 |
520
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
521
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
522
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
523
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
524
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
525
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
526
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
527
+
528
+ - Fields truncated: this layer shows only the first `12` rows.
529
+
530
+ ### `GET /api/u1/v1/tiktok/web/fetch_live_recommend`
531
+
532
+ - Summary: 获取直播间首页推荐列表/Get live room homepage recommendation list
533
+ - Capabilities: livestream
534
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
535
+ - operationId: `fetch_live_recommend_api_v1_tiktok_web_fetch_live_recommend_get`
536
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-live-recommend`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-live-recommend)
537
+
538
+ #### Parameters
539
+
540
+ | Field | In | Type | Required | Description |
541
+ | --- | --- | --- | --- | --- |
542
+ | related_live_tag | query | string | Yes | 相关直播标签/Related live tag |
543
+
544
+ #### Request Body
545
+
546
+ None
547
+
548
+ #### Success Response
549
+
550
+ ##### `200 application/json`
551
+
552
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
553
+
554
+ | Field | Type | Required | Description |
555
+ | --- | --- | --- | --- |
556
+ | code | integer | No | HTTP status code \| HTTP状态码 |
557
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
558
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
559
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
560
+ | support | string | No | Support message \| 支持消息 |
561
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
562
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
563
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
564
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
565
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
566
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
567
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
568
+
569
+ - Fields truncated: this layer shows only the first `12` rows.
570
+
571
+ ### `GET /api/u1/v1/tiktok/web/fetch_post_comment`
572
+
573
+ - Summary: 获取作品的评论列表/Get video comments
574
+ - Capabilities: comments / content details
575
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
576
+ - operationId: `fetch_post_comment_api_v1_tiktok_web_fetch_post_comment_get`
577
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-post-comment`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-post-comment)
578
+
579
+ #### Parameters
580
+
581
+ | Field | In | Type | Required | Description |
582
+ | --- | --- | --- | --- | --- |
583
+ | aweme_id | query | string | Yes | 作品id/Video id |
584
+ | cursor | query | integer | No | 翻页游标/Page cursor |
585
+ | count | query | integer | No | 每页数量/Number per page |
586
+ | current_region | query | string | No | 当前地区/Current region |
587
+
588
+ #### Request Body
589
+
590
+ None
591
+
592
+ #### Success Response
593
+
594
+ ##### `200 application/json`
595
+
596
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
597
+
598
+ | Field | Type | Required | Description |
599
+ | --- | --- | --- | --- |
600
+ | code | integer | No | HTTP status code \| HTTP状态码 |
601
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
602
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
603
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
604
+ | support | string | No | Support message \| 支持消息 |
605
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
606
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
607
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
608
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
609
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
610
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
611
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
612
+
613
+ - Fields truncated: this layer shows only the first `12` rows.
614
+
615
+ ### `GET /api/u1/v1/tiktok/web/fetch_post_comment_reply`
616
+
617
+ - Summary: 获取作品的评论回复列表/Get video comment replies
618
+ - Capabilities: comments / comment replies / content details
619
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
620
+ - operationId: `fetch_post_comment_reply_api_v1_tiktok_web_fetch_post_comment_reply_get`
621
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-post-comment-reply`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-post-comment-reply)
622
+
623
+ #### Parameters
624
+
625
+ | Field | In | Type | Required | Description |
626
+ | --- | --- | --- | --- | --- |
627
+ | item_id | query | string | Yes | 作品id/Video id |
628
+ | comment_id | query | string | Yes | 评论id/Comment id |
629
+ | cursor | query | integer | No | 翻页游标/Page cursor |
630
+ | count | query | integer | No | 每页数量/Number per page |
631
+ | current_region | query | string | No | 当前地区/Current region |
632
+
633
+ #### Request Body
634
+
635
+ None
636
+
637
+ #### Success Response
638
+
639
+ ##### `200 application/json`
640
+
641
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
642
+
643
+ | Field | Type | Required | Description |
644
+ | --- | --- | --- | --- |
645
+ | code | integer | No | HTTP status code \| HTTP状态码 |
646
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
647
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
648
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
649
+ | support | string | No | Support message \| 支持消息 |
650
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
651
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
652
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
653
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
654
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
655
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
656
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
657
+
658
+ - Fields truncated: this layer shows only the first `12` rows.
659
+
660
+ ### `GET /api/u1/v1/tiktok/web/fetch_post_detail`
661
+
662
+ - Summary: 获取单个作品数据/Get single video data
663
+ - Capabilities: content details / details
664
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
665
+ - operationId: `fetch_post_detail_api_v1_tiktok_web_fetch_post_detail_get`
666
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-post-detail`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-post-detail)
667
+
668
+ #### Parameters
669
+
670
+ | Field | In | Type | Required | Description |
671
+ | --- | --- | --- | --- | --- |
672
+ | itemId | query | string | Yes | 作品id/Video id |
673
+
674
+ #### Request Body
675
+
676
+ None
677
+
678
+ #### Success Response
679
+
680
+ ##### `200 application/json`
681
+
682
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
683
+
684
+ | Field | Type | Required | Description |
685
+ | --- | --- | --- | --- |
686
+ | code | integer | No | HTTP status code \| HTTP状态码 |
687
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
688
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
689
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
690
+ | support | string | No | Support message \| 支持消息 |
691
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
692
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
693
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
694
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
695
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
696
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
697
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
698
+
699
+ - Fields truncated: this layer shows only the first `12` rows.
700
+
701
+ ### `GET /api/u1/v1/tiktok/web/fetch_post_detail_v2`
702
+
703
+ - Summary: 获取单个作品数据 V2/Get single video data V2
704
+ - Capabilities: content details / details
705
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
706
+ - operationId: `fetch_post_detail_v2_api_v1_tiktok_web_fetch_post_detail_v2_get`
707
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-post-detail-v2`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-post-detail-v2)
708
+
709
+ #### Parameters
710
+
711
+ | Field | In | Type | Required | Description |
712
+ | --- | --- | --- | --- | --- |
713
+ | itemId | query | string | Yes | 作品id/Video id |
714
+
715
+ #### Request Body
716
+
717
+ None
718
+
719
+ #### Success Response
720
+
721
+ ##### `200 application/json`
722
+
723
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
724
+
725
+ | Field | Type | Required | Description |
726
+ | --- | --- | --- | --- |
727
+ | code | integer | No | HTTP status code \| HTTP状态码 |
728
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
729
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
730
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
731
+ | support | string | No | Support message \| 支持消息 |
732
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
733
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
734
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
735
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
736
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
737
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
738
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
739
+
740
+ - Fields truncated: this layer shows only the first `12` rows.
741
+
742
+ ### `GET /api/u1/v1/tiktok/web/fetch_search_keyword_suggest`
743
+
744
+ - Summary: 搜索关键字推荐/Search keyword suggest
745
+ - Capabilities: search
746
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
747
+ - operationId: `fetch_search_keyword_suggest_api_v1_tiktok_web_fetch_search_keyword_suggest_get`
748
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-search-keyword-suggest`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-search-keyword-suggest)
749
+
750
+ #### Parameters
751
+
752
+ | Field | In | Type | Required | Description |
753
+ | --- | --- | --- | --- | --- |
754
+ | keyword | query | string | Yes | 搜索关键词/Search keyword |
755
+
756
+ #### Request Body
757
+
758
+ None
759
+
760
+ #### Success Response
761
+
762
+ ##### `200 application/json`
763
+
764
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
765
+
766
+ | Field | Type | Required | Description |
767
+ | --- | --- | --- | --- |
768
+ | code | integer | No | HTTP status code \| HTTP状态码 |
769
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
770
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
771
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
772
+ | support | string | No | Support message \| 支持消息 |
773
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
774
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
775
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
776
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
777
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
778
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
779
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
780
+
781
+ - Fields truncated: this layer shows only the first `12` rows.
782
+
783
+ ### `GET /api/u1/v1/tiktok/web/fetch_search_live`
784
+
785
+ - Summary: 搜索直播/Search live
786
+ - Capabilities: search / livestream
787
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
788
+ - operationId: `fetch_search_live_api_v1_tiktok_web_fetch_search_live_get`
789
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-search-live`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-search-live)
790
+
791
+ #### Parameters
792
+
793
+ | Field | In | Type | Required | Description |
794
+ | --- | --- | --- | --- | --- |
795
+ | keyword | query | string | Yes | 搜索关键词/Search keyword |
796
+ | count | query | integer | No | 每页数量/Number per page |
797
+ | offset | query | integer | No | 翻页游标/Page cursor |
798
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging |
799
+ | cookie | query | string | No | 用户cookie(按需提供)/User cookie(if needed) |
800
+
801
+ #### Request Body
802
+
803
+ None
804
+
805
+ #### Success Response
806
+
807
+ ##### `200 application/json`
808
+
809
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
810
+
811
+ | Field | Type | Required | Description |
812
+ | --- | --- | --- | --- |
813
+ | code | integer | No | HTTP status code \| HTTP状态码 |
814
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
815
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
816
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
817
+ | support | string | No | Support message \| 支持消息 |
818
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
819
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
820
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
821
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
822
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
823
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
824
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
825
+
826
+ - Fields truncated: this layer shows only the first `12` rows.
827
+
828
+ ### `GET /api/u1/v1/tiktok/web/fetch_search_photo`
829
+
830
+ - Summary: 搜索照片/Search photo
831
+ - Capabilities: search / trends / rankings
832
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
833
+ - operationId: `fetch_search_photo_api_v1_tiktok_web_fetch_search_photo_get`
834
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-search-photo`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-search-photo)
835
+
836
+ #### Parameters
837
+
838
+ | Field | In | Type | Required | Description |
839
+ | --- | --- | --- | --- | --- |
840
+ | keyword | query | string | Yes | 搜索关键词/Search keyword |
841
+ | count | query | integer | No | 每页数量/Number per page |
842
+ | offset | query | integer | No | 翻页游标/Page offset |
843
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging |
844
+ | cookie | query | string | No | 用户cookie(按需提供)/User cookie(if needed) |
845
+
846
+ #### Request Body
847
+
848
+ None
849
+
850
+ #### Success Response
851
+
852
+ ##### `200 application/json`
853
+
854
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
855
+
856
+ | Field | Type | Required | Description |
857
+ | --- | --- | --- | --- |
858
+ | code | integer | No | HTTP status code \| HTTP状态码 |
859
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
860
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
861
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
862
+ | support | string | No | Support message \| 支持消息 |
863
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
864
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
865
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
866
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
867
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
868
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
869
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
870
+
871
+ - Fields truncated: this layer shows only the first `12` rows.
872
+
873
+ ### `GET /api/u1/v1/tiktok/web/fetch_search_user`
874
+
875
+ - Summary: 搜索用户/Search user
876
+ - Capabilities: search / profiles / accounts
877
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
878
+ - operationId: `fetch_search_user_api_v1_tiktok_web_fetch_search_user_get`
879
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-search-user`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-search-user)
880
+
881
+ #### Parameters
882
+
883
+ | Field | In | Type | Required | Description |
884
+ | --- | --- | --- | --- | --- |
885
+ | keyword | query | string | Yes | 搜索关键词/Search keyword |
886
+ | cursor | query | integer | No | 翻页游标/Page cursor |
887
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging |
888
+ | cookie | query | string | No | 用户cookie(按需提供)/User cookie(if needed) |
889
+
890
+ #### Request Body
891
+
892
+ None
893
+
894
+ #### Success Response
895
+
896
+ ##### `200 application/json`
897
+
898
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
899
+
900
+ | Field | Type | Required | Description |
901
+ | --- | --- | --- | --- |
902
+ | code | integer | No | HTTP status code \| HTTP状态码 |
903
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
904
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
905
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
906
+ | support | string | No | Support message \| 支持消息 |
907
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
908
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
909
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
910
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
911
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
912
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
913
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
914
+
915
+ - Fields truncated: this layer shows only the first `12` rows.
916
+
917
+ ### `GET /api/u1/v1/tiktok/web/fetch_search_video`
918
+
919
+ - Summary: 搜索视频/Search video
920
+ - Capabilities: search / content details
921
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
922
+ - operationId: `fetch_search_video_api_v1_tiktok_web_fetch_search_video_get`
923
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-search-video`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-search-video)
924
+
925
+ #### Parameters
926
+
927
+ | Field | In | Type | Required | Description |
928
+ | --- | --- | --- | --- | --- |
929
+ | keyword | query | string | Yes | 搜索关键词/Search keyword |
930
+ | count | query | integer | No | 每页数量/Number per page |
931
+ | offset | query | integer | No | 翻页游标/Page cursor |
932
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging |
933
+ | cookie | query | string | No | 用户cookie(按需提供)/User cookie(if needed) |
934
+
935
+ #### Request Body
936
+
937
+ None
938
+
939
+ #### Success Response
940
+
941
+ ##### `200 application/json`
942
+
943
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
944
+
945
+ | Field | Type | Required | Description |
946
+ | --- | --- | --- | --- |
947
+ | code | integer | No | HTTP status code \| HTTP状态码 |
948
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
949
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
950
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
951
+ | support | string | No | Support message \| 支持消息 |
952
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
953
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
954
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
955
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
956
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
957
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
958
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
959
+
960
+ - Fields truncated: this layer shows only the first `12` rows.
961
+
962
+ ### `GET /api/u1/v1/tiktok/web/fetch_sso_login_auth`
963
+
964
+ - Summary: 认证SSO登录/Authenticate SSO login
965
+ - Capabilities: general
966
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
967
+ - operationId: `fetch_sso_login_auth_api_v1_tiktok_web_fetch_sso_login_auth_get`
968
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-sso-login-auth`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-sso-login-auth)
969
+
970
+ #### Parameters
971
+
972
+ | Field | In | Type | Required | Description |
973
+ | --- | --- | --- | --- | --- |
974
+ | device_id | query | string | Yes | 设备ID/Device ID |
975
+ | verifyFp | query | string | Yes | verifyFp |
976
+ | region | query | string | Yes | 地区/Region |
977
+ | proxy | query | string | Yes | 代理/Proxy |
978
+
979
+ #### Request Body
980
+
981
+ None
982
+
983
+ #### Success Response
984
+
985
+ ##### `200 application/json`
986
+
987
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
988
+
989
+ | Field | Type | Required | Description |
990
+ | --- | --- | --- | --- |
991
+ | code | integer | No | HTTP status code \| HTTP状态码 |
992
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
993
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
994
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
995
+ | support | string | No | Support message \| 支持消息 |
996
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
997
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
998
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
999
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1000
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1001
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1002
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1003
+
1004
+ - Fields truncated: this layer shows only the first `12` rows.
1005
+
1006
+ ### `GET /api/u1/v1/tiktok/web/fetch_sso_login_qrcode`
1007
+
1008
+ - Summary: 获取SSO登录二维码/Get SSO login QR code
1009
+ - Capabilities: general
1010
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1011
+ - operationId: `fetch_sso_login_qrcode_api_v1_tiktok_web_fetch_sso_login_qrcode_get`
1012
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-sso-login-qrcode`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-sso-login-qrcode)
1013
+
1014
+ #### Parameters
1015
+
1016
+ | Field | In | Type | Required | Description |
1017
+ | --- | --- | --- | --- | --- |
1018
+ | device_id | query | string | Yes | 设备ID/Device ID |
1019
+ | region | query | string | Yes | 地区/Region |
1020
+ | proxy | query | string | Yes | 代理/Proxy |
1021
+
1022
+ #### Request Body
1023
+
1024
+ None
1025
+
1026
+ #### Success Response
1027
+
1028
+ ##### `200 application/json`
1029
+
1030
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1031
+
1032
+ | Field | Type | Required | Description |
1033
+ | --- | --- | --- | --- |
1034
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1035
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1036
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1037
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1038
+ | support | string | No | Support message \| 支持消息 |
1039
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1040
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1041
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1042
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1043
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1044
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1045
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1046
+
1047
+ - Fields truncated: this layer shows only the first `12` rows.
1048
+
1049
+ ### `GET /api/u1/v1/tiktok/web/fetch_sso_login_status`
1050
+
1051
+ - Summary: 获取SSO登录状态/Get SSO login status
1052
+ - Capabilities: general
1053
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1054
+ - operationId: `fetch_sso_login_status_api_v1_tiktok_web_fetch_sso_login_status_get`
1055
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-sso-login-status`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-sso-login-status)
1056
+
1057
+ #### Parameters
1058
+
1059
+ | Field | In | Type | Required | Description |
1060
+ | --- | --- | --- | --- | --- |
1061
+ | token | query | string | Yes | 登录令牌/Login token |
1062
+ | device_id | query | string | Yes | 设备ID/Device ID |
1063
+ | verifyFp | query | string | Yes | verifyFp |
1064
+ | region | query | string | Yes | 地区/Region |
1065
+ | proxy | query | string | Yes | 代理/Proxy |
1066
+
1067
+ #### Request Body
1068
+
1069
+ None
1070
+
1071
+ #### Success Response
1072
+
1073
+ ##### `200 application/json`
1074
+
1075
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1076
+
1077
+ | Field | Type | Required | Description |
1078
+ | --- | --- | --- | --- |
1079
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1080
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1081
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1082
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1083
+ | support | string | No | Support message \| 支持消息 |
1084
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1085
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1086
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1087
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1088
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1089
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1090
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1091
+
1092
+ - Fields truncated: this layer shows only the first `12` rows.
1093
+
1094
+ ### `GET /api/u1/v1/tiktok/web/fetch_tag_detail`
1095
+
1096
+ - Summary: Tag详情/Tag Detail
1097
+ - Capabilities: details
1098
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1099
+ - operationId: `fetch_tag_detail_api_v1_tiktok_web_fetch_tag_detail_get`
1100
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-tag-detail`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-tag-detail)
1101
+
1102
+ #### Parameters
1103
+
1104
+ | Field | In | Type | Required | Description |
1105
+ | --- | --- | --- | --- | --- |
1106
+ | tag_name | query | string | Yes | Tag名称/Tag name |
1107
+
1108
+ #### Request Body
1109
+
1110
+ None
1111
+
1112
+ #### Success Response
1113
+
1114
+ ##### `200 application/json`
1115
+
1116
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1117
+
1118
+ | Field | Type | Required | Description |
1119
+ | --- | --- | --- | --- |
1120
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1121
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1122
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1123
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1124
+ | support | string | No | Support message \| 支持消息 |
1125
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1126
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1127
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1128
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1129
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1130
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1131
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1132
+
1133
+ - Fields truncated: this layer shows only the first `12` rows.
1134
+
1135
+ ### `GET /api/u1/v1/tiktok/web/fetch_tag_post`
1136
+
1137
+ - Summary: Tag作品/Tag Post
1138
+ - Capabilities: content details
1139
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1140
+ - operationId: `fetch_tag_post_api_v1_tiktok_web_fetch_tag_post_get`
1141
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-tag-post`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-tag-post)
1142
+
1143
+ #### Parameters
1144
+
1145
+ | Field | In | Type | Required | Description |
1146
+ | --- | --- | --- | --- | --- |
1147
+ | challengeID | query | string | Yes | Tag ID |
1148
+ | count | query | integer | No | 每页数量/Number per page |
1149
+ | cursor | query | integer | No | 翻页游标/Page cursor |
1150
+
1151
+ #### Request Body
1152
+
1153
+ None
1154
+
1155
+ #### Success Response
1156
+
1157
+ ##### `200 application/json`
1158
+
1159
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1160
+
1161
+ | Field | Type | Required | Description |
1162
+ | --- | --- | --- | --- |
1163
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1164
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1165
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1166
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1167
+ | support | string | No | Support message \| 支持消息 |
1168
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1169
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1170
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1171
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1172
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1173
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1174
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1175
+
1176
+ - Fields truncated: this layer shows only the first `12` rows.
1177
+
1178
+ ### `GET /api/u1/v1/tiktok/web/fetch_tiktok_live_data`
1179
+
1180
+ - Summary: 通过直播链接获取直播间信息/Get live room information via live link
1181
+ - Capabilities: livestream
1182
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1183
+ - operationId: `fetch_tiktok_live_data_api_v1_tiktok_web_fetch_tiktok_live_data_get`
1184
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-tiktok-live-data`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-tiktok-live-data)
1185
+
1186
+ #### Parameters
1187
+
1188
+ | Field | In | Type | Required | Description |
1189
+ | --- | --- | --- | --- | --- |
1190
+ | live_room_url | query | string | Yes | 直播间链接/Live room link |
1191
+
1192
+ #### Request Body
1193
+
1194
+ None
1195
+
1196
+ #### Success Response
1197
+
1198
+ ##### `200 application/json`
1199
+
1200
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1201
+
1202
+ | Field | Type | Required | Description |
1203
+ | --- | --- | --- | --- |
1204
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1205
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1206
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1207
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1208
+ | support | string | No | Support message \| 支持消息 |
1209
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1210
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1211
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1212
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1213
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1214
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1215
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1216
+
1217
+ - Fields truncated: this layer shows only the first `12` rows.
1218
+
1219
+ ### `GET /api/u1/v1/tiktok/web/fetch_tiktok_web_guest_cookie`
1220
+
1221
+ - Summary: 获取游客 Cookie/Get the guest Cookie
1222
+ - Capabilities: general
1223
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1224
+ - operationId: `fetch_tiktok_web_guest_cookie_api_v1_tiktok_web_fetch_tiktok_web_guest_cookie_get`
1225
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-tiktok-web-guest-cookie`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-tiktok-web-guest-cookie)
1226
+
1227
+ #### Parameters
1228
+
1229
+ | Field | In | Type | Required | Description |
1230
+ | --- | --- | --- | --- | --- |
1231
+ | user_agent | query | string | Yes | 用户浏览器代理/User browser agent |
1232
+
1233
+ #### Request Body
1234
+
1235
+ None
1236
+
1237
+ #### Success Response
1238
+
1239
+ ##### `200 application/json`
1240
+
1241
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1242
+
1243
+ | Field | Type | Required | Description |
1244
+ | --- | --- | --- | --- |
1245
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1246
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1247
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1248
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1249
+ | support | string | No | Support message \| 支持消息 |
1250
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1251
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1252
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1253
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1254
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1255
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1256
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1257
+
1258
+ - Fields truncated: this layer shows only the first `12` rows.
1259
+
1260
+ ### `GET /api/u1/v1/tiktok/web/fetch_trending_post`
1261
+
1262
+ - Summary: 获取每日热门内容作品数据/Get daily trending video data
1263
+ - Capabilities: trends / rankings / content details
1264
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1265
+ - operationId: `fetch_trending_post_api_v1_tiktok_web_fetch_trending_post_get`
1266
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-trending-post`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-trending-post)
1267
+
1268
+ #### Parameters
1269
+
1270
+ None
1271
+
1272
+ #### Request Body
1273
+
1274
+ None
1275
+
1276
+ #### Success Response
1277
+
1278
+ ##### `200 application/json`
1279
+
1280
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1281
+
1282
+ | Field | Type | Required | Description |
1283
+ | --- | --- | --- | --- |
1284
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1285
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1286
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1287
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1288
+ | support | string | No | Support message \| 支持消息 |
1289
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1290
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1291
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1292
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1293
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1294
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1295
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1296
+
1297
+ - Fields truncated: this layer shows only the first `12` rows.
1298
+
1299
+ ### `GET /api/u1/v1/tiktok/web/fetch_trending_searchwords`
1300
+
1301
+ - Summary: 获取每日趋势搜索关键词/Get daily trending search words
1302
+ - Capabilities: search / trends / rankings
1303
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1304
+ - operationId: `fetch_trending_searchwords_api_v1_tiktok_web_fetch_trending_searchwords_get`
1305
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-trending-searchwords`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-trending-searchwords)
1306
+
1307
+ #### Parameters
1308
+
1309
+ None
1310
+
1311
+ #### Request Body
1312
+
1313
+ None
1314
+
1315
+ #### Success Response
1316
+
1317
+ ##### `200 application/json`
1318
+
1319
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1320
+
1321
+ | Field | Type | Required | Description |
1322
+ | --- | --- | --- | --- |
1323
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1324
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1325
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1326
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1327
+ | support | string | No | Support message \| 支持消息 |
1328
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1329
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1330
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1331
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1332
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1333
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1334
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1335
+
1336
+ - Fields truncated: this layer shows only the first `12` rows.
1337
+
1338
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_collect`
1339
+
1340
+ - Summary: 获取用户的收藏列表/Get user favorites
1341
+ - Capabilities: profiles / accounts
1342
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1343
+ - operationId: `fetch_user_collect_api_v1_tiktok_web_fetch_user_collect_get`
1344
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-collect`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-collect)
1345
+
1346
+ #### Parameters
1347
+
1348
+ | Field | In | Type | Required | Description |
1349
+ | --- | --- | --- | --- | --- |
1350
+ | cookie | query | string | Yes | 用户cookie/User cookie |
1351
+ | secUid | query | string | Yes | 用户secUid/User secUid |
1352
+ | cursor | query | integer | No | 翻页游标/Page cursor |
1353
+ | count | query | integer | No | 每页数量/Number per page |
1354
+ | coverFormat | query | integer | No | 封面格式/Cover format |
1355
+
1356
+ #### Request Body
1357
+
1358
+ None
1359
+
1360
+ #### Success Response
1361
+
1362
+ ##### `200 application/json`
1363
+
1364
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1365
+
1366
+ | Field | Type | Required | Description |
1367
+ | --- | --- | --- | --- |
1368
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1369
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1370
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1371
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1372
+ | support | string | No | Support message \| 支持消息 |
1373
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1374
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1375
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1376
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1377
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1378
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1379
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1380
+
1381
+ - Fields truncated: this layer shows only the first `12` rows.
1382
+
1383
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_fans`
1384
+
1385
+ - Summary: 获取用户的粉丝列表/Get user followers
1386
+ - Capabilities: profiles / accounts
1387
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1388
+ - operationId: `fetch_user_fans_api_v1_tiktok_web_fetch_user_fans_get`
1389
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-fans`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-fans)
1390
+
1391
+ #### Parameters
1392
+
1393
+ | Field | In | Type | Required | Description |
1394
+ | --- | --- | --- | --- | --- |
1395
+ | secUid | query | string | Yes | 用户secUid/User secUid |
1396
+ | count | query | integer | No | 每页数量/Number per page |
1397
+ | maxCursor | query | integer | No | 最大游标/Max cursor |
1398
+ | minCursor | query | integer | No | 最小游标/Min cursor |
1399
+
1400
+ #### Request Body
1401
+
1402
+ None
1403
+
1404
+ #### Success Response
1405
+
1406
+ ##### `200 application/json`
1407
+
1408
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1409
+
1410
+ | Field | Type | Required | Description |
1411
+ | --- | --- | --- | --- |
1412
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1413
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1414
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1415
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1416
+ | support | string | No | Support message \| 支持消息 |
1417
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1418
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1419
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1420
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1421
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1422
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1423
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1424
+
1425
+ - Fields truncated: this layer shows only the first `12` rows.
1426
+
1427
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_follow`
1428
+
1429
+ - Summary: 获取用户的关注列表/Get user followings
1430
+ - Capabilities: profiles / accounts
1431
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1432
+ - operationId: `fetch_user_follow_api_v1_tiktok_web_fetch_user_follow_get`
1433
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-follow`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-follow)
1434
+
1435
+ #### Parameters
1436
+
1437
+ | Field | In | Type | Required | Description |
1438
+ | --- | --- | --- | --- | --- |
1439
+ | secUid | query | string | Yes | 用户secUid/User secUid |
1440
+ | count | query | integer | No | 每页数量/Number per page |
1441
+ | maxCursor | query | integer | No | 最大游标/Max cursor |
1442
+ | minCursor | query | integer | No | 最小游标/Min cursor |
1443
+
1444
+ #### Request Body
1445
+
1446
+ None
1447
+
1448
+ #### Success Response
1449
+
1450
+ ##### `200 application/json`
1451
+
1452
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1453
+
1454
+ | Field | Type | Required | Description |
1455
+ | --- | --- | --- | --- |
1456
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1457
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1458
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1459
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1460
+ | support | string | No | Support message \| 支持消息 |
1461
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1462
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1463
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1464
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1465
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1466
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1467
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1468
+
1469
+ - Fields truncated: this layer shows only the first `12` rows.
1470
+
1471
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_like`
1472
+
1473
+ - Summary: 获取用户的点赞列表/Get user likes
1474
+ - Capabilities: profiles / accounts
1475
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1476
+ - operationId: `fetch_user_like_api_v1_tiktok_web_fetch_user_like_get`
1477
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-like`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-like)
1478
+
1479
+ #### Parameters
1480
+
1481
+ | Field | In | Type | Required | Description |
1482
+ | --- | --- | --- | --- | --- |
1483
+ | secUid | query | string | Yes | 用户secUid/User secUid |
1484
+ | cursor | query | integer | No | 翻页游标/Page cursor |
1485
+ | count | query | integer | No | 每页数量/Number per page |
1486
+ | coverFormat | query | integer | No | 封面格式/Cover format |
1487
+ | post_item_list_request_type | query | integer | No | 排序方式/Sort type |
1488
+
1489
+ #### Request Body
1490
+
1491
+ None
1492
+
1493
+ #### Success Response
1494
+
1495
+ ##### `200 application/json`
1496
+
1497
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1498
+
1499
+ | Field | Type | Required | Description |
1500
+ | --- | --- | --- | --- |
1501
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1502
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1503
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1504
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1505
+ | support | string | No | Support message \| 支持消息 |
1506
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1507
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1508
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1509
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1510
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1511
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1512
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1513
+
1514
+ - Fields truncated: this layer shows only the first `12` rows.
1515
+
1516
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_live_detail`
1517
+
1518
+ - Summary: 获取用户的直播详情/Get user live details
1519
+ - Capabilities: profiles / accounts / details / livestream
1520
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1521
+ - operationId: `fetch_user_live_detail_api_v1_tiktok_web_fetch_user_live_detail_get`
1522
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-live-detail`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-live-detail)
1523
+
1524
+ #### Parameters
1525
+
1526
+ | Field | In | Type | Required | Description |
1527
+ | --- | --- | --- | --- | --- |
1528
+ | uniqueId | query | string | Yes | 用户uniqueId/User uniqueId |
1529
+
1530
+ #### Request Body
1531
+
1532
+ None
1533
+
1534
+ #### Success Response
1535
+
1536
+ ##### `200 application/json`
1537
+
1538
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1539
+
1540
+ | Field | Type | Required | Description |
1541
+ | --- | --- | --- | --- |
1542
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1543
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1544
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1545
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1546
+ | support | string | No | Support message \| 支持消息 |
1547
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1548
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1549
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1550
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1551
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1552
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1553
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1554
+
1555
+ - Fields truncated: this layer shows only the first `12` rows.
1556
+
1557
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_mix`
1558
+
1559
+ - Summary: 获取用户的合辑列表/Get user mix list
1560
+ - Capabilities: profiles / accounts
1561
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1562
+ - operationId: `fetch_user_mix_api_v1_tiktok_web_fetch_user_mix_get`
1563
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-mix`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-mix)
1564
+
1565
+ #### Parameters
1566
+
1567
+ | Field | In | Type | Required | Description |
1568
+ | --- | --- | --- | --- | --- |
1569
+ | mixId | query | string | Yes | 合辑id/Mix id |
1570
+ | cursor | query | integer | No | 翻页游标/Page cursor |
1571
+ | count | query | integer | No | 每页数量/Number per page |
1572
+
1573
+ #### Request Body
1574
+
1575
+ None
1576
+
1577
+ #### Success Response
1578
+
1579
+ ##### `200 application/json`
1580
+
1581
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1582
+
1583
+ | Field | Type | Required | Description |
1584
+ | --- | --- | --- | --- |
1585
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1586
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1587
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1588
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1589
+ | support | string | No | Support message \| 支持消息 |
1590
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1591
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1592
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1593
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1594
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1595
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1596
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1597
+
1598
+ - Fields truncated: this layer shows only the first `12` rows.
1599
+
1600
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_play_list`
1601
+
1602
+ - Summary: 获取用户的播放列表/Get user play list
1603
+ - Capabilities: profiles / accounts
1604
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1605
+ - operationId: `fetch_user_play_list_api_v1_tiktok_web_fetch_user_play_list_get`
1606
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-play-list`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-play-list)
1607
+
1608
+ #### Parameters
1609
+
1610
+ | Field | In | Type | Required | Description |
1611
+ | --- | --- | --- | --- | --- |
1612
+ | secUid | query | string | Yes | 用户secUid/User secUid |
1613
+ | cursor | query | integer | No | 翻页游标/Page cursor |
1614
+ | count | query | integer | No | 每页数量/Number per page |
1615
+
1616
+ #### Request Body
1617
+
1618
+ None
1619
+
1620
+ #### Success Response
1621
+
1622
+ ##### `200 application/json`
1623
+
1624
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1625
+
1626
+ | Field | Type | Required | Description |
1627
+ | --- | --- | --- | --- |
1628
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1629
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1630
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1631
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1632
+ | support | string | No | Support message \| 支持消息 |
1633
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1634
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1635
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1636
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1637
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1638
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1639
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1640
+
1641
+ - Fields truncated: this layer shows only the first `12` rows.
1642
+
1643
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_post`
1644
+
1645
+ - Summary: 获取用户的作品列表/Get user posts
1646
+ - Capabilities: profiles / accounts / content details
1647
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1648
+ - operationId: `fetch_user_post_api_v1_tiktok_web_fetch_user_post_get`
1649
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-post`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-post)
1650
+
1651
+ #### Parameters
1652
+
1653
+ | Field | In | Type | Required | Description |
1654
+ | --- | --- | --- | --- | --- |
1655
+ | secUid | query | string | Yes | 用户secUid/User secUid |
1656
+ | cursor | query | integer | No | 翻页游标/Page cursor |
1657
+ | count | query | integer | No | 每页数量/Number per page |
1658
+ | coverFormat | query | integer | No | 封面格式/Cover format |
1659
+ | post_item_list_request_type | query | integer | No | 排序方式/Sort type |
1660
+
1661
+ #### Request Body
1662
+
1663
+ None
1664
+
1665
+ #### Success Response
1666
+
1667
+ ##### `200 application/json`
1668
+
1669
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1670
+
1671
+ | Field | Type | Required | Description |
1672
+ | --- | --- | --- | --- |
1673
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1674
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1675
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1676
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1677
+ | support | string | No | Support message \| 支持消息 |
1678
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1679
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1680
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1681
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1682
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1683
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1684
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1685
+
1686
+ - Fields truncated: this layer shows only the first `12` rows.
1687
+
1688
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_profile`
1689
+
1690
+ - Summary: 获取用户的个人信息/Get user profile
1691
+ - Capabilities: profiles / accounts
1692
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1693
+ - operationId: `fetch_user_profile_api_v1_tiktok_web_fetch_user_profile_get`
1694
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-profile`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-profile)
1695
+
1696
+ #### Parameters
1697
+
1698
+ | Field | In | Type | Required | Description |
1699
+ | --- | --- | --- | --- | --- |
1700
+ | uniqueId | query | string | No | 用户uniqueId/User uniqueId |
1701
+ | secUid | query | string | No | 用户secUid/User secUid |
1702
+
1703
+ #### Request Body
1704
+
1705
+ None
1706
+
1707
+ #### Success Response
1708
+
1709
+ ##### `200 application/json`
1710
+
1711
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1712
+
1713
+ | Field | Type | Required | Description |
1714
+ | --- | --- | --- | --- |
1715
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1716
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1717
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1718
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1719
+ | support | string | No | Support message \| 支持消息 |
1720
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1721
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1722
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1723
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1724
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1725
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1726
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1727
+
1728
+ - Fields truncated: this layer shows only the first `12` rows.
1729
+
1730
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_repost`
1731
+
1732
+ - Summary: 获取用户的转发作品列表/Get user reposts
1733
+ - Capabilities: profiles / accounts / content details
1734
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1735
+ - operationId: `fetch_user_repost_api_v1_tiktok_web_fetch_user_repost_get`
1736
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-repost`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-fetch-user-repost)
1737
+
1738
+ #### Parameters
1739
+
1740
+ | Field | In | Type | Required | Description |
1741
+ | --- | --- | --- | --- | --- |
1742
+ | secUid | query | string | Yes | 用户secUid/User secUid |
1743
+ | cursor | query | integer | No | 翻页游标/Page cursor |
1744
+ | count | query | integer | No | 每页数量/Number per page |
1745
+ | coverFormat | query | integer | No | 封面格式/Cover format |
1746
+
1747
+ #### Request Body
1748
+
1749
+ None
1750
+
1751
+ #### Success Response
1752
+
1753
+ ##### `200 application/json`
1754
+
1755
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1756
+
1757
+ | Field | Type | Required | Description |
1758
+ | --- | --- | --- | --- |
1759
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1760
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1761
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1762
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1763
+ | support | string | No | Support message \| 支持消息 |
1764
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1765
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1766
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1767
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1768
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1769
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1770
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1771
+
1772
+ - Fields truncated: this layer shows only the first `12` rows.
1773
+
1774
+ ### `GET /api/u1/v1/tiktok/web/generate_fingerprint`
1775
+
1776
+ - Summary: 生成浏览器指纹/Generate browser fingerprint
1777
+ - Capabilities: general
1778
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1779
+ - operationId: `generate_fingerprint_api_v1_tiktok_web_generate_fingerprint_get`
1780
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-generate-fingerprint`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-generate-fingerprint)
1781
+
1782
+ #### Parameters
1783
+
1784
+ | Field | In | Type | Required | Description |
1785
+ | --- | --- | --- | --- | --- |
1786
+ | browser_type | query | string | No | None |
1787
+
1788
+ #### Request Body
1789
+
1790
+ None
1791
+
1792
+ #### Success Response
1793
+
1794
+ ##### `200 application/json`
1795
+
1796
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1797
+
1798
+ | Field | Type | Required | Description |
1799
+ | --- | --- | --- | --- |
1800
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1801
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1802
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1803
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1804
+ | support | string | No | Support message \| 支持消息 |
1805
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1806
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1807
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1808
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1809
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1810
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1811
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1812
+
1813
+ - Fields truncated: this layer shows only the first `12` rows.
1814
+
1815
+ ### `GET /api/u1/v1/tiktok/web/generate_hashed_id`
1816
+
1817
+ - Summary: 生成哈希ID/Generate hashed ID
1818
+ - Capabilities: general
1819
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1820
+ - operationId: `generate_hashed_id_api_v1_tiktok_web_generate_hashed_id_get`
1821
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-generate-hashed-id`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-generate-hashed-id)
1822
+
1823
+ #### Parameters
1824
+
1825
+ | Field | In | Type | Required | Description |
1826
+ | --- | --- | --- | --- | --- |
1827
+ | email | query | string | Yes | 邮箱地址/Email address |
1828
+
1829
+ #### Request Body
1830
+
1831
+ None
1832
+
1833
+ #### Success Response
1834
+
1835
+ ##### `200 application/json`
1836
+
1837
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1838
+
1839
+ | Field | Type | Required | Description |
1840
+ | --- | --- | --- | --- |
1841
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1842
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1843
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1844
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1845
+ | support | string | No | Support message \| 支持消息 |
1846
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1847
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1848
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1849
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1850
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1851
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1852
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1853
+
1854
+ - Fields truncated: this layer shows only the first `12` rows.
1855
+
1856
+ ### `GET /api/u1/v1/tiktok/web/generate_real_msToken`
1857
+
1858
+ - Summary: 生成真实msToken/Generate real msToken
1859
+ - Capabilities: general
1860
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1861
+ - operationId: `generate_real_msToken_api_v1_tiktok_web_generate_real_msToken_get`
1862
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-generate-real-mstoken`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-generate-real-mstoken)
1863
+
1864
+ #### Parameters
1865
+
1866
+ | Field | In | Type | Required | Description |
1867
+ | --- | --- | --- | --- | --- |
1868
+ | random_strData | query | boolean | No | None |
1869
+ | browser_type | query | string | No | None |
1870
+
1871
+ #### Request Body
1872
+
1873
+ None
1874
+
1875
+ #### Success Response
1876
+
1877
+ ##### `200 application/json`
1878
+
1879
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1880
+
1881
+ | Field | Type | Required | Description |
1882
+ | --- | --- | --- | --- |
1883
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1884
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1885
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1886
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1887
+ | support | string | No | Support message \| 支持消息 |
1888
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1889
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1890
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1891
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1892
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1893
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1894
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1895
+
1896
+ - Fields truncated: this layer shows only the first `12` rows.
1897
+
1898
+ ### `GET /api/u1/v1/tiktok/web/generate_ttwid`
1899
+
1900
+ - Summary: 生成ttwid/Generate ttwid
1901
+ - Capabilities: general
1902
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1903
+ - operationId: `generate_ttwid_api_v1_tiktok_web_generate_ttwid_get`
1904
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-generate-ttwid`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-generate-ttwid)
1905
+
1906
+ #### Parameters
1907
+
1908
+ | Field | In | Type | Required | Description |
1909
+ | --- | --- | --- | --- | --- |
1910
+ | user_agent | query | string | No | None |
1911
+
1912
+ #### Request Body
1913
+
1914
+ None
1915
+
1916
+ #### Success Response
1917
+
1918
+ ##### `200 application/json`
1919
+
1920
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1921
+
1922
+ | Field | Type | Required | Description |
1923
+ | --- | --- | --- | --- |
1924
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1925
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1926
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1927
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1928
+ | support | string | No | Support message \| 支持消息 |
1929
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1930
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1931
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1932
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1933
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1934
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1935
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1936
+
1937
+ - Fields truncated: this layer shows only the first `12` rows.
1938
+
1939
+ ### `GET /api/u1/v1/tiktok/web/generate_webid`
1940
+
1941
+ - Summary: 生成web_id/Generate web_id
1942
+ - Capabilities: general
1943
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1944
+ - operationId: `generate_webid_api_v1_tiktok_web_generate_webid_get`
1945
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-generate-webid`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-generate-webid)
1946
+
1947
+ #### Parameters
1948
+
1949
+ | Field | In | Type | Required | Description |
1950
+ | --- | --- | --- | --- | --- |
1951
+ | cookie | query | string | No | None |
1952
+ | user_agent | query | string | No | None |
1953
+ | url | query | string | No | None |
1954
+ | referer | query | string | No | None |
1955
+ | user_unique_id | query | string | No | None |
1956
+ | app_id | query | integer | No | None |
1957
+
1958
+ #### Request Body
1959
+
1960
+ None
1961
+
1962
+ #### Success Response
1963
+
1964
+ ##### `200 application/json`
1965
+
1966
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1967
+
1968
+ | Field | Type | Required | Description |
1969
+ | --- | --- | --- | --- |
1970
+ | code | integer | No | HTTP status code \| HTTP状态码 |
1971
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1972
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1973
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1974
+ | support | string | No | Support message \| 支持消息 |
1975
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
1976
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1977
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1978
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1979
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1980
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1981
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1982
+
1983
+ - Fields truncated: this layer shows only the first `12` rows.
1984
+
1985
+ ### `POST /api/u1/v1/tiktok/web/generate_xbogus`
1986
+
1987
+ - Summary: 生成 XBogus/Generate XBogus
1988
+ - Capabilities: general
1989
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1990
+ - operationId: `generate_xbogus_api_v1_tiktok_web_generate_xbogus_post`
1991
+ - Full contract: [`api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-generate-xbogus`](../api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-generate-xbogus)
1992
+
1993
+ #### Parameters
1994
+
1995
+ None
1996
+
1997
+ #### Request Body
1998
+
1999
+ - required: Yes
2000
+
2001
+ ##### `application/json`
2002
+
2003
+ - Schema summary: `url*`:string, `user_agent*`:string
2004
+
2005
+ | Field | Type | Required | Description |
2006
+ | --- | --- | --- | --- |
2007
+ | url | string | Yes | 请求的API URL,不需要进行编码 \| The requested API URL, no need to encode |
2008
+ | user_agent | string | Yes | 请求API时的User-Agent \| User-Agent when requesting the API |
2009
+
2010
+ #### Success Response
2011
+
2012
+ ##### `200 application/json`
2013
+
2014
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2015
+
2016
+ | Field | Type | Required | Description |
2017
+ | --- | --- | --- | --- |
2018
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2019
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2020
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2021
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2022
+ | support | string | No | Support message \| 支持消息 |
2023
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2024
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2025
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2026
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2027
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2028
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2029
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2030
+
2031
+ - Fields truncated: this layer shows only the first `12` rows.
2032
+
2033
+ ### `POST /api/u1/v1/tiktok/web/generate_xgnarly`
2034
+
2035
+ - Summary: 生成 XGnarly /Generate XGnarly
2036
+ - Capabilities: general
2037
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2038
+ - operationId: `generate_xgnarly_api_v1_tiktok_web_generate_xgnarly_post`
2039
+ - Full contract: [`api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-generate-xgnarly`](../api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-generate-xgnarly)
2040
+
2041
+ #### Parameters
2042
+
2043
+ None
2044
+
2045
+ #### Request Body
2046
+
2047
+ - required: Yes
2048
+
2049
+ ##### `application/json`
2050
+
2051
+ - Schema summary: `url*`:string, `user_agent*`:string, `body`:string
2052
+
2053
+ | Field | Type | Required | Description |
2054
+ | --- | --- | --- | --- |
2055
+ | url | string | Yes | 请求的API URL,不需要进行URL编码 \| The requested API URL, no need to URL encode |
2056
+ | user_agent | string | Yes | 请求API时的User-Agent \| User-Agent when requesting the API |
2057
+ | body | string | No | 请求的API参数,适用于POST请求 \| The API parameters of the request, applicable for POST requests |
2058
+
2059
+ #### Success Response
2060
+
2061
+ ##### `200 application/json`
2062
+
2063
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2064
+
2065
+ | Field | Type | Required | Description |
2066
+ | --- | --- | --- | --- |
2067
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2068
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2069
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2070
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2071
+ | support | string | No | Support message \| 支持消息 |
2072
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2073
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2074
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2075
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2076
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2077
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2078
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2079
+
2080
+ - Fields truncated: this layer shows only the first `12` rows.
2081
+
2082
+ ### `POST /api/u1/v1/tiktok/web/generate_xgnarly_and_xbogus`
2083
+
2084
+ - Summary: 生成 XGnarly 和 XBogus /Generate XGnarly and XBogus
2085
+ - Capabilities: general
2086
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2087
+ - operationId: `generate_xgnarly_and_xbogus_api_v1_tiktok_web_generate_xgnarly_and_xbogus_post`
2088
+ - Full contract: [`api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-generate-xgnarly-and-xbogus`](../api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-generate-xgnarly-and-xbogus)
2089
+
2090
+ #### Parameters
2091
+
2092
+ None
2093
+
2094
+ #### Request Body
2095
+
2096
+ - required: Yes
2097
+
2098
+ ##### `application/json`
2099
+
2100
+ - Schema summary: `url*`:string, `body`:string
2101
+
2102
+ | Field | Type | Required | Description |
2103
+ | --- | --- | --- | --- |
2104
+ | url | string | Yes | 包含域名和参数的请求的API URL,不需要进行URL编码 \| The requested API URL, no need to URL encode |
2105
+ | body | string | No | 请求的API参数,适用于POST请求 \| The API parameters of the request, applicable for POST requests |
2106
+
2107
+ #### Success Response
2108
+
2109
+ ##### `200 application/json`
2110
+
2111
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2112
+
2113
+ | Field | Type | Required | Description |
2114
+ | --- | --- | --- | --- |
2115
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2116
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2117
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2118
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2119
+ | support | string | No | Support message \| 支持消息 |
2120
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2121
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2122
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2123
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2124
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2125
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2126
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2127
+
2128
+ - Fields truncated: this layer shows only the first `12` rows.
2129
+
2130
+ ### `POST /api/u1/v1/tiktok/web/get_all_aweme_id`
2131
+
2132
+ - Summary: 提取列表作品id/Extract list video id
2133
+ - Capabilities: general
2134
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2135
+ - operationId: `get_all_aweme_id_api_v1_tiktok_web_get_all_aweme_id_post`
2136
+ - Full contract: [`api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-get-all-aweme-id`](../api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-get-all-aweme-id)
2137
+
2138
+ #### Parameters
2139
+
2140
+ None
2141
+
2142
+ #### Request Body
2143
+
2144
+ - required: Yes
2145
+
2146
+ ##### `application/json`
2147
+
2148
+ - Schema summary: [string]
2149
+
2150
+ | Field | Type | Required | Description |
2151
+ | --- | --- | --- | --- |
2152
+ | [] | array<string> | Yes | 作品链接/Video link |
2153
+
2154
+ #### Success Response
2155
+
2156
+ ##### `200 application/json`
2157
+
2158
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2159
+
2160
+ | Field | Type | Required | Description |
2161
+ | --- | --- | --- | --- |
2162
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2163
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2164
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2165
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2166
+ | support | string | No | Support message \| 支持消息 |
2167
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2168
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2169
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2170
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2171
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2172
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2173
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2174
+
2175
+ - Fields truncated: this layer shows only the first `12` rows.
2176
+
2177
+ ### `POST /api/u1/v1/tiktok/web/get_all_sec_user_id`
2178
+
2179
+ - Summary: 提取列表用户sec_user_id/Extract list user sec_user_id
2180
+ - Capabilities: profiles / accounts
2181
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2182
+ - operationId: `get_all_sec_user_id_api_v1_tiktok_web_get_all_sec_user_id_post`
2183
+ - Full contract: [`api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-get-all-sec-user-id`](../api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-get-all-sec-user-id)
2184
+
2185
+ #### Parameters
2186
+
2187
+ None
2188
+
2189
+ #### Request Body
2190
+
2191
+ - required: Yes
2192
+
2193
+ ##### `application/json`
2194
+
2195
+ - Schema summary: [string]
2196
+
2197
+ | Field | Type | Required | Description |
2198
+ | --- | --- | --- | --- |
2199
+ | [] | array<string> | Yes | 用户主页链接/User homepage link |
2200
+
2201
+ #### Success Response
2202
+
2203
+ ##### `200 application/json`
2204
+
2205
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2206
+
2207
+ | Field | Type | Required | Description |
2208
+ | --- | --- | --- | --- |
2209
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2210
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2211
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2212
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2213
+ | support | string | No | Support message \| 支持消息 |
2214
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2215
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2216
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2217
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2218
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2219
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2220
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2221
+
2222
+ - Fields truncated: this layer shows only the first `12` rows.
2223
+
2224
+ ### `POST /api/u1/v1/tiktok/web/get_all_unique_id`
2225
+
2226
+ - Summary: 获取列表unique_id/Get list unique_id
2227
+ - Capabilities: general
2228
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2229
+ - operationId: `get_all_unique_id_api_v1_tiktok_web_get_all_unique_id_post`
2230
+ - Full contract: [`api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-get-all-unique-id`](../api-contracts/tiktok-web-api.md#post-api-u1-v1-tiktok-web-get-all-unique-id)
2231
+
2232
+ #### Parameters
2233
+
2234
+ None
2235
+
2236
+ #### Request Body
2237
+
2238
+ - required: Yes
2239
+
2240
+ ##### `application/json`
2241
+
2242
+ - Schema summary: [string]
2243
+
2244
+ | Field | Type | Required | Description |
2245
+ | --- | --- | --- | --- |
2246
+ | [] | array<string> | Yes | 用户主页链接/User homepage link |
2247
+
2248
+ #### Success Response
2249
+
2250
+ ##### `200 application/json`
2251
+
2252
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2253
+
2254
+ | Field | Type | Required | Description |
2255
+ | --- | --- | --- | --- |
2256
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2257
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2258
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2259
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2260
+ | support | string | No | Support message \| 支持消息 |
2261
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2262
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2263
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2264
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2265
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2266
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2267
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2268
+
2269
+ - Fields truncated: this layer shows only the first `12` rows.
2270
+
2271
+ ### `GET /api/u1/v1/tiktok/web/get_aweme_id`
2272
+
2273
+ - Summary: 提取单个作品id/Extract single video id
2274
+ - Capabilities: general
2275
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2276
+ - operationId: `get_aweme_id_api_v1_tiktok_web_get_aweme_id_get`
2277
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-get-aweme-id`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-get-aweme-id)
2278
+
2279
+ #### Parameters
2280
+
2281
+ | Field | In | Type | Required | Description |
2282
+ | --- | --- | --- | --- | --- |
2283
+ | url | query | string | Yes | 作品链接/Video link |
2284
+
2285
+ #### Request Body
2286
+
2287
+ None
2288
+
2289
+ #### Success Response
2290
+
2291
+ ##### `200 application/json`
2292
+
2293
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2294
+
2295
+ | Field | Type | Required | Description |
2296
+ | --- | --- | --- | --- |
2297
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2298
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2299
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2300
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2301
+ | support | string | No | Support message \| 支持消息 |
2302
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2303
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2304
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2305
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2306
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2307
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2308
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2309
+
2310
+ - Fields truncated: this layer shows only the first `12` rows.
2311
+
2312
+ ### `GET /api/u1/v1/tiktok/web/get_live_room_id`
2313
+
2314
+ - Summary: 根据直播间链接提取直播间ID/Extract live room ID from live room link
2315
+ - Capabilities: livestream
2316
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2317
+ - operationId: `get_live_room_id_api_v1_tiktok_web_get_live_room_id_get`
2318
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-get-live-room-id`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-get-live-room-id)
2319
+
2320
+ #### Parameters
2321
+
2322
+ | Field | In | Type | Required | Description |
2323
+ | --- | --- | --- | --- | --- |
2324
+ | live_room_url | query | string | Yes | 直播间链接/Live room link |
2325
+
2326
+ #### Request Body
2327
+
2328
+ None
2329
+
2330
+ #### Success Response
2331
+
2332
+ ##### `200 application/json`
2333
+
2334
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2335
+
2336
+ | Field | Type | Required | Description |
2337
+ | --- | --- | --- | --- |
2338
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2339
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2340
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2341
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2342
+ | support | string | No | Support message \| 支持消息 |
2343
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2344
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2345
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2346
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2347
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2348
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2349
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2350
+
2351
+ - Fields truncated: this layer shows only the first `12` rows.
2352
+
2353
+ ### `GET /api/u1/v1/tiktok/web/get_sec_user_id`
2354
+
2355
+ - Summary: 提取用户sec_user_id/Extract user sec_user_id
2356
+ - Capabilities: profiles / accounts
2357
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2358
+ - operationId: `get_sec_user_id_api_v1_tiktok_web_get_sec_user_id_get`
2359
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-get-sec-user-id`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-get-sec-user-id)
2360
+
2361
+ #### Parameters
2362
+
2363
+ | Field | In | Type | Required | Description |
2364
+ | --- | --- | --- | --- | --- |
2365
+ | url | query | string | Yes | 用户主页链接/User homepage link |
2366
+
2367
+ #### Request Body
2368
+
2369
+ None
2370
+
2371
+ #### Success Response
2372
+
2373
+ ##### `200 application/json`
2374
+
2375
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2376
+
2377
+ | Field | Type | Required | Description |
2378
+ | --- | --- | --- | --- |
2379
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2380
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2381
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2382
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2383
+ | support | string | No | Support message \| 支持消息 |
2384
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2385
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2386
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2387
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2388
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2389
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2390
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2391
+
2392
+ - Fields truncated: this layer shows only the first `12` rows.
2393
+
2394
+ ### `GET /api/u1/v1/tiktok/web/get_unique_id`
2395
+
2396
+ - Summary: 获取用户unique_id/Get user unique_id
2397
+ - Capabilities: general
2398
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2399
+ - operationId: `get_unique_id_api_v1_tiktok_web_get_unique_id_get`
2400
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-get-unique-id`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-get-unique-id)
2401
+
2402
+ #### Parameters
2403
+
2404
+ | Field | In | Type | Required | Description |
2405
+ | --- | --- | --- | --- | --- |
2406
+ | url | query | string | Yes | 用户主页链接/User homepage link |
2407
+
2408
+ #### Request Body
2409
+
2410
+ None
2411
+
2412
+ #### Success Response
2413
+
2414
+ ##### `200 application/json`
2415
+
2416
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2417
+
2418
+ | Field | Type | Required | Description |
2419
+ | --- | --- | --- | --- |
2420
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2421
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2422
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2423
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2424
+ | support | string | No | Support message \| 支持消息 |
2425
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2426
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2427
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2428
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2429
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2430
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2431
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2432
+
2433
+ - Fields truncated: this layer shows only the first `12` rows.
2434
+
2435
+ ### `GET /api/u1/v1/tiktok/web/get_user_id`
2436
+
2437
+ - Summary: 提取用户user_id/Extract user user_id
2438
+ - Capabilities: profiles / accounts
2439
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2440
+ - operationId: `get_user_id_api_v1_tiktok_web_get_user_id_get`
2441
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-get-user-id`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-get-user-id)
2442
+
2443
+ #### Parameters
2444
+
2445
+ | Field | In | Type | Required | Description |
2446
+ | --- | --- | --- | --- | --- |
2447
+ | url | query | string | Yes | 用户主页链接/User homepage link |
2448
+
2449
+ #### Request Body
2450
+
2451
+ None
2452
+
2453
+ #### Success Response
2454
+
2455
+ ##### `200 application/json`
2456
+
2457
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2458
+
2459
+ | Field | Type | Required | Description |
2460
+ | --- | --- | --- | --- |
2461
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2462
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2463
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2464
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2465
+ | support | string | No | Support message \| 支持消息 |
2466
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2467
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2468
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2469
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2470
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2471
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2472
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2473
+
2474
+ - Fields truncated: this layer shows only the first `12` rows.
2475
+
2476
+ ### `GET /api/u1/v1/tiktok/web/tiktok_live_room`
2477
+
2478
+ - Summary: 提取直播间弹幕/Extract live room danmaku
2479
+ - Capabilities: livestream
2480
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2481
+ - operationId: `tiktok_live_room_api_v1_tiktok_web_tiktok_live_room_get`
2482
+ - Full contract: [`api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-tiktok-live-room`](../api-contracts/tiktok-web-api.md#get-api-u1-v1-tiktok-web-tiktok-live-room)
2483
+
2484
+ #### Parameters
2485
+
2486
+ | Field | In | Type | Required | Description |
2487
+ | --- | --- | --- | --- | --- |
2488
+ | live_room_url | query | string | Yes | 直播间链接/Live room link |
2489
+ | danmaku_type | query | string | Yes | 消息类型/Message type |
2490
+
2491
+ #### Request Body
2492
+
2493
+ None
2494
+
2495
+ #### Success Response
2496
+
2497
+ ##### `200 application/json`
2498
+
2499
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2500
+
2501
+ | Field | Type | Required | Description |
2502
+ | --- | --- | --- | --- |
2503
+ | code | integer | No | HTTP status code \| HTTP状态码 |
2504
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
2505
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) |
2506
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
2507
+ | support | string | No | Support message \| 支持消息 |
2508
+ | time | string | No | The time the response was generated \| 生成响应的时间 |
2509
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
2510
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
2511
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
2512
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
2513
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
2514
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
2515
+
2516
+ - Fields truncated: this layer shows only the first `12` rows.