@tikomni/skills 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.skill-package-allowlist.txt +4 -0
- package/LICENSE +21 -0
- package/README.md +167 -0
- package/README.zh-CN.md +167 -0
- package/bin/tikomni-skills.js +127 -0
- package/env.example +160 -0
- package/lib/installer.js +176 -0
- package/package.json +44 -0
- package/skills/creator-analysis/SKILL.md +71 -0
- package/skills/creator-analysis/agents/openai.yaml +4 -0
- package/skills/creator-analysis/env.example +36 -0
- package/skills/creator-analysis/references/api-capability-index.md +92 -0
- package/skills/creator-analysis/references/api-contracts/asr-api.md +130 -0
- package/skills/creator-analysis/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/creator-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/creator-analysis/references/api-contracts/demo-api.md +717 -0
- package/skills/creator-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/creator-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/creator-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/creator-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/creator-analysis/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/creator-analysis/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/creator-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/creator-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/creator-analysis/references/api-contracts/health-check.md +69 -0
- package/skills/creator-analysis/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/creator-analysis/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/creator-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/creator-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/creator-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/creator-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/creator-analysis/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/creator-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/creator-analysis/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/creator-analysis/references/api-contracts/sora2-api.md +2266 -0
- package/skills/creator-analysis/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/creator-analysis/references/api-contracts/threads-web-api.md +897 -0
- package/skills/creator-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/creator-analysis/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/creator-analysis/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/creator-analysis/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/creator-analysis/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/creator-analysis/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/creator-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/creator-analysis/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/creator-analysis/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/creator-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/creator-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/creator-analysis/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/creator-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/creator-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/creator-analysis/references/api-tags/asr-api.md +100 -0
- package/skills/creator-analysis/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/creator-analysis/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/creator-analysis/references/api-tags/demo-api.md +365 -0
- package/skills/creator-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/creator-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/creator-analysis/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/creator-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/creator-analysis/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/creator-analysis/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/creator-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/creator-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/creator-analysis/references/api-tags/health-check.md +40 -0
- package/skills/creator-analysis/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/creator-analysis/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/creator-analysis/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/creator-analysis/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/creator-analysis/references/api-tags/ios-shortcut.md +45 -0
- package/skills/creator-analysis/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/creator-analysis/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/creator-analysis/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/creator-analysis/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/creator-analysis/references/api-tags/media-ingest-api.md +112 -0
- package/skills/creator-analysis/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/creator-analysis/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/creator-analysis/references/api-tags/sora2-api.md +737 -0
- package/skills/creator-analysis/references/api-tags/temp-mail-api.md +136 -0
- package/skills/creator-analysis/references/api-tags/threads-web-api.md +472 -0
- package/skills/creator-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/creator-analysis/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/creator-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/creator-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/creator-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/creator-analysis/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/creator-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/creator-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/creator-analysis/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/creator-analysis/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/creator-analysis/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/creator-analysis/references/api-tags/twitter-web-api.md +562 -0
- package/skills/creator-analysis/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/creator-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/creator-analysis/references/api-tags/weibo-app-api.md +851 -0
- package/skills/creator-analysis/references/api-tags/weibo-web-api.md +470 -0
- package/skills/creator-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/creator-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/creator-analysis/references/api-tags/youtube-web-api.md +934 -0
- package/skills/creator-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/creator-analysis/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/creator-analysis/references/asr-orchestration.md +33 -0
- package/skills/creator-analysis/references/config-templates/defaults.yaml +60 -0
- package/skills/creator-analysis/references/contracts/creator-card-fields.md +23 -0
- package/skills/creator-analysis/references/contracts/work-card-fields.md +32 -0
- package/skills/creator-analysis/references/platform-guides/douyin.md +49 -0
- package/skills/creator-analysis/references/platform-guides/generic.md +46 -0
- package/skills/creator-analysis/references/platform-guides/xiaohongshu.md +54 -0
- package/skills/creator-analysis/references/prompt-contracts/asr-clean.md +28 -0
- package/skills/creator-analysis/references/prompt-contracts/author-analysis-v2.md +46 -0
- package/skills/creator-analysis/references/prompt-contracts/author-analysis.md +49 -0
- package/skills/creator-analysis/references/prompt-contracts/cta.md +24 -0
- package/skills/creator-analysis/references/prompt-contracts/hook.md +25 -0
- package/skills/creator-analysis/references/prompt-contracts/insight.md +47 -0
- package/skills/creator-analysis/references/prompt-contracts/sampled-work-batch-explanations.md +30 -0
- package/skills/creator-analysis/references/prompt-contracts/structure.md +25 -0
- package/skills/creator-analysis/references/prompt-contracts/style.md +27 -0
- package/skills/creator-analysis/references/prompt-contracts/summary.md +29 -0
- package/skills/creator-analysis/references/prompt-contracts/topic.md +29 -0
- package/skills/creator-analysis/references/schemas/author-analysis-input-v1.schema.json +325 -0
- package/skills/creator-analysis/references/schemas/author-analysis-v2.schema.json +158 -0
- package/skills/creator-analysis/references/schemas/sampled-work-batch-explanations.schema.json +41 -0
- package/skills/creator-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/creator-analysis/references/workflow.md +18 -0
- package/skills/creator-analysis/scripts/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/adapters/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/adapters/platform_adapters.py +299 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/author_analysis_v2_support.py +1122 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/prompt_first_analyzers.py +260 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/sampled_work_batch_explainer.py +260 -0
- package/skills/creator-analysis/scripts/author_home/asr/__init__.py +5 -0
- package/skills/creator-analysis/scripts/author_home/asr/home_asr.py +961 -0
- package/skills/creator-analysis/scripts/author_home/builders/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/builders/home_builders.py +149 -0
- package/skills/creator-analysis/scripts/author_home/collectors/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/collectors/homepage_collectors.py +636 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/run_author_analysis.py +491 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/work_analysis_artifacts.py +553 -0
- package/skills/creator-analysis/scripts/author_home/schema.py +417 -0
- package/skills/creator-analysis/scripts/core/__init__.py +0 -0
- package/skills/creator-analysis/scripts/core/analysis_pipeline.py +133 -0
- package/skills/creator-analysis/scripts/core/bootstrap_env.py +35 -0
- package/skills/creator-analysis/scripts/core/config_loader.py +418 -0
- package/skills/creator-analysis/scripts/core/extract_pipeline.py +173 -0
- package/skills/creator-analysis/scripts/core/progress_report.py +111 -0
- package/skills/creator-analysis/scripts/core/storage_router.py +253 -0
- package/skills/creator-analysis/scripts/core/tikomni_common.py +588 -0
- package/skills/creator-analysis/scripts/pipeline/__init__.py +0 -0
- package/skills/creator-analysis/scripts/pipeline/asr/__init__.py +0 -0
- package/skills/creator-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
- package/skills/creator-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
- package/skills/creator-analysis/scripts/platform/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/douyin/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
- package/skills/creator-analysis/scripts/platform/douyin/run_douyin_single_video.py +1208 -0
- package/skills/creator-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
- package/skills/creator-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2128 -0
- package/skills/creator-analysis/scripts/writers/__init__.py +0 -0
- package/skills/creator-analysis/scripts/writers/write_author_homepage_samples.py +106 -0
- package/skills/creator-analysis/scripts/writers/write_benchmark_card.py +1402 -0
- package/skills/meta-capability/SKILL.md +69 -0
- package/skills/meta-capability/agents/openai.yaml +4 -0
- package/skills/meta-capability/env.example +42 -0
- package/skills/meta-capability/references/api-capability-index.md +92 -0
- package/skills/meta-capability/references/api-contracts/asr-api.md +130 -0
- package/skills/meta-capability/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/meta-capability/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/meta-capability/references/api-contracts/demo-api.md +717 -0
- package/skills/meta-capability/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/meta-capability/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/meta-capability/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/meta-capability/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/meta-capability/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/meta-capability/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/meta-capability/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/meta-capability/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/meta-capability/references/api-contracts/health-check.md +69 -0
- package/skills/meta-capability/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/meta-capability/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/meta-capability/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/meta-capability/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/meta-capability/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/meta-capability/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/meta-capability/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/meta-capability/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/meta-capability/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/meta-capability/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/meta-capability/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/meta-capability/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/meta-capability/references/api-contracts/sora2-api.md +2266 -0
- package/skills/meta-capability/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/meta-capability/references/api-contracts/threads-web-api.md +897 -0
- package/skills/meta-capability/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/meta-capability/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/meta-capability/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/meta-capability/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/meta-capability/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/meta-capability/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/meta-capability/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/meta-capability/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/meta-capability/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/meta-capability/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/meta-capability/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/meta-capability/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/meta-capability/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/meta-capability/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/meta-capability/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/meta-capability/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/meta-capability/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/meta-capability/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/meta-capability/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/meta-capability/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/meta-capability/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/meta-capability/references/api-tags/asr-api.md +100 -0
- package/skills/meta-capability/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/meta-capability/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/meta-capability/references/api-tags/demo-api.md +365 -0
- package/skills/meta-capability/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/meta-capability/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/meta-capability/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/meta-capability/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/meta-capability/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/meta-capability/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/meta-capability/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/meta-capability/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/meta-capability/references/api-tags/health-check.md +40 -0
- package/skills/meta-capability/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/meta-capability/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/meta-capability/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/meta-capability/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/meta-capability/references/api-tags/ios-shortcut.md +45 -0
- package/skills/meta-capability/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/meta-capability/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/meta-capability/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/meta-capability/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/meta-capability/references/api-tags/media-ingest-api.md +112 -0
- package/skills/meta-capability/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/meta-capability/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/meta-capability/references/api-tags/sora2-api.md +737 -0
- package/skills/meta-capability/references/api-tags/temp-mail-api.md +136 -0
- package/skills/meta-capability/references/api-tags/threads-web-api.md +472 -0
- package/skills/meta-capability/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/meta-capability/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/meta-capability/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/meta-capability/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/meta-capability/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/meta-capability/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/meta-capability/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/meta-capability/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/meta-capability/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/meta-capability/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/meta-capability/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/meta-capability/references/api-tags/twitter-web-api.md +562 -0
- package/skills/meta-capability/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/meta-capability/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/meta-capability/references/api-tags/weibo-app-api.md +851 -0
- package/skills/meta-capability/references/api-tags/weibo-web-api.md +470 -0
- package/skills/meta-capability/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/meta-capability/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/meta-capability/references/api-tags/youtube-web-api.md +934 -0
- package/skills/meta-capability/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/meta-capability/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/meta-capability/references/config-templates/defaults.yaml +18 -0
- package/skills/meta-capability/references/dispatch.md +27 -0
- package/skills/meta-capability/references/execution-guidelines.md +25 -0
- package/skills/meta-capability/references/implemented-route-map.md +177 -0
- package/skills/meta-capability/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/meta-capability/scripts/__init__.py +1 -0
- package/skills/meta-capability/scripts/call_route.py +141 -0
- package/skills/meta-capability/scripts/core/__init__.py +1 -0
- package/skills/meta-capability/scripts/core/bootstrap_env.py +32 -0
- package/skills/meta-capability/scripts/core/config_loader.py +204 -0
- package/skills/meta-capability/scripts/core/tikomni_common.py +443 -0
- package/skills/meta-capability/scripts/test_auth.py +98 -0
- package/skills/single-work-analysis/SKILL.md +62 -0
- package/skills/single-work-analysis/agents/openai.yaml +4 -0
- package/skills/single-work-analysis/env.example +36 -0
- package/skills/single-work-analysis/references/api-capability-index.md +92 -0
- package/skills/single-work-analysis/references/api-contracts/asr-api.md +130 -0
- package/skills/single-work-analysis/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/single-work-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/single-work-analysis/references/api-contracts/demo-api.md +717 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/single-work-analysis/references/api-contracts/health-check.md +69 -0
- package/skills/single-work-analysis/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/single-work-analysis/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/single-work-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/single-work-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/single-work-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/single-work-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/single-work-analysis/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/single-work-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/single-work-analysis/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/single-work-analysis/references/api-contracts/sora2-api.md +2266 -0
- package/skills/single-work-analysis/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/single-work-analysis/references/api-contracts/threads-web-api.md +897 -0
- package/skills/single-work-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/single-work-analysis/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/single-work-analysis/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/single-work-analysis/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/single-work-analysis/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/single-work-analysis/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/single-work-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/single-work-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/single-work-analysis/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/single-work-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/single-work-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/single-work-analysis/references/api-tags/asr-api.md +100 -0
- package/skills/single-work-analysis/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/single-work-analysis/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/single-work-analysis/references/api-tags/demo-api.md +365 -0
- package/skills/single-work-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/single-work-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/single-work-analysis/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/single-work-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/single-work-analysis/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/single-work-analysis/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/single-work-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/single-work-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/single-work-analysis/references/api-tags/health-check.md +40 -0
- package/skills/single-work-analysis/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/single-work-analysis/references/api-tags/ios-shortcut.md +45 -0
- package/skills/single-work-analysis/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/single-work-analysis/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/single-work-analysis/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/single-work-analysis/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/single-work-analysis/references/api-tags/media-ingest-api.md +112 -0
- package/skills/single-work-analysis/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/single-work-analysis/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/single-work-analysis/references/api-tags/sora2-api.md +737 -0
- package/skills/single-work-analysis/references/api-tags/temp-mail-api.md +136 -0
- package/skills/single-work-analysis/references/api-tags/threads-web-api.md +472 -0
- package/skills/single-work-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/single-work-analysis/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/single-work-analysis/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/single-work-analysis/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/single-work-analysis/references/api-tags/twitter-web-api.md +562 -0
- package/skills/single-work-analysis/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/single-work-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/single-work-analysis/references/api-tags/weibo-app-api.md +851 -0
- package/skills/single-work-analysis/references/api-tags/weibo-web-api.md +470 -0
- package/skills/single-work-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/single-work-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/single-work-analysis/references/api-tags/youtube-web-api.md +934 -0
- package/skills/single-work-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/single-work-analysis/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/single-work-analysis/references/asr-and-fallback.md +20 -0
- package/skills/single-work-analysis/references/config-templates/defaults.yaml +58 -0
- package/skills/single-work-analysis/references/contracts/work-card-fields.md +41 -0
- package/skills/single-work-analysis/references/platform-guides/douyin.md +47 -0
- package/skills/single-work-analysis/references/platform-guides/generic.md +43 -0
- package/skills/single-work-analysis/references/platform-guides/xiaohongshu.md +54 -0
- package/skills/single-work-analysis/references/prompt-contracts/asr-clean.md +28 -0
- package/skills/single-work-analysis/references/prompt-contracts/cta.md +24 -0
- package/skills/single-work-analysis/references/prompt-contracts/hook.md +25 -0
- package/skills/single-work-analysis/references/prompt-contracts/insight.md +47 -0
- package/skills/single-work-analysis/references/prompt-contracts/structure.md +25 -0
- package/skills/single-work-analysis/references/prompt-contracts/style.md +27 -0
- package/skills/single-work-analysis/references/prompt-contracts/summary.md +29 -0
- package/skills/single-work-analysis/references/prompt-contracts/topic.md +29 -0
- package/skills/single-work-analysis/references/schemas/work-card.schema.json +39 -0
- package/skills/single-work-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/single-work-analysis/scripts/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/core/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/core/analysis_pipeline.py +133 -0
- package/skills/single-work-analysis/scripts/core/bootstrap_env.py +35 -0
- package/skills/single-work-analysis/scripts/core/config_loader.py +418 -0
- package/skills/single-work-analysis/scripts/core/extract_pipeline.py +173 -0
- package/skills/single-work-analysis/scripts/core/progress_report.py +111 -0
- package/skills/single-work-analysis/scripts/core/storage_router.py +253 -0
- package/skills/single-work-analysis/scripts/core/tikomni_common.py +588 -0
- package/skills/single-work-analysis/scripts/pipeline/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
- package/skills/single-work-analysis/scripts/platform/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/douyin/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
- package/skills/single-work-analysis/scripts/platform/douyin/run_douyin_single_video.py +1233 -0
- package/skills/single-work-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
- package/skills/single-work-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2156 -0
- package/skills/single-work-analysis/scripts/writers/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/writers/write_benchmark_card.py +1402 -0
|
@@ -0,0 +1,2266 @@
|
|
|
1
|
+
# Sora2-API Full Contract
|
|
2
|
+
|
|
3
|
+
- Back to index: [`api-capability-index.md`](../api-capability-index.md)
|
|
4
|
+
- Back to route summary: [`api-tags/sora2-api.md`](../api-tags/sora2-api.md)
|
|
5
|
+
- Current contract file: `api-contracts/sora2-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: `17`
|
|
9
|
+
- Default auth: Header `Authorization` Bearer
|
|
10
|
+
- Read this file only when you need precise auth notes, parameter descriptions, defaults, examples, or success-response fields.
|
|
11
|
+
- Tag description: **(Sora2 接口/Sora2 API endpoints)**
|
|
12
|
+
|
|
13
|
+
## Route Contracts
|
|
14
|
+
|
|
15
|
+
<a id="post-api-u1-v1-sora2-create-video"></a>
|
|
16
|
+
### `POST /api/u1/v1/sora2/create_video`
|
|
17
|
+
|
|
18
|
+
- Summary: [已弃用/Deprecated] 文本/图片生成视频/Create video from text or image
|
|
19
|
+
- Capabilities: content details
|
|
20
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
21
|
+
- operationId: `create_video_api_v1_sora2_create_video_post`
|
|
22
|
+
|
|
23
|
+
#### Notes
|
|
24
|
+
|
|
25
|
+
> # [中文]
|
|
26
|
+
> ## ⚠️ 此接口已弃用。AI 相关接口已迁移至独立的 TikHub AI API 服务,与 TikHub 社交媒体 API 分离部署。请访问:https://ai.tikhub.io
|
|
27
|
+
> ### 用途:
|
|
28
|
+
> - 通过文本描述生成 Sora 视频(支持纯文本生成或图片+文本生成)
|
|
29
|
+
> - 支持两种生成模式:
|
|
30
|
+
> - **纯文本生成**:AI 根据文本描述自动生成视频内容
|
|
31
|
+
> - **图生视频**:基于上传的图片和文本描述生成视频(需要先调用 upload_image 接口)
|
|
32
|
+
> - 支持两种视频比例:
|
|
33
|
+
> - **portrait(竖屏)**: 9:16 比例,适合移动端、社交媒体短视频
|
|
34
|
+
> - **landscape(横屏)**: 16:9 比例,适合桌面端、宽屏展示、电影风格
|
|
35
|
+
> - 返回生成任务 ID,需要通过其他接口查询生成进度和结果
|
|
36
|
+
>
|
|
37
|
+
> ### 收费说明:
|
|
38
|
+
> - 本接口请求价格为 1 次调用消耗 **$0.1 美元**
|
|
39
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数
|
|
40
|
+
>
|
|
41
|
+
> ### 参数:
|
|
42
|
+
> - **prompt** (必填): 视频描述文本,最多 2000 字符
|
|
43
|
+
> - 描述要生成的视频内容、场景、动作、情节等
|
|
44
|
+
> - 建议使用清晰、具体的描述以获得更好的生成效果
|
|
45
|
+
> - 示例:"A cat is playing Minecraft"
|
|
46
|
+
> - **orientation** (可选): 视频方向,默认为 portrait(竖屏)
|
|
47
|
+
> - `portrait`: 竖屏(9:16 比例)
|
|
48
|
+
> - `landscape`: 横屏(16:9 比例)
|
|
49
|
+
> - **media_id** (可选): 图片 media_id,用于图生视频
|
|
50
|
+
> - 通过 `/upload_image` 接口上传图片后获取
|
|
51
|
+
> - 格式:`media_xxxxxxxxxxxxxxxxxxxxxxxxxx`
|
|
52
|
+
> - 如果不提供,则为纯文本生成视频
|
|
53
|
+
>
|
|
54
|
+
> ### 返回:
|
|
55
|
+
> - **id**: 视频生成任务 ID
|
|
56
|
+
> - 格式:`task_xxxxxxxxxxxxxxxxxxxxxxxxxx`
|
|
57
|
+
> - 使用此 ID 可以查询生成进度和获取最终视频
|
|
58
|
+
> - **priority**: 任务优先级
|
|
59
|
+
> - 通常为 1(标准优先级)
|
|
60
|
+
>
|
|
61
|
+
> ### 注意:
|
|
62
|
+
> - 这是一个异步生成任务,不会立即返回视频
|
|
63
|
+
> - 视频生成通常需要几分钟时间
|
|
64
|
+
> - 需要使用任务 ID 通过其他接口轮询查询生成状态
|
|
65
|
+
> - 请自行保留任务 ID,以便后续查询,否则将无法获取生成结果
|
|
66
|
+
>
|
|
67
|
+
> # [English]
|
|
68
|
+
> ## ⚠️ This endpoint has been deprecated. AI-related endpoints have been migrated to a dedicated TikHub AI API service, which operates separately from the TikHub Social Media API. Please visit: https://ai.tikhub.io
|
|
69
|
+
> ### Purpose:
|
|
70
|
+
> - Generate Sora video from text description (supports text-only or image+text generation)
|
|
71
|
+
> - Supports two generation modes:
|
|
72
|
+
> - **Text-only generation**: AI automatically generates video content based on text description
|
|
73
|
+
> - **Image-to-video**: Generate video based on uploaded image and text description (requires calling upload_image endpoint first)
|
|
74
|
+
> - Supports two video ratios:
|
|
75
|
+
> - **portrait**: 9:16 ratio, suitable for mobile devices, social media short videos
|
|
76
|
+
> - **landscape**: 16:9 ratio, suitable for desktop viewing, widescreen display, cinematic style
|
|
77
|
+
> - Returns generation task ID, need to query generation progress and results through other endpoints
|
|
78
|
+
>
|
|
79
|
+
> ### Pricing:
|
|
80
|
+
> - This API costs **$0.1 USD per request**
|
|
81
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard
|
|
82
|
+
>
|
|
83
|
+
> ### Parameters:
|
|
84
|
+
> - **prompt** (required): Video description text, maximum 2000 characters
|
|
85
|
+
> - Describe the video content, scenes, actions, plots, etc. to be generated
|
|
86
|
+
> - Recommend using clear and specific descriptions for better generation results
|
|
87
|
+
> - Example: "A cat is playing Minecraft"
|
|
88
|
+
> - **orientation** (optional): Video orientation, defaults to portrait
|
|
89
|
+
> - `portrait`: Portrait (9:16 ratio)
|
|
90
|
+
> - `landscape`: Landscape (16:9 ratio)
|
|
91
|
+
> - **media_id** (optional): Image media_id for image-to-video generation
|
|
92
|
+
> - Obtained from `/upload_image` endpoint after uploading an image
|
|
93
|
+
> - Format: `media_xxxxxxxxxxxxxxxxxxxxxxxxxx`
|
|
94
|
+
> - If not provided, text-only video generation will be used
|
|
95
|
+
>
|
|
96
|
+
> ### Return:
|
|
97
|
+
> - **id**: Video generation task ID
|
|
98
|
+
> - Format: `task_xxxxxxxxxxxxxxxxxxxxxxxxxx`
|
|
99
|
+
> - Use this ID to query generation progress and get final video
|
|
100
|
+
> - **priority**: Task priority
|
|
101
|
+
> - Usually 1 (standard priority)
|
|
102
|
+
>
|
|
103
|
+
> ### Note:
|
|
104
|
+
> - This is an asynchronous generation task, will not return video immediately
|
|
105
|
+
> - Video generation usually takes several minutes
|
|
106
|
+
> - Need to use task ID to poll generation status through other endpoints
|
|
107
|
+
> - Please keep the task ID for future queries, otherwise you will not be able to get the generation results
|
|
108
|
+
>
|
|
109
|
+
> # [示例/Example]
|
|
110
|
+
> ```python
|
|
111
|
+
> import requests
|
|
112
|
+
>
|
|
113
|
+
> # 示例 1:纯文本生成竖屏视频/Example 1: Text-only portrait video
|
|
114
|
+
> url = "https://api.tikhub.io/api/v1/sora2/create_video"
|
|
115
|
+
> headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
|
|
116
|
+
> payload = {
|
|
117
|
+
> "prompt": "A cat is playing Minecraft",
|
|
118
|
+
> "orientation": "portrait"
|
|
119
|
+
> }
|
|
120
|
+
> response = requests.post(url, headers=headers, json=payload)
|
|
121
|
+
>
|
|
122
|
+
> # 示例 2:图片+文本生成视频(图生视频)/Example 2: Image-to-video generation
|
|
123
|
+
> # 步骤1:上传图片获取 media_id/Step 1: Upload image to get media_id
|
|
124
|
+
> upload_url = "https://api.tikhub.io/api/v1/sora2/upload_image"
|
|
125
|
+
> with open("image.png", "rb") as f:
|
|
126
|
+
> files = {"file": ("image.png", f, "image/png")}
|
|
127
|
+
> upload_resp = requests.post(upload_url, headers=headers, files=files)
|
|
128
|
+
> media_id = upload_resp.json()["data"]["id"] # 例如: "media_01k7..."
|
|
129
|
+
>
|
|
130
|
+
> # 步骤2:使用 media_id 生成视频/Step 2: Use media_id to generate video
|
|
131
|
+
> payload = {
|
|
132
|
+
> "prompt": "Transform this image into a dynamic video scene",
|
|
133
|
+
> "orientation": "landscape",
|
|
134
|
+
> "media_id": media_id # 来自 upload_image 的 media_id
|
|
135
|
+
> }
|
|
136
|
+
> response = requests.post(url, headers=headers, json=payload)
|
|
137
|
+
>
|
|
138
|
+
> # 返回示例/Return example
|
|
139
|
+
> {
|
|
140
|
+
> "code": 200,
|
|
141
|
+
> "data": {
|
|
142
|
+
> "id": "task_01k7e05chaem08va8sq5qy2een",
|
|
143
|
+
> "priority": 1
|
|
144
|
+
> }
|
|
145
|
+
> }
|
|
146
|
+
> ```
|
|
147
|
+
|
|
148
|
+
#### Parameters
|
|
149
|
+
|
|
150
|
+
None
|
|
151
|
+
|
|
152
|
+
#### Request Body
|
|
153
|
+
|
|
154
|
+
- required: Yes
|
|
155
|
+
|
|
156
|
+
##### `application/json`
|
|
157
|
+
|
|
158
|
+
- Schema summary: `prompt*`:string, `orientation`:string, `media_id`:string
|
|
159
|
+
|
|
160
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
161
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
162
|
+
| prompt | string | Yes | 视频描述文本(最多2000字符)/Video description text (max 2000 chars) | None | A cat is playing Minecraft | None |
|
|
163
|
+
| orientation | string enum[portrait, landscape] | No | 视频方向:portrait(竖屏9:16) 或 landscape(横屏16:9)/Video orientation: portrait(9:16) or landscape(16:9) | portrait | None | enum[portrait, landscape] |
|
|
164
|
+
| media_id | string | No | 图片 media_id(可选),从 upload_image 接口获取,用于图生视频/Image media_id (optional) from upload_image endpoint for image-to-video generation | None | None | None |
|
|
165
|
+
|
|
166
|
+
#### Success Response
|
|
167
|
+
|
|
168
|
+
##### `200 application/json`
|
|
169
|
+
|
|
170
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
171
|
+
|
|
172
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
173
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
174
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
175
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
176
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
177
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
178
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
179
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
180
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
181
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
182
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
183
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
184
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
185
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
186
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
187
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
188
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
189
|
+
|
|
190
|
+
<a id="get-api-u1-v1-sora2-get-cameo-leaderboard"></a>
|
|
191
|
+
### `GET /api/u1/v1/sora2/get_cameo_leaderboard`
|
|
192
|
+
|
|
193
|
+
- Summary: 获取 Cameo 出镜秀达人排行榜/Fetch Cameo leaderboard
|
|
194
|
+
- Capabilities: general
|
|
195
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
196
|
+
- operationId: `get_cameo_leaderboard_api_v1_sora2_get_cameo_leaderboard_get`
|
|
197
|
+
|
|
198
|
+
#### Notes
|
|
199
|
+
|
|
200
|
+
> # [中文]
|
|
201
|
+
> ### 用途:
|
|
202
|
+
> - 获取 Sora Cameo 出镜秀达人排行榜
|
|
203
|
+
> - 展示在 Cameo 功能中被使用最多的用户
|
|
204
|
+
> - 支持分页获取更多排行榜数据
|
|
205
|
+
>
|
|
206
|
+
> ### 收费说明:
|
|
207
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
208
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
209
|
+
>
|
|
210
|
+
> ### 参数:
|
|
211
|
+
> - cursor: 翻页参数(可选),从上一次响应的 cursor 字段获取,每页返回 10 个用户
|
|
212
|
+
>
|
|
213
|
+
> ### 返回:
|
|
214
|
+
> - items: 用户排行榜列表(每页 10 个用户)
|
|
215
|
+
> - user_id: 用户 ID
|
|
216
|
+
> - username: 用户名
|
|
217
|
+
> - display_name: 显示名称
|
|
218
|
+
> - profile_picture_url: 头像链接
|
|
219
|
+
> - follower_count: 粉丝数
|
|
220
|
+
> - cameo_count: 被使用次数
|
|
221
|
+
> - cursor: 下一页参数,用于获取更多数据(如果为 null 表示已到末页)
|
|
222
|
+
>
|
|
223
|
+
> # [English]
|
|
224
|
+
> ### Purpose:
|
|
225
|
+
> - Fetch Sora Cameo leaderboard
|
|
226
|
+
> - Shows the most featured users in the Cameo function
|
|
227
|
+
> - Supports pagination to get more leaderboard data
|
|
228
|
+
>
|
|
229
|
+
> ### Pricing:
|
|
230
|
+
> - This API costs $0.05 per request
|
|
231
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
232
|
+
>
|
|
233
|
+
> ### Parameters:
|
|
234
|
+
> - cursor: Cursor for pagination (optional), obtained from the cursor field of the previous response, returns 10 users per page
|
|
235
|
+
>
|
|
236
|
+
> ### Return:
|
|
237
|
+
> - items: User leaderboard list (10 users per page)
|
|
238
|
+
> - user_id: User ID
|
|
239
|
+
> - username: Username
|
|
240
|
+
> - display_name: Display name
|
|
241
|
+
> - profile_picture_url: Profile picture URL
|
|
242
|
+
> - follower_count: Follower count
|
|
243
|
+
> - cameo_count: Feature count
|
|
244
|
+
> - cursor: Next page parameter for fetching more data (null means last page)
|
|
245
|
+
>
|
|
246
|
+
> # [示例/Example]
|
|
247
|
+
> ```python
|
|
248
|
+
> # 获取第一页排行榜
|
|
249
|
+
> # Get first page of leaderboard
|
|
250
|
+
> response = await get_cameo_leaderboard()
|
|
251
|
+
>
|
|
252
|
+
> # 使用 cursor 获取下一页
|
|
253
|
+
> # Use cursor to get next page
|
|
254
|
+
> cursor = response['cursor']
|
|
255
|
+
> next_page = await get_cameo_leaderboard(cursor=cursor)
|
|
256
|
+
> ```
|
|
257
|
+
|
|
258
|
+
#### Parameters
|
|
259
|
+
|
|
260
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
261
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
262
|
+
| cursor | query | string | No | 翻页参数(可选)/Cursor for pagination (optional) | None | None | None |
|
|
263
|
+
|
|
264
|
+
#### Request Body
|
|
265
|
+
|
|
266
|
+
None
|
|
267
|
+
|
|
268
|
+
#### Success Response
|
|
269
|
+
|
|
270
|
+
##### `200 application/json`
|
|
271
|
+
|
|
272
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
273
|
+
|
|
274
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
275
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
276
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
277
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
278
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
279
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
280
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
281
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
282
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
283
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
284
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
285
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
286
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
287
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
288
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
289
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
290
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
291
|
+
|
|
292
|
+
<a id="get-api-u1-v1-sora2-get-comment-replies"></a>
|
|
293
|
+
### `GET /api/u1/v1/sora2/get_comment_replies`
|
|
294
|
+
|
|
295
|
+
- Summary: 获取评论的回复/Fetch comment replies
|
|
296
|
+
- Capabilities: comments
|
|
297
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
298
|
+
- operationId: `get_comment_replies_api_v1_sora2_get_comment_replies_get`
|
|
299
|
+
|
|
300
|
+
#### Notes
|
|
301
|
+
|
|
302
|
+
> # [中文]
|
|
303
|
+
> ### 用途:
|
|
304
|
+
> - 获取一级评论的回复列表(二级评论)
|
|
305
|
+
> - 支持分页加载,每页返回 10 条回复
|
|
306
|
+
> - 用于展示评论的完整对话树
|
|
307
|
+
>
|
|
308
|
+
> ### 收费说明:
|
|
309
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
310
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
311
|
+
>
|
|
312
|
+
> ### 参数:
|
|
313
|
+
> - comment_id: 一级评论的 ID,必填(可从 get_post_comments 接口的返回中获取)
|
|
314
|
+
> - cursor: 翻页参数(可选),首次请求留空,后续请求使用上一次响应中的 cursor 值
|
|
315
|
+
>
|
|
316
|
+
> ### 返回:
|
|
317
|
+
> - children: 回复数据
|
|
318
|
+
> - items: 回复列表(10条/页)
|
|
319
|
+
> - id: 回复 ID
|
|
320
|
+
> - text: 回复文本内容
|
|
321
|
+
> - posted_by: 回复者用户 ID
|
|
322
|
+
> - posted_at: 回复时间戳
|
|
323
|
+
> - like_count: 点赞数
|
|
324
|
+
> - profile: 回复者信息
|
|
325
|
+
> - username: 用户名
|
|
326
|
+
> - display_name: 显示名称
|
|
327
|
+
> - profile_picture_url: 头像链接
|
|
328
|
+
> - cursor: 下一页参数(用于获取更多回复,无更多时为 null)
|
|
329
|
+
> - has_more: 是否有更多数据
|
|
330
|
+
>
|
|
331
|
+
> # [English]
|
|
332
|
+
> ### Purpose:
|
|
333
|
+
> - Fetch replies for a first-level comment (second-level comments)
|
|
334
|
+
> - Supports pagination, returns 10 replies per page
|
|
335
|
+
> - Used to display complete comment conversation tree
|
|
336
|
+
>
|
|
337
|
+
> ### Pricing:
|
|
338
|
+
> - This API costs $0.05 per request
|
|
339
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
340
|
+
>
|
|
341
|
+
> ### Parameters:
|
|
342
|
+
> - comment_id: First-level comment ID, required (can be obtained from get_post_comments response)
|
|
343
|
+
> - cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests
|
|
344
|
+
>
|
|
345
|
+
> ### Return:
|
|
346
|
+
> - children: Reply data
|
|
347
|
+
> - items: Reply list (10 items/page)
|
|
348
|
+
> - id: Reply ID
|
|
349
|
+
> - text: Reply text content
|
|
350
|
+
> - posted_by: Replier user ID
|
|
351
|
+
> - posted_at: Reply timestamp
|
|
352
|
+
> - like_count: Like count
|
|
353
|
+
> - profile: Replier information
|
|
354
|
+
> - username: Username
|
|
355
|
+
> - display_name: Display name
|
|
356
|
+
> - profile_picture_url: Avatar URL
|
|
357
|
+
> - cursor: Next page cursor (for loading more replies, null when no more)
|
|
358
|
+
> - has_more: Whether there are more data
|
|
359
|
+
>
|
|
360
|
+
> # [示例/Example]
|
|
361
|
+
> ```python
|
|
362
|
+
> # 首先获取一级评论
|
|
363
|
+
> # post_comments = get_post_comments("s_68e647d78e5081918cdeaf27e7edc735")
|
|
364
|
+
> # comment_id = post_comments['children']['items'][0]['id'] # 第一条评论的 ID
|
|
365
|
+
>
|
|
366
|
+
> # 然后获取该评论的回复
|
|
367
|
+
> comment_id = "68e659c5a37081919618c57baf499d0c"
|
|
368
|
+
> cursor = "" # 首次请求留空
|
|
369
|
+
> ```
|
|
370
|
+
|
|
371
|
+
#### Parameters
|
|
372
|
+
|
|
373
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
374
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
375
|
+
| comment_id | query | string | Yes | 一级评论ID/First-level comment ID | None | 68e659c5a37081919618c57baf499d0c | None |
|
|
376
|
+
| cursor | query | string | No | 翻页参数,从上一次响应中获取/Pagination cursor from previous response | None | None | None |
|
|
377
|
+
|
|
378
|
+
#### Request Body
|
|
379
|
+
|
|
380
|
+
None
|
|
381
|
+
|
|
382
|
+
#### Success Response
|
|
383
|
+
|
|
384
|
+
##### `200 application/json`
|
|
385
|
+
|
|
386
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
387
|
+
|
|
388
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
389
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
390
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
391
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
392
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
393
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
394
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
395
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
396
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
397
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
398
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
399
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
400
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
401
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
402
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
403
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
404
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
405
|
+
|
|
406
|
+
<a id="get-api-u1-v1-sora2-get-feed"></a>
|
|
407
|
+
### `GET /api/u1/v1/sora2/get_feed`
|
|
408
|
+
|
|
409
|
+
- Summary: 获取Feed流(热门/推荐视频)/Fetch feed
|
|
410
|
+
- Capabilities: general
|
|
411
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
412
|
+
- operationId: `get_feed_api_v1_sora2_get_feed_get`
|
|
413
|
+
|
|
414
|
+
#### Notes
|
|
415
|
+
|
|
416
|
+
> # [中文]
|
|
417
|
+
> ### 用途:
|
|
418
|
+
> - 获取 Sora 的 Feed 流(热门或推荐视频列表)
|
|
419
|
+
> - 默认返回过去 7 天的热门视频
|
|
420
|
+
> - 支持分页加载,每页返回约 15 条视频
|
|
421
|
+
> - 可通过 eager_views 参数提供观看记录来获得个性化推荐
|
|
422
|
+
>
|
|
423
|
+
> ### 收费说明:
|
|
424
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
425
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
426
|
+
>
|
|
427
|
+
> ### 参数:
|
|
428
|
+
> - cursor: 翻页参数(可选),首次请求留空,后续请求使用上一次响应中的 cursor 值
|
|
429
|
+
> - eager_views: 观看记录(可选),JSON 字符串格式
|
|
430
|
+
> - 默认值:`{"views":[]}`(空观看记录,返回通用热门)
|
|
431
|
+
> - 包含观看记录示例:`{"views":[{"id":"s_xxx","watch_time":0.24,"dwell_time":3.94}]}`
|
|
432
|
+
> - 提供观看记录可获得更个性化的推荐结果
|
|
433
|
+
>
|
|
434
|
+
> ### 返回:
|
|
435
|
+
> - items: 视频列表(约15条/页)
|
|
436
|
+
> - post: 作品信息
|
|
437
|
+
> - id: 作品 ID
|
|
438
|
+
> - text: 作品描述
|
|
439
|
+
> - attachments: 视频附件信息
|
|
440
|
+
> - like_count: 点赞数
|
|
441
|
+
> - view_count: 浏览数
|
|
442
|
+
> - reply_count: 评论数
|
|
443
|
+
> - posted_at: 发布时间戳
|
|
444
|
+
> - profile: 作者信息
|
|
445
|
+
> - cursor: 下一页参数(用于获取更多视频,无更多时为 null)
|
|
446
|
+
> - has_more: 是否有更多数据
|
|
447
|
+
>
|
|
448
|
+
> # [English]
|
|
449
|
+
> ### Purpose:
|
|
450
|
+
> - Fetch Sora's feed stream (trending or recommended video list)
|
|
451
|
+
> - Returns trending videos from the past 7 days by default
|
|
452
|
+
> - Supports pagination, returns approximately 15 videos per page
|
|
453
|
+
> - Can provide watch history via eager_views parameter for personalized recommendations
|
|
454
|
+
>
|
|
455
|
+
> ### Pricing:
|
|
456
|
+
> - This API costs $0.05 per request
|
|
457
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
458
|
+
>
|
|
459
|
+
> ### Parameters:
|
|
460
|
+
> - cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests
|
|
461
|
+
> - eager_views: Watch history (optional), JSON string format
|
|
462
|
+
> - Default value: `{"views":[]}` (empty watch history, returns general trending)
|
|
463
|
+
> - With watch history example: `{"views":[{"id":"s_xxx","watch_time":0.24,"dwell_time":3.94}]}`
|
|
464
|
+
> - Providing watch history enables more personalized recommendation results
|
|
465
|
+
>
|
|
466
|
+
> ### Return:
|
|
467
|
+
> - items: Video list (approx. 15 items/page)
|
|
468
|
+
> - post: Post information
|
|
469
|
+
> - id: Post ID
|
|
470
|
+
> - text: Post description
|
|
471
|
+
> - attachments: Video attachment info
|
|
472
|
+
> - like_count: Like count
|
|
473
|
+
> - view_count: View count
|
|
474
|
+
> - reply_count: Comment count
|
|
475
|
+
> - posted_at: Post timestamp
|
|
476
|
+
> - profile: Author information
|
|
477
|
+
> - cursor: Next page cursor (for loading more videos, null when no more)
|
|
478
|
+
> - has_more: Whether there are more data
|
|
479
|
+
>
|
|
480
|
+
> # [示例/Example]
|
|
481
|
+
> ```python
|
|
482
|
+
> # 第一次请求(获取热门视频,无观看记录)
|
|
483
|
+
> cursor = ""
|
|
484
|
+
> eager_views = '{"views":[]}'
|
|
485
|
+
>
|
|
486
|
+
> # 第二次请求(带观看记录,获得个性化推荐)
|
|
487
|
+
> eager_views = '{"views":[{"id":"s_68e853d2ad448191b3c81e830f53c3a2","watch_time":0.24,"dwell_time":3.94}]}'
|
|
488
|
+
>
|
|
489
|
+
> # 第三次请求(获取下一页)
|
|
490
|
+
> cursor = "eyJjdXQiOiJuZjJfdG9wXzdkIiwibGltaXQiOjE1LCJvZmZzZXQiOjE1fQ=="
|
|
491
|
+
> ```
|
|
492
|
+
|
|
493
|
+
#### Parameters
|
|
494
|
+
|
|
495
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
496
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
497
|
+
| cursor | query | string | No | 翻页参数,从上一次响应中获取/Pagination cursor from previous response | None | None | None |
|
|
498
|
+
| eager_views | query | string | No | 观看记录JSON字符串(可选),用于个性化推荐/Watch history JSON string (optional), for personalized recommendations | None | {"views":[]} | None |
|
|
499
|
+
|
|
500
|
+
#### Request Body
|
|
501
|
+
|
|
502
|
+
None
|
|
503
|
+
|
|
504
|
+
#### Success Response
|
|
505
|
+
|
|
506
|
+
##### `200 application/json`
|
|
507
|
+
|
|
508
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
509
|
+
|
|
510
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
511
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
512
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
513
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
514
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
515
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
516
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
517
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
518
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
519
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
520
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
521
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
522
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
523
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
524
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
525
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
526
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
527
|
+
|
|
528
|
+
<a id="get-api-u1-v1-sora2-get-post-comments"></a>
|
|
529
|
+
### `GET /api/u1/v1/sora2/get_post_comments`
|
|
530
|
+
|
|
531
|
+
- Summary: 获取作品一级评论/Fetch post comments
|
|
532
|
+
- Capabilities: comments / content details
|
|
533
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
534
|
+
- operationId: `get_post_comments_api_v1_sora2_get_post_comments_get`
|
|
535
|
+
|
|
536
|
+
#### Notes
|
|
537
|
+
|
|
538
|
+
> # [中文]
|
|
539
|
+
> ### 用途:
|
|
540
|
+
> - 获取 Sora 作品的一级评论列表(顶层评论)
|
|
541
|
+
> - 支持分页加载,每页返回 10 条评论
|
|
542
|
+
> - 可用于评论展示、数据分析等场景
|
|
543
|
+
>
|
|
544
|
+
> ### 收费说明:
|
|
545
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
546
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
547
|
+
>
|
|
548
|
+
> ### 参数:
|
|
549
|
+
> - post_id: 作品 ID,必填
|
|
550
|
+
> - cursor: 翻页参数(可选),首次请求留空,后续请求使用上一次响应中的 cursor 值
|
|
551
|
+
>
|
|
552
|
+
> ### 返回:
|
|
553
|
+
> - children: 评论数据
|
|
554
|
+
> - items: 评论列表(10条/页)
|
|
555
|
+
> - id: 评论 ID
|
|
556
|
+
> - text: 评论文本内容
|
|
557
|
+
> - posted_by: 评论者用户 ID
|
|
558
|
+
> - posted_at: 评论时间戳
|
|
559
|
+
> - like_count: 点赞数
|
|
560
|
+
> - reply_count: 回复数(二级评论数)
|
|
561
|
+
> - profile: 评论者信息
|
|
562
|
+
> - username: 用户名
|
|
563
|
+
> - display_name: 显示名称
|
|
564
|
+
> - profile_picture_url: 头像链接
|
|
565
|
+
> - cursor: 下一页参数(用于获取更多评论,无更多时为 null)
|
|
566
|
+
> - has_more: 是否有更多数据
|
|
567
|
+
>
|
|
568
|
+
> # [English]
|
|
569
|
+
> ### Purpose:
|
|
570
|
+
> - Fetch first-level comments (top-level comments) for a Sora post
|
|
571
|
+
> - Supports pagination, returns 10 comments per page
|
|
572
|
+
> - Can be used for comment display, data analysis, etc.
|
|
573
|
+
>
|
|
574
|
+
> ### Pricing:
|
|
575
|
+
> - This API costs $0.05 per request
|
|
576
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
577
|
+
>
|
|
578
|
+
> ### Parameters:
|
|
579
|
+
> - post_id: Post ID, required
|
|
580
|
+
> - cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests
|
|
581
|
+
>
|
|
582
|
+
> ### Return:
|
|
583
|
+
> - children: Comment data
|
|
584
|
+
> - items: Comment list (10 items/page)
|
|
585
|
+
> - id: Comment ID
|
|
586
|
+
> - text: Comment text content
|
|
587
|
+
> - posted_by: Commenter user ID
|
|
588
|
+
> - posted_at: Comment timestamp
|
|
589
|
+
> - like_count: Like count
|
|
590
|
+
> - reply_count: Reply count (second-level comments)
|
|
591
|
+
> - profile: Commenter information
|
|
592
|
+
> - username: Username
|
|
593
|
+
> - display_name: Display name
|
|
594
|
+
> - profile_picture_url: Avatar URL
|
|
595
|
+
> - cursor: Next page cursor (for loading more comments, null when no more)
|
|
596
|
+
> - has_more: Whether there are more data
|
|
597
|
+
>
|
|
598
|
+
> # [示例/Example]
|
|
599
|
+
> ```python
|
|
600
|
+
> # 第一次请求(获取前 10 条评论)
|
|
601
|
+
> post_id = "s_68e647d78e5081918cdeaf27e7edc735"
|
|
602
|
+
> cursor = "" # 首次请求留空
|
|
603
|
+
>
|
|
604
|
+
> # 第二次请求(获取下一页)
|
|
605
|
+
> # 使用上一次响应中的 cursor 值
|
|
606
|
+
> cursor = "eyJwb3N0X2lkIjoiNjhlNjQ3ZDc4ZTUwODE5MThjZGVhZjI3ZTdlZGM3MzUi..."
|
|
607
|
+
> ```
|
|
608
|
+
|
|
609
|
+
#### Parameters
|
|
610
|
+
|
|
611
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
612
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
613
|
+
| post_id | query | string | Yes | 作品ID/Post ID | None | s_68e647d78e5081918cdeaf27e7edc735 | None |
|
|
614
|
+
| cursor | query | string | No | 翻页参数,从上一次响应中获取/Pagination cursor from previous response | None | None | None |
|
|
615
|
+
|
|
616
|
+
#### Request Body
|
|
617
|
+
|
|
618
|
+
None
|
|
619
|
+
|
|
620
|
+
#### Success Response
|
|
621
|
+
|
|
622
|
+
##### `200 application/json`
|
|
623
|
+
|
|
624
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
625
|
+
|
|
626
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
627
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
628
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
629
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
630
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
631
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
632
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
633
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
634
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
635
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
636
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
637
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
638
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
639
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
640
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
641
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
642
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
643
|
+
|
|
644
|
+
<a id="get-api-u1-v1-sora2-get-post-detail"></a>
|
|
645
|
+
### `GET /api/u1/v1/sora2/get_post_detail`
|
|
646
|
+
|
|
647
|
+
- Summary: 获取单一作品详情/Fetch single post detail
|
|
648
|
+
- Capabilities: content details / details
|
|
649
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
650
|
+
- operationId: `get_post_detail_api_v1_sora2_get_post_detail_get`
|
|
651
|
+
|
|
652
|
+
#### Notes
|
|
653
|
+
|
|
654
|
+
> # [中文]
|
|
655
|
+
> ### 用途:
|
|
656
|
+
> - 获取 Sora 作品的完整详情信息,包括视频信息、作者信息、统计数据等
|
|
657
|
+
> - 支持通过作品 ID 或作品链接查询
|
|
658
|
+
> - 可用于数据分析、无水印视频下载等场景
|
|
659
|
+
>
|
|
660
|
+
> ### 收费说明:
|
|
661
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
662
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
663
|
+
>
|
|
664
|
+
> ### 参数:
|
|
665
|
+
> - post_id: 作品 ID(可选),格式如 `s_68e853d2ad448191b3c81e830f53c3a2`
|
|
666
|
+
> - post_url: 作品链接(可选),格式如 `https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2`
|
|
667
|
+
> - **注意**: post_id 和 post_url 至少提供一个
|
|
668
|
+
>
|
|
669
|
+
> ### 返回:
|
|
670
|
+
> - post: 作品详细信息
|
|
671
|
+
> - id: 作品 ID
|
|
672
|
+
> - text: 作品描述文本
|
|
673
|
+
> - attachments: 附件列表(视频信息)
|
|
674
|
+
> - url: 无水印视频链接
|
|
675
|
+
> - downloadable_url: 有水印视频链接
|
|
676
|
+
> - width/height: 视频尺寸
|
|
677
|
+
> - encodings: 不同质量的编码版本
|
|
678
|
+
> - like_count: 点赞数
|
|
679
|
+
> - view_count: 浏览数
|
|
680
|
+
> - reply_count: 评论数
|
|
681
|
+
> - remix_count: 混剪数
|
|
682
|
+
> - shared_by: 作者用户 ID
|
|
683
|
+
> - posted_at: 发布时间戳
|
|
684
|
+
> - permalink: 作品永久链接
|
|
685
|
+
> - profile: 作者信息
|
|
686
|
+
> - user_id: 用户 ID
|
|
687
|
+
> - username: 用户名
|
|
688
|
+
> - display_name: 显示名称
|
|
689
|
+
> - profile_picture_url: 头像链接
|
|
690
|
+
> - follower_count: 粉丝数
|
|
691
|
+
>
|
|
692
|
+
> # [English]
|
|
693
|
+
> ### Purpose:
|
|
694
|
+
> - Fetch complete details of a Sora post, including video info, author info, and statistics
|
|
695
|
+
> - Supports querying by post ID or post URL
|
|
696
|
+
> - Can be used for data analysis, watermark-free video downloads, etc.
|
|
697
|
+
>
|
|
698
|
+
> ### Pricing:
|
|
699
|
+
> - This API costs $0.05 per request
|
|
700
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
701
|
+
>
|
|
702
|
+
> ### Parameters:
|
|
703
|
+
> - post_id: Post ID (optional), format like `s_68e853d2ad448191b3c81e830f53c3a2`
|
|
704
|
+
> - post_url: Post URL (optional), format like `https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2`
|
|
705
|
+
> - **Note**: At least one of post_id or post_url must be provided
|
|
706
|
+
>
|
|
707
|
+
> ### Return:
|
|
708
|
+
> - post: Post detailed information
|
|
709
|
+
> - id: Post ID
|
|
710
|
+
> - text: Post description text
|
|
711
|
+
> - attachments: Attachment list (video info)
|
|
712
|
+
> - url: No watermark video link
|
|
713
|
+
> - downloadable_url: Watermarked video link
|
|
714
|
+
> - width/height: Video dimensions
|
|
715
|
+
> - encodings: Different quality encoding versions
|
|
716
|
+
> - like_count: Like count
|
|
717
|
+
> - view_count: View count
|
|
718
|
+
> - reply_count: Comment count
|
|
719
|
+
> - remix_count: Remix count
|
|
720
|
+
> - shared_by: Author user ID
|
|
721
|
+
> - posted_at: Post timestamp
|
|
722
|
+
> - permalink: Permanent link
|
|
723
|
+
> - profile: Author information
|
|
724
|
+
> - user_id: User ID
|
|
725
|
+
> - username: Username
|
|
726
|
+
> - display_name: Display name
|
|
727
|
+
> - profile_picture_url: Avatar URL
|
|
728
|
+
> - follower_count: Follower count
|
|
729
|
+
>
|
|
730
|
+
> # [示例/Example]
|
|
731
|
+
> ```python
|
|
732
|
+
> # 使用作品 ID 查询
|
|
733
|
+
> post_id = "s_68e853d2ad448191b3c81e830f53c3a2"
|
|
734
|
+
>
|
|
735
|
+
> # 或使用作品链接查询
|
|
736
|
+
> post_url = "https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2"
|
|
737
|
+
> ```
|
|
738
|
+
|
|
739
|
+
#### Parameters
|
|
740
|
+
|
|
741
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
742
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
743
|
+
| post_id | query | string | No | 作品ID(可选)/Post ID (optional) | None | s_68e853d2ad448191b3c81e830f53c3a2 | None |
|
|
744
|
+
| post_url | query | string | No | 作品链接(可选)/Post URL (optional) | None | https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2 | None |
|
|
745
|
+
|
|
746
|
+
#### Request Body
|
|
747
|
+
|
|
748
|
+
None
|
|
749
|
+
|
|
750
|
+
#### Success Response
|
|
751
|
+
|
|
752
|
+
##### `200 application/json`
|
|
753
|
+
|
|
754
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
755
|
+
|
|
756
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
757
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
758
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
759
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
760
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
761
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
762
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
763
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
764
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
765
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
766
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
767
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
768
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
769
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
770
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
771
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
772
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
773
|
+
|
|
774
|
+
<a id="get-api-u1-v1-sora2-get-post-remix-list"></a>
|
|
775
|
+
### `GET /api/u1/v1/sora2/get_post_remix_list`
|
|
776
|
+
|
|
777
|
+
- Summary: 获取作品的 Remix 列表/Fetch post remix list
|
|
778
|
+
- Capabilities: content details
|
|
779
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
780
|
+
- operationId: `get_post_remix_list_api_v1_sora2_get_post_remix_list_get`
|
|
781
|
+
|
|
782
|
+
#### Notes
|
|
783
|
+
|
|
784
|
+
> # [中文]
|
|
785
|
+
> ### 用途:
|
|
786
|
+
> - 获取 Sora 作品的 Remix 列表
|
|
787
|
+
> - 支持通过作品 ID 或作品链接查询
|
|
788
|
+
> - 支持分页获取更多 Remix 作品
|
|
789
|
+
>
|
|
790
|
+
> ### 收费说明:
|
|
791
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
792
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
793
|
+
>
|
|
794
|
+
> ### 参数:
|
|
795
|
+
> - post_id: 作品 ID(可选),格式如 `s_68e466aa780c8191b`
|
|
796
|
+
> - post_url: 作品链接(可选),格式如 `https://sora.chatgpt.com/p/s_68e466aa780c8191b2357907ce7d1a39`
|
|
797
|
+
> - cursor: 翻页参数(可选),从上一次响应的 cursor 字段获取
|
|
798
|
+
> - **注意**: post_id 和 post_url 至少提供一个
|
|
799
|
+
>
|
|
800
|
+
> ### 返回:
|
|
801
|
+
> - items: Remix 作品列表
|
|
802
|
+
> - id: 作品 ID
|
|
803
|
+
> - text: 作品描述文本
|
|
804
|
+
> - attachments: 附件列表(视频信息)
|
|
805
|
+
> - like_count: 点赞数
|
|
806
|
+
> - view_count: 浏览数
|
|
807
|
+
> - reply_count: 评论数
|
|
808
|
+
> - remix_count: 混剪数
|
|
809
|
+
> - shared_by: 作者用户 ID
|
|
810
|
+
> - posted_at: 发布时间戳
|
|
811
|
+
> - cursor: 下一页参数,用于获取更多数据(如果为 null 表示已到末页)
|
|
812
|
+
>
|
|
813
|
+
> # [English]
|
|
814
|
+
> ### Purpose:
|
|
815
|
+
> - Fetch the Remix list of a Sora post
|
|
816
|
+
> - Supports querying by post ID or post URL
|
|
817
|
+
> - Supports pagination to get more Remix posts
|
|
818
|
+
>
|
|
819
|
+
> ### Pricing:
|
|
820
|
+
> - This API costs $0.05 per request
|
|
821
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
822
|
+
>
|
|
823
|
+
> ### Parameters:
|
|
824
|
+
> - post_id: Post ID (optional), format like `s_68e466aa780c8191b`
|
|
825
|
+
> - post_url: Post URL (optional), format like `https://sora.chatgpt.com/p/s_68e466aa780c8191b2357907ce7d1a39`
|
|
826
|
+
> - cursor: Cursor for pagination (optional), obtained from the cursor field of the previous response
|
|
827
|
+
> - **Note**: At least one of post_id or post_url must be provided
|
|
828
|
+
>
|
|
829
|
+
> ### Return:
|
|
830
|
+
> - items: Remix post list
|
|
831
|
+
> - id: Post ID
|
|
832
|
+
> - text: Post description text
|
|
833
|
+
> - attachments: Attachment list (video info)
|
|
834
|
+
> - like_count: Like count
|
|
835
|
+
> - view_count: View count
|
|
836
|
+
> - reply_count: Comment count
|
|
837
|
+
> - remix_count: Remix count
|
|
838
|
+
> - shared_by: Author user ID
|
|
839
|
+
> - posted_at: Post timestamp
|
|
840
|
+
> - cursor: Next page parameter for fetching more data (null means last page)
|
|
841
|
+
>
|
|
842
|
+
> # [示例/Example]
|
|
843
|
+
> ```python
|
|
844
|
+
> # 使用作品 ID 查询第一页
|
|
845
|
+
> post_id = "s_68e466aa780c8191b"
|
|
846
|
+
>
|
|
847
|
+
> # 使用 cursor 获取下一页
|
|
848
|
+
> cursor = "eyJsYXN0X3Bvc3RfaWQiOiJzXzY4ZTQ2NmFhNzgwYzgxOTFiIn0="
|
|
849
|
+
> ```
|
|
850
|
+
|
|
851
|
+
#### Parameters
|
|
852
|
+
|
|
853
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
854
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
855
|
+
| post_id | query | string | No | 作品ID(可选)/Post ID (optional) | None | s_690acc0f4fcc8191ab5a75a96b6b6caf | None |
|
|
856
|
+
| post_url | query | string | No | 作品链接(可选)/Post URL (optional) | None | https://sora.chatgpt.com/p/s_690acc0f4fcc8191ab5a75a96b6b6caf | None |
|
|
857
|
+
| cursor | query | string | No | 翻页参数(可选)/Cursor for pagination (optional) | None | None | None |
|
|
858
|
+
|
|
859
|
+
#### Request Body
|
|
860
|
+
|
|
861
|
+
None
|
|
862
|
+
|
|
863
|
+
#### Success Response
|
|
864
|
+
|
|
865
|
+
##### `200 application/json`
|
|
866
|
+
|
|
867
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
868
|
+
|
|
869
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
870
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
871
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
872
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
873
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
874
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
875
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
876
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
877
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
878
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
879
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
880
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
881
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
882
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
883
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
884
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
885
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
886
|
+
|
|
887
|
+
<a id="get-api-u1-v1-sora2-get-task-detail"></a>
|
|
888
|
+
### `GET /api/u1/v1/sora2/get_task_detail`
|
|
889
|
+
|
|
890
|
+
- Summary: [已弃用/Deprecated] 获取任务生成的作品详情(无水印版本)/Get task-generated post detail (watermark-free)
|
|
891
|
+
- Capabilities: details
|
|
892
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
893
|
+
- operationId: `get_task_detail_api_v1_sora2_get_task_detail_get`
|
|
894
|
+
|
|
895
|
+
#### Notes
|
|
896
|
+
|
|
897
|
+
> # [中文]
|
|
898
|
+
> ## ⚠️ 此接口已弃用。AI 相关接口已迁移至独立的 TikHub AI API 服务,与 TikHub 社交媒体 API 分离部署。请访问:https://ai.tikhub.io
|
|
899
|
+
> ### 用途:
|
|
900
|
+
> - **获取视频生成任务的完整作品详情,包含无水印版本的视频链接**
|
|
901
|
+
>
|
|
902
|
+
> ### 收费说明:
|
|
903
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
904
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
905
|
+
>
|
|
906
|
+
> ### 参数:
|
|
907
|
+
> - task_id: 任务 ID(可选),格式如 `task_01k7e17rnkeh79qnrcdwf5fcfs`
|
|
908
|
+
> - 从 create_video 接口返回的任务 ID
|
|
909
|
+
> - 必须以 'task_' 开头
|
|
910
|
+
> - generation_id: 生成 ID(可选),格式如 `gen_01k7e1bff9eq6rxe9pntk7xdcf`
|
|
911
|
+
> - 从 get_task_status 接口返回的 generations[0].id
|
|
912
|
+
> - 必须以 'gen_' 开头
|
|
913
|
+
> - **注意**: task_id 和 generation_id 至少需要提供一个
|
|
914
|
+
>
|
|
915
|
+
> ### 返回(无水印完整作品详情):
|
|
916
|
+
> - post: 作品详细信息
|
|
917
|
+
> - id: 作品 ID
|
|
918
|
+
> - text: 作品描述文本
|
|
919
|
+
> - attachments: 附件列表(**无水印视频信息**)
|
|
920
|
+
> - **url: 无水印视频链接(原始质量)** ⭐
|
|
921
|
+
> - downloadable_url: 有水印视频链接
|
|
922
|
+
> - width/height: 视频尺寸
|
|
923
|
+
> - encodings: 不同质量的编码版本
|
|
924
|
+
> - **thumbnail: 缩略图(无水印)**
|
|
925
|
+
> - **md: 中等质量视频(无水印)**
|
|
926
|
+
> - **gif: 预览 GIF(无水印)**
|
|
927
|
+
> - like_count: 点赞数
|
|
928
|
+
> - view_count: 浏览数
|
|
929
|
+
> - reply_count: 评论数
|
|
930
|
+
> - remix_count: 混剪数
|
|
931
|
+
> - posted_at: 发布时间戳
|
|
932
|
+
> - permalink: 作品永久链接
|
|
933
|
+
>
|
|
934
|
+
> ### 注意:
|
|
935
|
+
> - **本接口返回的视频链接是无水印的原始质量版本**
|
|
936
|
+
> - 只有任务状态为 succeeded 时才能成功调用
|
|
937
|
+
> - 如果任务未完成,会返回相应的错误信息
|
|
938
|
+
> - 推荐使用 generation_id 参数
|
|
939
|
+
> - 视频链接有时效性,建议及时下载
|
|
940
|
+
>
|
|
941
|
+
> # [English]
|
|
942
|
+
> ## ⚠️ This endpoint has been deprecated. AI-related endpoints have been migrated to a dedicated TikHub AI API service, which operates separately from the TikHub Social Media API. Please visit: https://ai.tikhub.io
|
|
943
|
+
> ### Purpose:
|
|
944
|
+
> - **Get complete post details of video generation task, including watermark-free video links**
|
|
945
|
+
>
|
|
946
|
+
> ### Pricing:
|
|
947
|
+
> - This API costs $0.05 per request
|
|
948
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
949
|
+
>
|
|
950
|
+
> ### Parameters:
|
|
951
|
+
> - task_id: Task ID (optional), format like `task_01k7e17rnkeh79qnrcdwf5fcfs`
|
|
952
|
+
> - Task ID returned from create_video endpoint
|
|
953
|
+
> - Must start with 'task_'
|
|
954
|
+
> - generation_id: Generation ID (optional), format like `gen_01k7e1bff9eq6rxe9pntk7xdcf`
|
|
955
|
+
> - Get from generations[0].id returned by get_task_status endpoint
|
|
956
|
+
> - Must start with 'gen_'
|
|
957
|
+
> - **Note**: At least one of task_id or generation_id must be provided
|
|
958
|
+
>
|
|
959
|
+
> ### Return (Watermark-free Complete Post Details):
|
|
960
|
+
> - post: Post detailed information
|
|
961
|
+
> - id: Post ID
|
|
962
|
+
> - text: Post description text
|
|
963
|
+
> - attachments: Attachment list (**Watermark-free video info**)
|
|
964
|
+
> - **url: Watermark-free video link (original quality)** ⭐
|
|
965
|
+
> - downloadable_url: Watermarked video link
|
|
966
|
+
> - width/height: Video dimensions
|
|
967
|
+
> - encodings: Different quality encoding versions
|
|
968
|
+
> - **thumbnail: Thumbnail (watermark-free)**
|
|
969
|
+
> - **md: Medium quality video (watermark-free)**
|
|
970
|
+
> - **gif: Preview GIF (watermark-free)**
|
|
971
|
+
> - like_count: Like count
|
|
972
|
+
> - view_count: View count
|
|
973
|
+
> - reply_count: Comment count
|
|
974
|
+
> - remix_count: Remix count
|
|
975
|
+
> - posted_at: Post timestamp
|
|
976
|
+
> - permalink: Permanent link
|
|
977
|
+
>
|
|
978
|
+
> ### Note:
|
|
979
|
+
> - **This endpoint returns watermark-free original quality video links**
|
|
980
|
+
> - Can only be called successfully when task status is succeeded
|
|
981
|
+
> - Will return error message if task is not completed
|
|
982
|
+
> - Recommend using task_id parameter, will auto-fetch required generation_id
|
|
983
|
+
> - Video links have expiration time, recommend downloading promptly
|
|
984
|
+
>
|
|
985
|
+
> # [示例/Example]
|
|
986
|
+
> ```python
|
|
987
|
+
> # 返回示例 (无水印完整信息)
|
|
988
|
+
> # Return example (watermark-free complete info)
|
|
989
|
+
> {
|
|
990
|
+
> "post":{
|
|
991
|
+
> "id":"s_68ecb45b40988191b89a0af80135a33c",
|
|
992
|
+
> "posted_to_public":false,
|
|
993
|
+
> "posted_at":1760343131.252443,
|
|
994
|
+
> "updated_at":1760343140.655776,
|
|
995
|
+
> "like_count":0,
|
|
996
|
+
> "recursive_reply_count":0,
|
|
997
|
+
> "reply_count":0,
|
|
998
|
+
> "view_count":0,
|
|
999
|
+
> "unique_view_count":0,
|
|
1000
|
+
> "remix_count":0,
|
|
1001
|
+
> "user_liked":false,
|
|
1002
|
+
> "source":"sy",
|
|
1003
|
+
> "text":"A cat is playing Minecraft",
|
|
1004
|
+
> "caption":null,
|
|
1005
|
+
> "cover_photo_url":null,
|
|
1006
|
+
> "preview_image_url":"https://ogimg.chatgpt.com/?postId=s_68ecb45b40988191b89a0af80135a33c",
|
|
1007
|
+
> "attachments":[
|
|
1008
|
+
> {
|
|
1009
|
+
> "id":"s_68ecb45b40988191b89a0af80135a33c-attachment-0",
|
|
1010
|
+
> "tags":[
|
|
1011
|
+
> "sora"
|
|
1012
|
+
> ],
|
|
1013
|
+
> "kind":"sora",
|
|
1014
|
+
> "generation_id":"gen_01k7e9yzk2e4vr88ykfbtpz1ka",
|
|
1015
|
+
> "generation_type":"video_gen",
|
|
1016
|
+
> "url":"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000%2Fsrc.mp4?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=NOaGqX50rV7s4Rrmpk8s0eJoHlhS3WHagn0Cz1wuDAM%3D&az=oaivgprodscus",
|
|
1017
|
+
> "downloadable_url":"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000_wm%2Fsrc.mp4?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=xiYmjG29NvQi9t5BGqu0tHl2%2BnRoA8eLNssPbLzmTxI%3D&az=oaivgprodscus",
|
|
1018
|
+
> "width":352,
|
|
1019
|
+
> "height":640,
|
|
1020
|
+
> "prompt":null,
|
|
1021
|
+
> "task_id":null,
|
|
1022
|
+
> "output_blocked":false,
|
|
1023
|
+
> "title":null,
|
|
1024
|
+
> "source":null,
|
|
1025
|
+
> "encodings":{
|
|
1026
|
+
> "source":{
|
|
1027
|
+
> "path":"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000%2Fsrc.mp4?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=NOaGqX50rV7s4Rrmpk8s0eJoHlhS3WHagn0Cz1wuDAM%3D&az=oaivgprodscus"
|
|
1028
|
+
> },
|
|
1029
|
+
> "source_wm":{
|
|
1030
|
+
> "path":"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000_wm%2Fsrc.mp4?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=xiYmjG29NvQi9t5BGqu0tHl2%2BnRoA8eLNssPbLzmTxI%3D&az=oaivgprodscus"
|
|
1031
|
+
> },
|
|
1032
|
+
> "thumbnail":{
|
|
1033
|
+
> "path":"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000%2Fthumbnail.webp?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=qKQRiyaELAV9lr5B0mJ89vvHSptRXWrAvZHvSPLfBjc%3D&az=oaivgprodscus"
|
|
1034
|
+
> },
|
|
1035
|
+
> "unfurl":null,
|
|
1036
|
+
> "md":{
|
|
1037
|
+
> "path":"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000%2Fmd.mp4?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=%2FlBkZ6aqa8z6vwP2x%2FDezkCuM65t%2FM5vtglAEv85v5U%3D&az=oaivgprodscus"
|
|
1038
|
+
> },
|
|
1039
|
+
> "gif":{
|
|
1040
|
+
> "path":"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000%2Fpreview.gif?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=mZsaMyviqaR13sMjZ3W8GAuFPHCYQA2BcPS5jwnIaDg%3D&az=oaivgprodscus"
|
|
1041
|
+
> }
|
|
1042
|
+
> },
|
|
1043
|
+
> "asset_pointer":null,
|
|
1044
|
+
> "conversation_id":null
|
|
1045
|
+
> }
|
|
1046
|
+
> ],
|
|
1047
|
+
> "parent_post_id":null,
|
|
1048
|
+
> "root_post_id":null,
|
|
1049
|
+
> "parent_path":null,
|
|
1050
|
+
> "tombstoned_at":null,
|
|
1051
|
+
> "permalink":"https://sora.chatgpt.com/p/s_68ecb45b40988191b89a0af80135a33c",
|
|
1052
|
+
> "text_facets":[
|
|
1053
|
+
>
|
|
1054
|
+
> ],
|
|
1055
|
+
> "cameo_profiles":null,
|
|
1056
|
+
> "disabled_cameo_user_ids":null,
|
|
1057
|
+
> "groups":[
|
|
1058
|
+
>
|
|
1059
|
+
> ],
|
|
1060
|
+
> "user_disliked":false,
|
|
1061
|
+
> "verifications":[
|
|
1062
|
+
>
|
|
1063
|
+
> ],
|
|
1064
|
+
> "dislike_count":0,
|
|
1065
|
+
> "remix_posts":{
|
|
1066
|
+
> "items":[
|
|
1067
|
+
>
|
|
1068
|
+
> ],
|
|
1069
|
+
> "cursor":null
|
|
1070
|
+
> },
|
|
1071
|
+
> "ancestors":{
|
|
1072
|
+
> "items":[
|
|
1073
|
+
>
|
|
1074
|
+
> ],
|
|
1075
|
+
> "cursor":null
|
|
1076
|
+
> },
|
|
1077
|
+
> "parent_post":null,
|
|
1078
|
+
> "emoji":"🐱💻",
|
|
1079
|
+
> "is_featured":null
|
|
1080
|
+
> }
|
|
1081
|
+
> }
|
|
1082
|
+
> ```
|
|
1083
|
+
|
|
1084
|
+
#### Parameters
|
|
1085
|
+
|
|
1086
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1087
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1088
|
+
| task_id | query | string | No | 任务ID(可选,与generation_id二选一)/Task ID (optional, choose one with generation_id) | None | task_01k7e17rnkeh79qnrcdwf5fcfs | None |
|
|
1089
|
+
| generation_id | query | string | No | 生成ID(可选,与task_id二选一)/Generation ID (optional, choose one with task_id) | None | gen_01k7e1bff9eq6rxe9pntk7xdcf | None |
|
|
1090
|
+
|
|
1091
|
+
#### Request Body
|
|
1092
|
+
|
|
1093
|
+
None
|
|
1094
|
+
|
|
1095
|
+
#### Success Response
|
|
1096
|
+
|
|
1097
|
+
##### `200 application/json`
|
|
1098
|
+
|
|
1099
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1100
|
+
|
|
1101
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1102
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1103
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1104
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1105
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1106
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1107
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1108
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1109
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1110
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1111
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1112
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1113
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1114
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1115
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1116
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1117
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1118
|
+
|
|
1119
|
+
<a id="get-api-u1-v1-sora2-get-task-status"></a>
|
|
1120
|
+
### `GET /api/u1/v1/sora2/get_task_status`
|
|
1121
|
+
|
|
1122
|
+
- Summary: [已弃用/Deprecated] 查询任务状态/Get task status
|
|
1123
|
+
- Capabilities: general
|
|
1124
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1125
|
+
- operationId: `get_task_status_api_v1_sora2_get_task_status_get`
|
|
1126
|
+
|
|
1127
|
+
#### Notes
|
|
1128
|
+
|
|
1129
|
+
> # [中文]
|
|
1130
|
+
> ## ⚠️ 此接口已弃用。AI 相关接口已迁移至独立的 TikHub AI API 服务,与 TikHub 社交媒体 API 分离部署。请访问:https://ai.tikhub.io
|
|
1131
|
+
> ### 用途:
|
|
1132
|
+
> - 查询视频生成任务的当前状态和结果
|
|
1133
|
+
> - 用于轮询检查视频生成进度
|
|
1134
|
+
> - 任务完成后可获取生成的视频信息(包括 generation_id)
|
|
1135
|
+
> - 配合 create_video 接口使用,用于获取异步生成的视频结果
|
|
1136
|
+
>
|
|
1137
|
+
> ### 收费说明:
|
|
1138
|
+
> - 本接口完全免费,不消耗任何费用
|
|
1139
|
+
> - 速率限制:每秒最多请求 1 次(1 request/second)
|
|
1140
|
+
> - 如果请求过快可能会被限流,建议间隔至少 1 秒
|
|
1141
|
+
>
|
|
1142
|
+
> ### 参数:
|
|
1143
|
+
> - task_id: 任务 ID,必填,格式如 `task_01k7dttf0xfx3t7zhhzycjq8e3`
|
|
1144
|
+
> - 从 create_video 接口返回的任务 ID
|
|
1145
|
+
> - 必须以 'task_' 开头
|
|
1146
|
+
>
|
|
1147
|
+
> ### 返回:
|
|
1148
|
+
> - id: 任务 ID
|
|
1149
|
+
> - status: 任务状态
|
|
1150
|
+
> - queued: 排队中
|
|
1151
|
+
> - processing: 处理中
|
|
1152
|
+
> - succeeded: 已完成
|
|
1153
|
+
> - failed: 失败
|
|
1154
|
+
> - prompt: 视频生成时使用的文本描述
|
|
1155
|
+
> - title: 视频标题(如果有)
|
|
1156
|
+
> - progress_pct: 任务进度(0.0-1.0,1.0 表示 100%)
|
|
1157
|
+
> - generations: 生成结果数组(任务完成后才有)
|
|
1158
|
+
> - id: 生成 ID(generation_id,格式:gen_xxxxxx)
|
|
1159
|
+
> - kind: 类型(如 sora_draft)
|
|
1160
|
+
> - url: 视频链接(有水印)
|
|
1161
|
+
> - downloadable_url: 下载链接(有水印)
|
|
1162
|
+
> - width: 视频宽度
|
|
1163
|
+
> - height: 视频高度
|
|
1164
|
+
> - created_at: 创建时间戳
|
|
1165
|
+
> - prompt: 生成提示词
|
|
1166
|
+
> - encodings: 不同质量的编码版本
|
|
1167
|
+
> - source: 源文件
|
|
1168
|
+
> - source_wm: 带水印的源文件
|
|
1169
|
+
> - thumbnail: 缩略图
|
|
1170
|
+
> - md: 中等质量视频
|
|
1171
|
+
> - gif: 预览 GIF
|
|
1172
|
+
>
|
|
1173
|
+
> ### 注意:
|
|
1174
|
+
> - **速率限制**: 本接口每秒最多请求 1 次,建议轮询间隔设置为 1-2 秒
|
|
1175
|
+
> - 建议每 1-2 秒轮询一次,直到 status 变为 succeeded 或 failed
|
|
1176
|
+
> - 只有 status 为 succeeded 时,generations 数组才会包含视频数据
|
|
1177
|
+
> - **重要**: 本接口返回的视频链接**只包含有水印的版本**
|
|
1178
|
+
> - **获取无水印视频**: 当任务成功后,需要使用 task_id 或 generation_id 调用 `get_task_detail` 接口才能获取**无水印版本**
|
|
1179
|
+
> - 从 generations[0].id 可以获取 generation_id,用于后续调用 get_task_detail 接口
|
|
1180
|
+
>
|
|
1181
|
+
> # [English]
|
|
1182
|
+
> ## ⚠️ This endpoint has been deprecated. AI-related endpoints have been migrated to a dedicated TikHub AI API service, which operates separately from the TikHub Social Media API. Please visit: https://ai.tikhub.io
|
|
1183
|
+
> ### Purpose:
|
|
1184
|
+
> - Query current status and results of video generation task
|
|
1185
|
+
> - Used to poll and check video generation progress
|
|
1186
|
+
> - Get generated video information (including generation_id) after task completion
|
|
1187
|
+
> - Use with create_video endpoint to get asynchronously generated video results
|
|
1188
|
+
>
|
|
1189
|
+
> ### Pricing:
|
|
1190
|
+
> - This API is completely free, no charges
|
|
1191
|
+
> - Rate limit: Maximum 1 request per second (1 request/second)
|
|
1192
|
+
> - Requests may be throttled if too frequent, recommend at least 1 second interval
|
|
1193
|
+
>
|
|
1194
|
+
> ### Parameters:
|
|
1195
|
+
> - task_id: Task ID, required, format like `task_01k7dttf0xfx3t7zhhzycjq8e3`
|
|
1196
|
+
> - Task ID returned from create_video endpoint
|
|
1197
|
+
> - Must start with 'task_'
|
|
1198
|
+
>
|
|
1199
|
+
> ### Return:
|
|
1200
|
+
> - id: Task ID
|
|
1201
|
+
> - status: Task status
|
|
1202
|
+
> - queued: Queued
|
|
1203
|
+
> - processing: Processing
|
|
1204
|
+
> - succeeded: Completed
|
|
1205
|
+
> - failed: Failed
|
|
1206
|
+
> - prompt: Text description used for video generation
|
|
1207
|
+
> - title: Video title (if any)
|
|
1208
|
+
> - progress_pct: Task progress (0.0-1.0, 1.0 means 100%)
|
|
1209
|
+
> - generations: Generation result array (available after task completion)
|
|
1210
|
+
> - id: Generation ID (generation_id, format: gen_xxxxxx)
|
|
1211
|
+
> - kind: Type (e.g., sora_draft)
|
|
1212
|
+
> - url: Video link (with watermark)
|
|
1213
|
+
> - downloadable_url: Download link (with watermark)
|
|
1214
|
+
> - width: Video width
|
|
1215
|
+
> - height: Video height
|
|
1216
|
+
> - created_at: Creation timestamp
|
|
1217
|
+
> - prompt: Generation prompt
|
|
1218
|
+
> - encodings: Different quality encoding versions
|
|
1219
|
+
> - source: Source file
|
|
1220
|
+
> - source_wm: Source file with watermark
|
|
1221
|
+
> - thumbnail: Thumbnail
|
|
1222
|
+
> - md: Medium quality video
|
|
1223
|
+
> - gif: Preview GIF
|
|
1224
|
+
>
|
|
1225
|
+
> ### Note:
|
|
1226
|
+
> - **Rate limit**: Maximum 1 request per second, recommend polling interval of 1-2 seconds
|
|
1227
|
+
> - Recommend polling every 1-2 seconds until status becomes succeeded or failed
|
|
1228
|
+
> - Only when status is succeeded, generations array will contain video data
|
|
1229
|
+
> - **Important**: This endpoint returns video links **with watermark only**
|
|
1230
|
+
> - **Get watermark-free video**: After task succeeds, use task_id or generation_id to call `get_task_detail` endpoint to get **watermark-free version**
|
|
1231
|
+
> - Get generation_id from generations[0].id for subsequent get_task_detail API call
|
|
1232
|
+
>
|
|
1233
|
+
> # [示例/Example]
|
|
1234
|
+
> ```python
|
|
1235
|
+
> # 返回示例(任务进行中)
|
|
1236
|
+
> # Return example (task in progress)
|
|
1237
|
+
> {
|
|
1238
|
+
> "id": "task_01k7dttf0xfx3t7zhhzycjq8e3",
|
|
1239
|
+
> "status": "processing",
|
|
1240
|
+
> "prompt": "A cat playing Minecraft",
|
|
1241
|
+
> "progress_pct": 0.45
|
|
1242
|
+
> }
|
|
1243
|
+
>
|
|
1244
|
+
> # 返回示例(任务完成)
|
|
1245
|
+
> # Return example (task completed)
|
|
1246
|
+
> {
|
|
1247
|
+
> "id": "task_01k7dttf0xfx3t7zhhzycjq8e3",
|
|
1248
|
+
> "status": "succeeded",
|
|
1249
|
+
> "prompt": "A cat playing Minecraft",
|
|
1250
|
+
> "progress_pct": 1.0,
|
|
1251
|
+
> "generations": [
|
|
1252
|
+
> {
|
|
1253
|
+
> "id": "gen_01k7e1bff9eq6rxe9pntk7xdcf",
|
|
1254
|
+
> "kind": "sora_draft",
|
|
1255
|
+
> "url": "https://videos.openai.com/...",
|
|
1256
|
+
> "width": 640,
|
|
1257
|
+
> "height": 352,
|
|
1258
|
+
> "encodings": {
|
|
1259
|
+
> "thumbnail": {"path": "https://..."},
|
|
1260
|
+
> "gif": {"path": "https://..."}
|
|
1261
|
+
> }
|
|
1262
|
+
> }
|
|
1263
|
+
> ]
|
|
1264
|
+
> }
|
|
1265
|
+
> ```
|
|
1266
|
+
|
|
1267
|
+
#### Parameters
|
|
1268
|
+
|
|
1269
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1270
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1271
|
+
| task_id | query | string | Yes | 任务ID(从create_video返回)/Task ID (returned from create_video) | None | task_01k7dttf0xfx3t7zhhzycjq8e3 | None |
|
|
1272
|
+
|
|
1273
|
+
#### Request Body
|
|
1274
|
+
|
|
1275
|
+
None
|
|
1276
|
+
|
|
1277
|
+
#### Success Response
|
|
1278
|
+
|
|
1279
|
+
##### `200 application/json`
|
|
1280
|
+
|
|
1281
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1282
|
+
|
|
1283
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1284
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1285
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1286
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1287
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1288
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1289
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1290
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1291
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1292
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1293
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1294
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1295
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1296
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1297
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1298
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1299
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1300
|
+
|
|
1301
|
+
<a id="get-api-u1-v1-sora2-get-user-cameo-appearances"></a>
|
|
1302
|
+
### `GET /api/u1/v1/sora2/get_user_cameo_appearances`
|
|
1303
|
+
|
|
1304
|
+
- Summary: 获取用户Cameo出镜秀列表/Fetch user cameo appearances
|
|
1305
|
+
- Capabilities: profiles / accounts
|
|
1306
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1307
|
+
- operationId: `get_user_cameo_appearances_api_v1_sora2_get_user_cameo_appearances_get`
|
|
1308
|
+
|
|
1309
|
+
#### Notes
|
|
1310
|
+
|
|
1311
|
+
> # [中文]
|
|
1312
|
+
> ### 用途:
|
|
1313
|
+
> - 获取 Sora 用户的 Cameo 出镜秀列表
|
|
1314
|
+
> - Cameo 出镜秀指该用户在其他创作者作品中的出镜视频
|
|
1315
|
+
> - 支持分页加载,每页返回 30 条记录
|
|
1316
|
+
> - 可用于展示用户的协作作品、出镜记录等
|
|
1317
|
+
>
|
|
1318
|
+
> ### 收费说明:
|
|
1319
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
1320
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
1321
|
+
>
|
|
1322
|
+
> ### 参数:
|
|
1323
|
+
> - user_id: 用户 ID,必填
|
|
1324
|
+
> - cursor: 翻页参数(可选),首次请求留空,后续请求使用上一次响应中的 cursor 值
|
|
1325
|
+
>
|
|
1326
|
+
> ### 返回:
|
|
1327
|
+
> - items: Cameo 出镜秀列表(30条/页)
|
|
1328
|
+
> - post: 作品信息(该用户出镜的作品)
|
|
1329
|
+
> - id: 作品 ID
|
|
1330
|
+
> - text: 作品描述
|
|
1331
|
+
> - attachments: 视频附件信息
|
|
1332
|
+
> - like_count: 点赞数
|
|
1333
|
+
> - view_count: 浏览数
|
|
1334
|
+
> - shared_by: 原创作者 ID
|
|
1335
|
+
> - posted_at: 发布时间戳
|
|
1336
|
+
> - profile: 原创作者信息
|
|
1337
|
+
> - cursor: 下一页参数(用于获取更多记录,无更多时为 null)
|
|
1338
|
+
> - has_more: 是否有更多数据
|
|
1339
|
+
>
|
|
1340
|
+
> # [English]
|
|
1341
|
+
> ### Purpose:
|
|
1342
|
+
> - Fetch Sora user's Cameo appearance list
|
|
1343
|
+
> - Cameo appearances refer to videos where the user appears in other creators' works
|
|
1344
|
+
> - Supports pagination, returns 30 records per page
|
|
1345
|
+
> - Can be used to display user's collaborative works, appearance records, etc.
|
|
1346
|
+
>
|
|
1347
|
+
> ### Pricing:
|
|
1348
|
+
> - This API costs $0.05 per request
|
|
1349
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
1350
|
+
>
|
|
1351
|
+
> ### Parameters:
|
|
1352
|
+
> - user_id: User ID, required
|
|
1353
|
+
> - cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests
|
|
1354
|
+
>
|
|
1355
|
+
> ### Return:
|
|
1356
|
+
> - items: Cameo appearance list (30 items/page)
|
|
1357
|
+
> - post: Post information (works where the user appears)
|
|
1358
|
+
> - id: Post ID
|
|
1359
|
+
> - text: Post description
|
|
1360
|
+
> - attachments: Video attachment info
|
|
1361
|
+
> - like_count: Like count
|
|
1362
|
+
> - view_count: View count
|
|
1363
|
+
> - shared_by: Original creator ID
|
|
1364
|
+
> - posted_at: Post timestamp
|
|
1365
|
+
> - profile: Original creator information
|
|
1366
|
+
> - cursor: Next page cursor (for loading more records, null when no more)
|
|
1367
|
+
> - has_more: Whether there are more data
|
|
1368
|
+
>
|
|
1369
|
+
> # [示例/Example]
|
|
1370
|
+
> ```python
|
|
1371
|
+
> # 获取用户的 Cameo 出镜秀
|
|
1372
|
+
> user_id = "user-xiCyLclE6KJcdTXyvVq3Ontc"
|
|
1373
|
+
> cursor = "" # 首次请求留空
|
|
1374
|
+
>
|
|
1375
|
+
> # 返回该用户在其他人作品中的出镜记录
|
|
1376
|
+
> ```
|
|
1377
|
+
|
|
1378
|
+
#### Parameters
|
|
1379
|
+
|
|
1380
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1381
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1382
|
+
| user_id | query | string | Yes | 用户ID/User ID | None | user-xiCyLclE6KJcdTXyvVq3Ontc | None |
|
|
1383
|
+
| cursor | query | string | No | 翻页参数,从上一次响应中获取/Pagination cursor from previous response | None | None | None |
|
|
1384
|
+
|
|
1385
|
+
#### Request Body
|
|
1386
|
+
|
|
1387
|
+
None
|
|
1388
|
+
|
|
1389
|
+
#### Success Response
|
|
1390
|
+
|
|
1391
|
+
##### `200 application/json`
|
|
1392
|
+
|
|
1393
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1394
|
+
|
|
1395
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1396
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1397
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1398
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1399
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1400
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1401
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1402
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1403
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1404
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1405
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1406
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1407
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1408
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1409
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1410
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1411
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1412
|
+
|
|
1413
|
+
<a id="get-api-u1-v1-sora2-get-user-followers"></a>
|
|
1414
|
+
### `GET /api/u1/v1/sora2/get_user_followers`
|
|
1415
|
+
|
|
1416
|
+
- Summary: 获取用户粉丝列表/Fetch user followers
|
|
1417
|
+
- Capabilities: profiles / accounts
|
|
1418
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1419
|
+
- operationId: `get_user_followers_api_v1_sora2_get_user_followers_get`
|
|
1420
|
+
|
|
1421
|
+
#### Notes
|
|
1422
|
+
|
|
1423
|
+
> # [中文]
|
|
1424
|
+
> ### 用途:
|
|
1425
|
+
> - 获取 Sora 用户的粉丝列表
|
|
1426
|
+
> - 支持分页加载,每页返回 50 个粉丝
|
|
1427
|
+
> - 可用于粉丝关系分析、社交网络研究等场景
|
|
1428
|
+
>
|
|
1429
|
+
> ### 收费说明:
|
|
1430
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
1431
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
1432
|
+
>
|
|
1433
|
+
> ### 参数:
|
|
1434
|
+
> - user_id: 用户 ID,必填
|
|
1435
|
+
> - cursor: 翻页参数(可选),首次请求留空,后续请求使用上一次响应中的 cursor 值
|
|
1436
|
+
>
|
|
1437
|
+
> ### 返回:
|
|
1438
|
+
> - items: 粉丝列表(50个/页)
|
|
1439
|
+
> - user_id: 粉丝用户 ID
|
|
1440
|
+
> - username: 粉丝用户名
|
|
1441
|
+
> - display_name: 粉丝显示名称
|
|
1442
|
+
> - profile_picture_url: 粉丝头像链接
|
|
1443
|
+
> - follower_count: 粉丝的粉丝数
|
|
1444
|
+
> - following_count: 粉丝的关注数
|
|
1445
|
+
> - bio: 粉丝个人简介
|
|
1446
|
+
> - is_verified: 是否认证用户
|
|
1447
|
+
> - cursor: 下一页参数(用于获取更多粉丝,无更多时为 null)
|
|
1448
|
+
> - has_more: 是否有更多数据
|
|
1449
|
+
>
|
|
1450
|
+
> # [English]
|
|
1451
|
+
> ### Purpose:
|
|
1452
|
+
> - Fetch Sora user's follower list
|
|
1453
|
+
> - Supports pagination, returns 50 followers per page
|
|
1454
|
+
> - Can be used for follower relationship analysis, social network research, etc.
|
|
1455
|
+
>
|
|
1456
|
+
> ### Pricing:
|
|
1457
|
+
> - This API costs $0.05 per request
|
|
1458
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
1459
|
+
>
|
|
1460
|
+
> ### Parameters:
|
|
1461
|
+
> - user_id: User ID, required
|
|
1462
|
+
> - cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests
|
|
1463
|
+
>
|
|
1464
|
+
> ### Return:
|
|
1465
|
+
> - items: Follower list (50 items/page)
|
|
1466
|
+
> - user_id: Follower user ID
|
|
1467
|
+
> - username: Follower username
|
|
1468
|
+
> - display_name: Follower display name
|
|
1469
|
+
> - profile_picture_url: Follower avatar URL
|
|
1470
|
+
> - follower_count: Follower's follower count
|
|
1471
|
+
> - following_count: Follower's following count
|
|
1472
|
+
> - bio: Follower biography
|
|
1473
|
+
> - is_verified: Whether verified user
|
|
1474
|
+
> - cursor: Next page cursor (for loading more followers, null when no more)
|
|
1475
|
+
> - has_more: Whether there are more data
|
|
1476
|
+
>
|
|
1477
|
+
> # [示例/Example]
|
|
1478
|
+
> ```python
|
|
1479
|
+
> # 第一次请求(获取前 50 个粉丝)
|
|
1480
|
+
> user_id = "user-xiCyLclE6KJcdTXyvVq3Ontc"
|
|
1481
|
+
> cursor = "" # 首次请求留空
|
|
1482
|
+
>
|
|
1483
|
+
> # 第二次请求(获取下一页)
|
|
1484
|
+
> cursor = "eyJ1c2VyX2lkIjoidXNlci14aUN5TGNsRTZLSmNkVFh5dlZxM09udGMi..."
|
|
1485
|
+
> ```
|
|
1486
|
+
|
|
1487
|
+
#### Parameters
|
|
1488
|
+
|
|
1489
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1490
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1491
|
+
| user_id | query | string | Yes | 用户ID/User ID | None | user-xiCyLclE6KJcdTXyvVq3Ontc | None |
|
|
1492
|
+
| cursor | query | string | No | 翻页参数,从上一次响应中获取/Pagination cursor from previous response | None | None | None |
|
|
1493
|
+
|
|
1494
|
+
#### Request Body
|
|
1495
|
+
|
|
1496
|
+
None
|
|
1497
|
+
|
|
1498
|
+
#### Success Response
|
|
1499
|
+
|
|
1500
|
+
##### `200 application/json`
|
|
1501
|
+
|
|
1502
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1503
|
+
|
|
1504
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1505
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1506
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1507
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1508
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1509
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1510
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1511
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1512
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1513
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1514
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1515
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1516
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1517
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1518
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1519
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1520
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1521
|
+
|
|
1522
|
+
<a id="get-api-u1-v1-sora2-get-user-following"></a>
|
|
1523
|
+
### `GET /api/u1/v1/sora2/get_user_following`
|
|
1524
|
+
|
|
1525
|
+
- Summary: 获取用户关注列表/Fetch user following
|
|
1526
|
+
- Capabilities: profiles / accounts
|
|
1527
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1528
|
+
- operationId: `get_user_following_api_v1_sora2_get_user_following_get`
|
|
1529
|
+
|
|
1530
|
+
#### Notes
|
|
1531
|
+
|
|
1532
|
+
> # [中文]
|
|
1533
|
+
> ### 用途:
|
|
1534
|
+
> - 获取 Sora 用户的关注列表(用户关注的其他人)
|
|
1535
|
+
> - 支持分页加载,每页返回 50 个关注对象
|
|
1536
|
+
> - 可用于关注关系分析、推荐算法等场景
|
|
1537
|
+
>
|
|
1538
|
+
> ### 收费说明:
|
|
1539
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
1540
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
1541
|
+
>
|
|
1542
|
+
> ### 参数:
|
|
1543
|
+
> - user_id: 用户 ID,必填
|
|
1544
|
+
> - cursor: 翻页参数(可选),首次请求留空,后续请求使用上一次响应中的 cursor 值
|
|
1545
|
+
>
|
|
1546
|
+
> ### 返回:
|
|
1547
|
+
> - items: 关注列表(50个/页)
|
|
1548
|
+
> - user_id: 被关注用户 ID
|
|
1549
|
+
> - username: 被关注用户名
|
|
1550
|
+
> - display_name: 被关注用户显示名称
|
|
1551
|
+
> - profile_picture_url: 被关注用户头像链接
|
|
1552
|
+
> - follower_count: 被关注用户的粉丝数
|
|
1553
|
+
> - following_count: 被关注用户的关注数
|
|
1554
|
+
> - bio: 被关注用户个人简介
|
|
1555
|
+
> - is_verified: 是否认证用户
|
|
1556
|
+
> - cursor: 下一页参数(用于获取更多关注,无更多时为 null)
|
|
1557
|
+
> - has_more: 是否有更多数据
|
|
1558
|
+
>
|
|
1559
|
+
> # [English]
|
|
1560
|
+
> ### Purpose:
|
|
1561
|
+
> - Fetch Sora user's following list (users that the user follows)
|
|
1562
|
+
> - Supports pagination, returns 50 following per page
|
|
1563
|
+
> - Can be used for following relationship analysis, recommendation algorithms, etc.
|
|
1564
|
+
>
|
|
1565
|
+
> ### Pricing:
|
|
1566
|
+
> - This API costs $0.05 per request
|
|
1567
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
1568
|
+
>
|
|
1569
|
+
> ### Parameters:
|
|
1570
|
+
> - user_id: User ID, required
|
|
1571
|
+
> - cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests
|
|
1572
|
+
>
|
|
1573
|
+
> ### Return:
|
|
1574
|
+
> - items: Following list (50 items/page)
|
|
1575
|
+
> - user_id: Followed user ID
|
|
1576
|
+
> - username: Followed username
|
|
1577
|
+
> - display_name: Followed display name
|
|
1578
|
+
> - profile_picture_url: Followed avatar URL
|
|
1579
|
+
> - follower_count: Followed user's follower count
|
|
1580
|
+
> - following_count: Followed user's following count
|
|
1581
|
+
> - bio: Followed user biography
|
|
1582
|
+
> - is_verified: Whether verified user
|
|
1583
|
+
> - cursor: Next page cursor (for loading more following, null when no more)
|
|
1584
|
+
> - has_more: Whether there are more data
|
|
1585
|
+
>
|
|
1586
|
+
> # [示例/Example]
|
|
1587
|
+
> ```python
|
|
1588
|
+
> # 第一次请求(获取前 50 个关注)
|
|
1589
|
+
> user_id = "user-BOXD64QrAyZVybLCeXTqJWm3"
|
|
1590
|
+
> cursor = "" # 首次请求留空
|
|
1591
|
+
>
|
|
1592
|
+
> # 第二次请求(获取下一页)
|
|
1593
|
+
> cursor = "eyJ1c2VyX2lkIjoidXNlci1CT1hENjRRckF5WlZ5YkxDZVhUcUpXbTMi..."
|
|
1594
|
+
> ```
|
|
1595
|
+
|
|
1596
|
+
#### Parameters
|
|
1597
|
+
|
|
1598
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1599
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1600
|
+
| user_id | query | string | Yes | 用户ID/User ID | None | user-BOXD64QrAyZVybLCeXTqJWm3 | None |
|
|
1601
|
+
| cursor | query | string | No | 翻页参数,从上一次响应中获取/Pagination cursor from previous response | None | None | None |
|
|
1602
|
+
|
|
1603
|
+
#### Request Body
|
|
1604
|
+
|
|
1605
|
+
None
|
|
1606
|
+
|
|
1607
|
+
#### Success Response
|
|
1608
|
+
|
|
1609
|
+
##### `200 application/json`
|
|
1610
|
+
|
|
1611
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1612
|
+
|
|
1613
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1614
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1615
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1616
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1617
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1618
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1619
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1620
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1621
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1622
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1623
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1624
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1625
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1626
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1627
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1628
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1629
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1630
|
+
|
|
1631
|
+
<a id="get-api-u1-v1-sora2-get-user-posts"></a>
|
|
1632
|
+
### `GET /api/u1/v1/sora2/get_user_posts`
|
|
1633
|
+
|
|
1634
|
+
- Summary: 获取用户发布的帖子列表/Fetch user posts
|
|
1635
|
+
- Capabilities: profiles / accounts / content details
|
|
1636
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1637
|
+
- operationId: `get_user_posts_api_v1_sora2_get_user_posts_get`
|
|
1638
|
+
|
|
1639
|
+
#### Notes
|
|
1640
|
+
|
|
1641
|
+
> # [中文]
|
|
1642
|
+
> ### 用途:
|
|
1643
|
+
> - 获取 Sora 用户发布的作品列表
|
|
1644
|
+
> - 支持分页加载,每页返回 30 条作品
|
|
1645
|
+
> - 可用于用户主页展示、作品数据采集等场景
|
|
1646
|
+
>
|
|
1647
|
+
> ### 收费说明:
|
|
1648
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
1649
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
1650
|
+
>
|
|
1651
|
+
> ### 参数:
|
|
1652
|
+
> - user_id: 用户 ID,必填
|
|
1653
|
+
> - cursor: 翻页参数(可选),首次请求留空,后续请求使用上一次响应中的 cursor 值
|
|
1654
|
+
>
|
|
1655
|
+
> ### 返回:
|
|
1656
|
+
> - items: 作品列表(30条/页)
|
|
1657
|
+
> - post: 作品信息
|
|
1658
|
+
> - id: 作品 ID
|
|
1659
|
+
> - text: 作品描述
|
|
1660
|
+
> - attachments: 视频附件信息
|
|
1661
|
+
> - like_count: 点赞数
|
|
1662
|
+
> - view_count: 浏览数
|
|
1663
|
+
> - reply_count: 评论数
|
|
1664
|
+
> - posted_at: 发布时间戳
|
|
1665
|
+
> - profile: 作者信息
|
|
1666
|
+
> - cursor: 下一页参数(用于获取更多作品,无更多时为 null)
|
|
1667
|
+
> - has_more: 是否有更多数据
|
|
1668
|
+
>
|
|
1669
|
+
> # [English]
|
|
1670
|
+
> ### Purpose:
|
|
1671
|
+
> - Fetch list of posts published by a Sora user
|
|
1672
|
+
> - Supports pagination, returns 30 posts per page
|
|
1673
|
+
> - Can be used for user homepage display, post data collection, etc.
|
|
1674
|
+
>
|
|
1675
|
+
> ### Pricing:
|
|
1676
|
+
> - This API costs $0.05 per request
|
|
1677
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
1678
|
+
>
|
|
1679
|
+
> ### Parameters:
|
|
1680
|
+
> - user_id: User ID, required
|
|
1681
|
+
> - cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests
|
|
1682
|
+
>
|
|
1683
|
+
> ### Return:
|
|
1684
|
+
> - items: Post list (30 items/page)
|
|
1685
|
+
> - post: Post information
|
|
1686
|
+
> - id: Post ID
|
|
1687
|
+
> - text: Post description
|
|
1688
|
+
> - attachments: Video attachment info
|
|
1689
|
+
> - like_count: Like count
|
|
1690
|
+
> - view_count: View count
|
|
1691
|
+
> - reply_count: Comment count
|
|
1692
|
+
> - posted_at: Post timestamp
|
|
1693
|
+
> - profile: Author information
|
|
1694
|
+
> - cursor: Next page cursor (for loading more posts, null when no more)
|
|
1695
|
+
> - has_more: Whether there are more data
|
|
1696
|
+
>
|
|
1697
|
+
> # [示例/Example]
|
|
1698
|
+
> ```python
|
|
1699
|
+
> # 第一次请求(获取前 30 条作品)
|
|
1700
|
+
> user_id = "user-xiCyLclE6KJcdTXyvVq3Ontc"
|
|
1701
|
+
> cursor = "" # 首次请求留空
|
|
1702
|
+
>
|
|
1703
|
+
> # 第二次请求(获取下一页)
|
|
1704
|
+
> cursor = "eyJ1c2VyX2lkIjoidXNlci14aUN5TGNsRTZLSmNkVFh5dlZxM09udGMi..."
|
|
1705
|
+
> ```
|
|
1706
|
+
|
|
1707
|
+
#### Parameters
|
|
1708
|
+
|
|
1709
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1710
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1711
|
+
| user_id | query | string | Yes | 用户ID/User ID | None | user-xiCyLclE6KJcdTXyvVq3Ontc | None |
|
|
1712
|
+
| cursor | query | string | No | 翻页参数,从上一次响应中获取/Pagination cursor from previous response | None | None | None |
|
|
1713
|
+
|
|
1714
|
+
#### Request Body
|
|
1715
|
+
|
|
1716
|
+
None
|
|
1717
|
+
|
|
1718
|
+
#### Success Response
|
|
1719
|
+
|
|
1720
|
+
##### `200 application/json`
|
|
1721
|
+
|
|
1722
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1723
|
+
|
|
1724
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1725
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1726
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1727
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1728
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1729
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1730
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1731
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1732
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1733
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1734
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1735
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1736
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1737
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1738
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1739
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1740
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1741
|
+
|
|
1742
|
+
<a id="get-api-u1-v1-sora2-get-user-profile"></a>
|
|
1743
|
+
### `GET /api/u1/v1/sora2/get_user_profile`
|
|
1744
|
+
|
|
1745
|
+
- Summary: 获取用户信息档案/Fetch user profile
|
|
1746
|
+
- Capabilities: profiles / accounts
|
|
1747
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1748
|
+
- operationId: `get_user_profile_api_v1_sora2_get_user_profile_get`
|
|
1749
|
+
|
|
1750
|
+
#### Notes
|
|
1751
|
+
|
|
1752
|
+
> # [中文]
|
|
1753
|
+
> ### 用途:
|
|
1754
|
+
> - 获取 Sora 用户的个人信息档案
|
|
1755
|
+
> - 包含用户基本信息、统计数据、社交关系等
|
|
1756
|
+
> - 可用于用户资料展示、数据分析等场景
|
|
1757
|
+
>
|
|
1758
|
+
> ### 收费说明:
|
|
1759
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
1760
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
1761
|
+
>
|
|
1762
|
+
> ### 参数:
|
|
1763
|
+
> - user_id: 用户 ID,必填,格式如 `user-xiCyLclE6KJcdTXyvVq3Ontc`
|
|
1764
|
+
>
|
|
1765
|
+
> ### 返回:
|
|
1766
|
+
> - profile: 用户信息
|
|
1767
|
+
> - user_id: 用户 ID
|
|
1768
|
+
> - username: 用户名
|
|
1769
|
+
> - display_name: 显示名称
|
|
1770
|
+
> - bio: 个人简介
|
|
1771
|
+
> - profile_picture_url: 头像链接
|
|
1772
|
+
> - banner_image_url: 横幅图片链接
|
|
1773
|
+
> - follower_count: 粉丝数
|
|
1774
|
+
> - following_count: 关注数
|
|
1775
|
+
> - post_count: 作品数
|
|
1776
|
+
> - like_count: 获赞总数
|
|
1777
|
+
> - view_count: 浏览总数
|
|
1778
|
+
> - is_verified: 是否认证用户
|
|
1779
|
+
> - created_at: 账号创建时间戳
|
|
1780
|
+
> - social_links: 社交媒体链接(如有)
|
|
1781
|
+
>
|
|
1782
|
+
> # [English]
|
|
1783
|
+
> ### Purpose:
|
|
1784
|
+
> - Fetch Sora user's profile information
|
|
1785
|
+
> - Includes user basic info, statistics, social relationships, etc.
|
|
1786
|
+
> - Can be used for user profile display, data analysis, etc.
|
|
1787
|
+
>
|
|
1788
|
+
> ### Pricing:
|
|
1789
|
+
> - This API costs $0.05 per request
|
|
1790
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
1791
|
+
>
|
|
1792
|
+
> ### Parameters:
|
|
1793
|
+
> - user_id: User ID, required, format like `user-xiCyLclE6KJcdTXyvVq3Ontc`
|
|
1794
|
+
>
|
|
1795
|
+
> ### Return:
|
|
1796
|
+
> - profile: User information
|
|
1797
|
+
> - user_id: User ID
|
|
1798
|
+
> - username: Username
|
|
1799
|
+
> - display_name: Display name
|
|
1800
|
+
> - bio: Biography
|
|
1801
|
+
> - profile_picture_url: Avatar URL
|
|
1802
|
+
> - banner_image_url: Banner image URL
|
|
1803
|
+
> - follower_count: Follower count
|
|
1804
|
+
> - following_count: Following count
|
|
1805
|
+
> - post_count: Post count
|
|
1806
|
+
> - like_count: Total likes received
|
|
1807
|
+
> - view_count: Total views
|
|
1808
|
+
> - is_verified: Whether verified user
|
|
1809
|
+
> - created_at: Account creation timestamp
|
|
1810
|
+
> - social_links: Social media links (if any)
|
|
1811
|
+
>
|
|
1812
|
+
> # [示例/Example]
|
|
1813
|
+
> ```python
|
|
1814
|
+
> # 获取用户信息
|
|
1815
|
+
> user_id = "user-xiCyLclE6KJcdTXyvVq3Ontc"
|
|
1816
|
+
>
|
|
1817
|
+
> # 返回示例
|
|
1818
|
+
> {
|
|
1819
|
+
> "profile": {
|
|
1820
|
+
> "username": "creator123",
|
|
1821
|
+
> "display_name": "Amazing Creator",
|
|
1822
|
+
> "follower_count": 12500,
|
|
1823
|
+
> "post_count": 45
|
|
1824
|
+
> }
|
|
1825
|
+
> }
|
|
1826
|
+
> ```
|
|
1827
|
+
|
|
1828
|
+
#### Parameters
|
|
1829
|
+
|
|
1830
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1831
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1832
|
+
| user_id | query | string | Yes | 用户ID/User ID | None | user-xiCyLclE6KJcdTXyvVq3Ontc | None |
|
|
1833
|
+
|
|
1834
|
+
#### Request Body
|
|
1835
|
+
|
|
1836
|
+
None
|
|
1837
|
+
|
|
1838
|
+
#### Success Response
|
|
1839
|
+
|
|
1840
|
+
##### `200 application/json`
|
|
1841
|
+
|
|
1842
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1843
|
+
|
|
1844
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1845
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1846
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1847
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1848
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1849
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1850
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1851
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1852
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1853
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1854
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1855
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1856
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1857
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1858
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1859
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1860
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1861
|
+
|
|
1862
|
+
<a id="get-api-u1-v1-sora2-get-video-download-info"></a>
|
|
1863
|
+
### `GET /api/u1/v1/sora2/get_video_download_info`
|
|
1864
|
+
|
|
1865
|
+
- Summary: 获取无水印视频下载信息/Fetch none watermark video download info
|
|
1866
|
+
- Capabilities: content details / media / download
|
|
1867
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1868
|
+
- operationId: `get_video_download_info_api_v1_sora2_get_video_download_info_get`
|
|
1869
|
+
|
|
1870
|
+
#### Notes
|
|
1871
|
+
|
|
1872
|
+
> # [中文]
|
|
1873
|
+
> ### 用途:
|
|
1874
|
+
> - 获取 Sora 作品的简化下载信息,专为视频下载场景优化
|
|
1875
|
+
> - 直接返回无水印视频链接和关键信息,无需解析复杂的完整数据
|
|
1876
|
+
> - 适合需要快速下载视频的场景
|
|
1877
|
+
>
|
|
1878
|
+
> ### 收费说明:
|
|
1879
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
1880
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
1881
|
+
>
|
|
1882
|
+
> ### 参数:
|
|
1883
|
+
> - post_id: 作品 ID(可选),格式如 `s_68e853d2ad448191b3c81e830f53c3a2`
|
|
1884
|
+
> - post_url: 作品链接(可选),格式如 `https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2`
|
|
1885
|
+
> - **注意**: post_id 和 post_url 至少提供一个
|
|
1886
|
+
>
|
|
1887
|
+
> ### 返回:
|
|
1888
|
+
> - post_id: 作品 ID
|
|
1889
|
+
> - title: 作品描述文本
|
|
1890
|
+
> - video: 视频信息
|
|
1891
|
+
> - no_watermark: 无水印视频链接(原始质量)
|
|
1892
|
+
> - watermark: 有水印视频链接
|
|
1893
|
+
> - width: 视频宽度
|
|
1894
|
+
> - height: 视频高度
|
|
1895
|
+
> - thumbnail: 缩略图链接
|
|
1896
|
+
> - preview_gif: 预览 GIF 链接
|
|
1897
|
+
> - medium_quality: 中等质量视频链接
|
|
1898
|
+
> - author: 作者信息
|
|
1899
|
+
> - user_id: 用户 ID
|
|
1900
|
+
> - username: 用户名
|
|
1901
|
+
> - display_name: 显示名称
|
|
1902
|
+
> - avatar: 头像链接
|
|
1903
|
+
> - stats: 统计数据
|
|
1904
|
+
> - like_count: 点赞数
|
|
1905
|
+
> - view_count: 浏览数
|
|
1906
|
+
> - comment_count: 评论数
|
|
1907
|
+
> - remix_count: 混剪数
|
|
1908
|
+
> - permalink: 作品永久链接
|
|
1909
|
+
> - created_at: 创建时间戳
|
|
1910
|
+
>
|
|
1911
|
+
> # [English]
|
|
1912
|
+
> ### Purpose:
|
|
1913
|
+
> - Get simplified download information for Sora posts, optimized for video download scenarios
|
|
1914
|
+
> - Directly returns watermark-free video links and key information without parsing complex full data
|
|
1915
|
+
> - Suitable for quick video download scenarios
|
|
1916
|
+
>
|
|
1917
|
+
> ### Pricing:
|
|
1918
|
+
> - This API costs $0.05 per request
|
|
1919
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
1920
|
+
>
|
|
1921
|
+
> ### Parameters:
|
|
1922
|
+
> - post_id: Post ID (optional), format like `s_68e853d2ad448191b3c81e830f53c3a2`
|
|
1923
|
+
> - post_url: Post URL (optional), format like `https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2`
|
|
1924
|
+
> - **Note**: At least one of post_id or post_url must be provided
|
|
1925
|
+
>
|
|
1926
|
+
> ### Return:
|
|
1927
|
+
> - post_id: Post ID
|
|
1928
|
+
> - title: Post description text
|
|
1929
|
+
> - video: Video information
|
|
1930
|
+
> - no_watermark: No watermark video link (original quality)
|
|
1931
|
+
> - watermark: Watermarked video link
|
|
1932
|
+
> - width: Video width
|
|
1933
|
+
> - height: Video height
|
|
1934
|
+
> - thumbnail: Thumbnail link
|
|
1935
|
+
> - preview_gif: Preview GIF link
|
|
1936
|
+
> - medium_quality: Medium quality video link
|
|
1937
|
+
> - author: Author information
|
|
1938
|
+
> - user_id: User ID
|
|
1939
|
+
> - username: Username
|
|
1940
|
+
> - display_name: Display name
|
|
1941
|
+
> - avatar: Avatar URL
|
|
1942
|
+
> - stats: Statistics
|
|
1943
|
+
> - like_count: Like count
|
|
1944
|
+
> - view_count: View count
|
|
1945
|
+
> - comment_count: Comment count
|
|
1946
|
+
> - remix_count: Remix count
|
|
1947
|
+
> - permalink: Permanent link
|
|
1948
|
+
> - created_at: Creation timestamp
|
|
1949
|
+
>
|
|
1950
|
+
> # [示例/Example]
|
|
1951
|
+
> ```python
|
|
1952
|
+
> # 使用作品 ID 查询
|
|
1953
|
+
> post_id = "s_68e853d2ad448191b3c81e830f53c3a2"
|
|
1954
|
+
>
|
|
1955
|
+
> # 返回示例
|
|
1956
|
+
> {
|
|
1957
|
+
> "video": {
|
|
1958
|
+
> "no_watermark": "https://cdn.openai.com/...", # 直接下载此链接
|
|
1959
|
+
> "thumbnail": "https://cdn.openai.com/...",
|
|
1960
|
+
> "width": 1920,
|
|
1961
|
+
> "height": 1080
|
|
1962
|
+
> },
|
|
1963
|
+
> "title": "Amazing Sora video",
|
|
1964
|
+
> "author": {"username": "creator123"}
|
|
1965
|
+
> }
|
|
1966
|
+
> ```
|
|
1967
|
+
|
|
1968
|
+
#### Parameters
|
|
1969
|
+
|
|
1970
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
1971
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
1972
|
+
| post_id | query | string | No | 作品ID(可选)/Post ID (optional) | None | s_68e853d2ad448191b3c81e830f53c3a2 | None |
|
|
1973
|
+
| post_url | query | string | No | 作品链接(可选)/Post URL (optional) | None | https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2 | None |
|
|
1974
|
+
|
|
1975
|
+
#### Request Body
|
|
1976
|
+
|
|
1977
|
+
None
|
|
1978
|
+
|
|
1979
|
+
#### Success Response
|
|
1980
|
+
|
|
1981
|
+
##### `200 application/json`
|
|
1982
|
+
|
|
1983
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1984
|
+
|
|
1985
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1986
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1987
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1988
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1989
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1990
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1991
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1992
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1993
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1994
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1995
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1996
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1997
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1998
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1999
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
2000
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
2001
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
2002
|
+
|
|
2003
|
+
<a id="get-api-u1-v1-sora2-search-users"></a>
|
|
2004
|
+
### `GET /api/u1/v1/sora2/search_users`
|
|
2005
|
+
|
|
2006
|
+
- Summary: 搜索用户/Search users
|
|
2007
|
+
- Capabilities: search / profiles / accounts
|
|
2008
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
2009
|
+
- operationId: `search_users_api_v1_sora2_search_users_get`
|
|
2010
|
+
|
|
2011
|
+
#### Notes
|
|
2012
|
+
|
|
2013
|
+
> # [中文]
|
|
2014
|
+
> ### 用途:
|
|
2015
|
+
> - 搜索 Sora 用户(主要用于 @ 提及功能)
|
|
2016
|
+
> - 根据用户名关键词搜索匹配的用户
|
|
2017
|
+
> - 返回用户信息和提及 Token(用于在评论中 @ 用户)
|
|
2018
|
+
> - 注意:实际返回结果可能超过 20 个,比预期的更多
|
|
2019
|
+
>
|
|
2020
|
+
> ### 收费说明:
|
|
2021
|
+
> - 本接口请求价格为 1 次调用消耗 0.05 美元
|
|
2022
|
+
> - 本接口支持使用免费额度,每天可通过在用户后台签到获取免费调用次数。
|
|
2023
|
+
>
|
|
2024
|
+
> ### 参数:
|
|
2025
|
+
> - username: 搜索关键词,必填,支持部分匹配
|
|
2026
|
+
>
|
|
2027
|
+
> ### 返回:
|
|
2028
|
+
> - items: 用户搜索结果列表
|
|
2029
|
+
> - profile: 用户信息
|
|
2030
|
+
> - user_id: 用户 ID
|
|
2031
|
+
> - username: 用户名
|
|
2032
|
+
> - display_name: 显示名称
|
|
2033
|
+
> - profile_picture_url: 头像链接
|
|
2034
|
+
> - follower_count: 粉丝数
|
|
2035
|
+
> - following_count: 关注数
|
|
2036
|
+
> - bio: 个人简介
|
|
2037
|
+
> - is_verified: 是否认证用户
|
|
2038
|
+
> - token: 提及 Token(用于 @ 提及功能)
|
|
2039
|
+
> - 格式:`<@user-xxxxxxxx>`
|
|
2040
|
+
> - 在评论中使用此 Token 可以提及该用户
|
|
2041
|
+
>
|
|
2042
|
+
> # [English]
|
|
2043
|
+
> ### Purpose:
|
|
2044
|
+
> - Search Sora users (mainly for @ mention functionality)
|
|
2045
|
+
> - Search for matching users based on username keywords
|
|
2046
|
+
> - Returns user information and mention tokens (for @mentioning users in comments)
|
|
2047
|
+
> - Note: Actual results may exceed 20 users, more than expected
|
|
2048
|
+
>
|
|
2049
|
+
> ### Pricing:
|
|
2050
|
+
> - This API costs $0.05 per request
|
|
2051
|
+
> - This API supports free quota, you can get free requests by checking in daily at the user dashboard.
|
|
2052
|
+
>
|
|
2053
|
+
> ### Parameters:
|
|
2054
|
+
> - username: Search keyword, required, supports partial matching
|
|
2055
|
+
>
|
|
2056
|
+
> ### Return:
|
|
2057
|
+
> - items: User search result list
|
|
2058
|
+
> - profile: User information
|
|
2059
|
+
> - user_id: User ID
|
|
2060
|
+
> - username: Username
|
|
2061
|
+
> - display_name: Display name
|
|
2062
|
+
> - profile_picture_url: Avatar URL
|
|
2063
|
+
> - follower_count: Follower count
|
|
2064
|
+
> - following_count: Following count
|
|
2065
|
+
> - bio: Biography
|
|
2066
|
+
> - is_verified: Whether verified user
|
|
2067
|
+
> - token: Mention token (for @ mention functionality)
|
|
2068
|
+
> - Format: `<@user-xxxxxxxx>`
|
|
2069
|
+
> - Use this token in comments to mention the user
|
|
2070
|
+
>
|
|
2071
|
+
> # [示例/Example]
|
|
2072
|
+
> ```python
|
|
2073
|
+
> # 搜索用户名包含 "sam" 的用户
|
|
2074
|
+
> username = "sam"
|
|
2075
|
+
>
|
|
2076
|
+
> # 返回示例
|
|
2077
|
+
> {
|
|
2078
|
+
> "items": [
|
|
2079
|
+
> {
|
|
2080
|
+
> "profile": {
|
|
2081
|
+
> "username": "samuel",
|
|
2082
|
+
> "display_name": "Samuel Creator",
|
|
2083
|
+
> "follower_count": 20000
|
|
2084
|
+
> },
|
|
2085
|
+
> "token": "<@user-abc123xyz>"
|
|
2086
|
+
> },
|
|
2087
|
+
> {
|
|
2088
|
+
> "profile": {
|
|
2089
|
+
> "username": "samantha",
|
|
2090
|
+
> "display_name": "Samantha Artist"
|
|
2091
|
+
> },
|
|
2092
|
+
> "token": "<@user-def456uvw>"
|
|
2093
|
+
> }
|
|
2094
|
+
> ]
|
|
2095
|
+
> }
|
|
2096
|
+
>
|
|
2097
|
+
> # 在评论中使用 token 提及用户
|
|
2098
|
+
> # comment_text = "Great work <@user-abc123xyz>!"
|
|
2099
|
+
> ```
|
|
2100
|
+
|
|
2101
|
+
#### Parameters
|
|
2102
|
+
|
|
2103
|
+
| Field | In | Type | Required | Description | Default | Example | Enum |
|
|
2104
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
2105
|
+
| username | query | string | Yes | 搜索关键词(用户名)/Search keyword (username) | None | sam | None |
|
|
2106
|
+
|
|
2107
|
+
#### Request Body
|
|
2108
|
+
|
|
2109
|
+
None
|
|
2110
|
+
|
|
2111
|
+
#### Success Response
|
|
2112
|
+
|
|
2113
|
+
##### `200 application/json`
|
|
2114
|
+
|
|
2115
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
2116
|
+
|
|
2117
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
2118
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
2119
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
2120
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
2121
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
2122
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
2123
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
2124
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
2125
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
2126
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
2127
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
2128
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
2129
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
2130
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
2131
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
2132
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
2133
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
2134
|
+
|
|
2135
|
+
<a id="post-api-u1-v1-sora2-upload-image"></a>
|
|
2136
|
+
### `POST /api/u1/v1/sora2/upload_image`
|
|
2137
|
+
|
|
2138
|
+
- Summary: 上传图片获取media_id/Upload image to get media_id
|
|
2139
|
+
- Capabilities: media upload / public URL
|
|
2140
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
2141
|
+
- operationId: `upload_image_api_v1_sora2_upload_image_post`
|
|
2142
|
+
|
|
2143
|
+
#### Notes
|
|
2144
|
+
|
|
2145
|
+
> # [中文]
|
|
2146
|
+
> ### 用途:
|
|
2147
|
+
> - 上传图片到 Sora 服务器获取 media_id
|
|
2148
|
+
> - 获取的 media_id 可用于后续的 AI 视频生成功能
|
|
2149
|
+
> - 支持 PNG、JPG、JPEG 格式的图片文件
|
|
2150
|
+
>
|
|
2151
|
+
> ### 收费说明:
|
|
2152
|
+
> - 本接口请求价格为 1 次调用消耗 0.001 美元 (防止恶意请求)
|
|
2153
|
+
> - 速率限制:每秒最多请求 1 次(1 request/second)
|
|
2154
|
+
> - 如果请求过快可能会被限流,建议间隔至少 1 秒
|
|
2155
|
+
>
|
|
2156
|
+
> ### 参数说明:
|
|
2157
|
+
> - **file** (必填): 图片文件
|
|
2158
|
+
> - 支持格式: PNG, JPG, JPEG
|
|
2159
|
+
> - 文件大小: 最大 10MB
|
|
2160
|
+
>
|
|
2161
|
+
> ### 返回数据:
|
|
2162
|
+
> - **id**: Media ID(用于视频生成)
|
|
2163
|
+
> - **url**: 图片访问链接
|
|
2164
|
+
> - **kind**: 资源类型(通常为 "image")
|
|
2165
|
+
> - **width**: 图片宽度(像素)
|
|
2166
|
+
> - **height**: 图片高度(像素)
|
|
2167
|
+
> - **file_name**: 文件名
|
|
2168
|
+
>
|
|
2169
|
+
> ### 注意事项:
|
|
2170
|
+
> - 上传的图片会存储在服务器上
|
|
2171
|
+
> - 返回的 media_id 有效期通常为 24 小时
|
|
2172
|
+
> - 建议在获取 media_id 后及时使用
|
|
2173
|
+
> - 文件名会自动清理特殊字符以确保安全
|
|
2174
|
+
>
|
|
2175
|
+
> ---
|
|
2176
|
+
>
|
|
2177
|
+
> # [English]
|
|
2178
|
+
> ### Purpose:
|
|
2179
|
+
> - Upload image to Sora server to get media_id
|
|
2180
|
+
> - The obtained media_id can be used for subsequent AI video generation
|
|
2181
|
+
> - Supports PNG, JPG, JPEG format image files
|
|
2182
|
+
>
|
|
2183
|
+
> ### Pricing:
|
|
2184
|
+
> - This API costs $0.001 per request (to prevent abuse requests)
|
|
2185
|
+
> - Rate limit: Maximum 1 request per second
|
|
2186
|
+
> - If requests are too frequent, you may be rate limited; it is recommended to wait at least 1 second between requests
|
|
2187
|
+
>
|
|
2188
|
+
> ### Parameters:
|
|
2189
|
+
> - **file** (required): Image file
|
|
2190
|
+
> - Supported formats: PNG, JPG, JPEG
|
|
2191
|
+
> - File size: Maximum 10MB
|
|
2192
|
+
>
|
|
2193
|
+
> ### Response Data:
|
|
2194
|
+
> - **id**: Media ID (for video generation)
|
|
2195
|
+
> - **url**: Image access link
|
|
2196
|
+
> - **kind**: Resource type (usually "image")
|
|
2197
|
+
> - **width**: Image width (pixels)
|
|
2198
|
+
> - **height**: Image height (pixels)
|
|
2199
|
+
> - **file_name**: File name
|
|
2200
|
+
>
|
|
2201
|
+
> ### Notes:
|
|
2202
|
+
> - Uploaded images are stored on the server
|
|
2203
|
+
> - The returned media_id is usually valid for 24 hours
|
|
2204
|
+
> - Recommend using media_id promptly after obtaining
|
|
2205
|
+
> - File names are automatically sanitized for security
|
|
2206
|
+
>
|
|
2207
|
+
> ---
|
|
2208
|
+
>
|
|
2209
|
+
> # [示例/Example]
|
|
2210
|
+
> ```python
|
|
2211
|
+
> {
|
|
2212
|
+
> "id":"media_01k7edmn2ge988d9x6g5zg1hhw",
|
|
2213
|
+
> "type":"image",
|
|
2214
|
+
> "created_at":"2025-10-13T09:15:20.063403Z",
|
|
2215
|
+
> "filename":"20760448.jpeg",
|
|
2216
|
+
> "extension":"jpeg",
|
|
2217
|
+
> "mime_type":"image/jpeg",
|
|
2218
|
+
> "url":"https://videos.openai.com/vg-assets/assets%2Fclient_upload%2Fmedia%2F084bcb820761572154494edb38c9ff2b4a3254fd%2Fmedia_01k7edmn2ge988d9x6g5zg1hhw.jpeg?se=2025-10-13T10%3A15%3A20Z&sp=r&sv=2024-08-04&sr=b&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skt=2025-10-13T08%3A24%3A12Z&ske=2025-10-13T12%3A29%3A12Z&sks=b&skv=2024-08-04&sig=3xnRz6u%2BJcO3Db7EAvDXkw08xDttCc5xSvvL2k2nEN8%3D&az=oaivgprodscus",
|
|
2219
|
+
> "width":460,
|
|
2220
|
+
> "height":460,
|
|
2221
|
+
> "duration_sec":null,
|
|
2222
|
+
> "n_frames":1,
|
|
2223
|
+
> "size_bytes":51902,
|
|
2224
|
+
> "thumbnail_url":"https://videos.openai.com/vg-assets/assets%2Fclient_upload%2Fmedia%2F084bcb820761572154494edb38c9ff2b4a3254fd%2Fmedia_01k7edmn2ge988d9x6g5zg1hhw.jpg?se=2025-10-13T10%3A15%3A20Z&sp=r&sv=2024-08-04&sr=b&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skt=2025-10-13T08%3A24%3A12Z&ske=2025-10-13T12%3A29%3A12Z&sks=b&skv=2024-08-04&sig=chcnDmB%2BKipH%2BOAPHQGmZv8zCldny/U0HDtsvjuZoqA%3D&az=oaivgprodscus"
|
|
2225
|
+
> }
|
|
2226
|
+
> ```
|
|
2227
|
+
|
|
2228
|
+
#### Parameters
|
|
2229
|
+
|
|
2230
|
+
None
|
|
2231
|
+
|
|
2232
|
+
#### Request Body
|
|
2233
|
+
|
|
2234
|
+
- required: Yes
|
|
2235
|
+
|
|
2236
|
+
##### `multipart/form-data`
|
|
2237
|
+
|
|
2238
|
+
- Schema summary: `file*`:string
|
|
2239
|
+
|
|
2240
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
2241
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
2242
|
+
| file | string(binary) | Yes | PNG/JPG/JPEG | None | None | None |
|
|
2243
|
+
|
|
2244
|
+
#### Success Response
|
|
2245
|
+
|
|
2246
|
+
##### `200 application/json`
|
|
2247
|
+
|
|
2248
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
2249
|
+
|
|
2250
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
2251
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
2252
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
2253
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
2254
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
2255
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
2256
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
2257
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
2258
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
2259
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
2260
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
2261
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
2262
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
2263
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
2264
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
2265
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
2266
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|