{"openapi":"3.1.0","info":{"title":"Yuanbao Private ChatGPT Action","version":"1.0.0","description":"Private Action endpoints for reading protagonist profiles and creator most-liked posts. ChatGPT generates the copy itself."},"servers":[{"url":"https://yuanbaotools.com"}],"components":{"schemas":{"CreatorProfileRequest":{"type":"object","required":["profile_url"],"properties":{"profile_url":{"type":"string","description":"Douyin or Xiaohongshu creator profile URL."},"max_posts":{"type":"integer","minimum":1,"maximum":10,"default":10}}},"TopicBriefRequest":{"type":"object","required":["profile_url"],"properties":{"profile_url":{"type":"string","description":"Douyin or Xiaohongshu creator profile URL."},"profile_info":{"type":"string","description":"User's own protagonist/account/product positioning."},"protagonist_name":{"type":"string","description":"Optional protagonist name from the protagonist library."},"requirements":{"type":"string","description":"Extra topic/script requirements."},"max_posts":{"type":"integer","minimum":1,"maximum":10,"default":10}}},"SingleVideoRequest":{"type":"object","required":["video_url"],"properties":{"video_url":{"type":"string","description":"A public Douyin, Xiaohongshu, or other video URL to parse."}}},"CopyBriefRequest":{"type":"object","properties":{"video_url":{"type":"string","description":"Optional source video URL to parse before building the brief."},"source_script":{"type":"string","description":"Known source copy/transcript/visual breakdown. Used when no URL is provided or parsing is not needed."},"profile_info":{"type":"string","description":"User's protagonist/account/product positioning."},"protagonist_name":{"type":"string","description":"Optional protagonist name from the protagonist library."},"requirements":{"type":"string","description":"Extra copy/script requirements."},"version_count":{"type":"integer","minimum":1,"maximum":3,"default":3},"workflow_mode":{"type":"string","enum":["traditional","ai"],"default":"traditional"}}},"ScriptBriefRequest":{"type":"object","required":["final_script"],"properties":{"final_script":{"type":"string","description":"Final voiceover copy to turn into a shooting script."},"profile_info":{"type":"string"},"protagonist_name":{"type":"string"},"requirements":{"type":"string"}}},"AiScriptBriefRequest":{"type":"object","properties":{"generated_text":{"type":"string","description":"Full generated result or draft copy."},"final_script":{"type":"string","description":"Optional final voiceover copy."},"profile_info":{"type":"string"},"protagonist_name":{"type":"string"},"requirements":{"type":"string"}}},"ImageBriefRequest":{"type":"object","properties":{"generated_text":{"type":"string","description":"Generated copy/script containing image prompt sections or source copy."},"final_script":{"type":"string","description":"Optional final script used to create image prompts."},"version":{"type":"string","default":"A"},"image_count":{"type":"integer","minimum":0,"maximum":8,"default":0},"profile_info":{"type":"string"},"protagonist_name":{"type":"string"},"image_requirements":{"type":"string"},"image_style_preset":{"type":"string","default":"real_life"},"image_style_notes":{"type":"string"}}},"VisualBriefRequest":{"type":"object","required":["video_url"],"properties":{"video_url":{"type":"string"},"run_server_analysis":{"type":"boolean","default":false,"description":"Only set true when the user explicitly asks to run paid server-side frame analysis."}}},"VideoProductionBriefRequest":{"type":"object","properties":{"final_script":{"type":"string"},"generated_text":{"type":"string"},"notes":{"type":"string"},"production_mode":{"type":"string","default":"ai_images_or_uploaded_assets"},"profile_info":{"type":"string"},"protagonist_name":{"type":"string"}}},"VideoPost":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string"},"like_count":{"type":"number"},"comment_count":{"type":"number"},"share_count":{"type":"number"},"collect_count":{"type":"number"},"source_provider":{"type":"string"}},"additionalProperties":true},"ProtagonistProfile":{"type":"object","properties":{"name":{"type":"string"},"content":{"type":"string"}},"additionalProperties":true},"ProtagonistListResponse":{"type":"object","properties":{"protagonists":{"type":"array","items":{"$ref":"#/components/schemas/ProtagonistProfile"}},"usage_note":{"type":"string"}}},"CreatorProfileResponse":{"type":"object","properties":{"profile_url":{"type":"string"},"video_count":{"type":"integer"},"scan_count":{"type":"integer"},"videos":{"type":"array","items":{"$ref":"#/components/schemas/VideoPost"}},"generation_location":{"type":"string"},"cost_hint":{"type":"string"}}},"ActionBriefResponse":{"type":"object","properties":{"selected_protagonist":{"$ref":"#/components/schemas/ProtagonistProfile"},"available_protagonists":{"type":"array","items":{"type":"string"}},"source":{"type":"object","additionalProperties":true},"draft_prompts":{"type":"array","items":{"type":"string"}},"chatgpt_instruction":{"type":"string"},"generation_location":{"type":"string"},"cost_hint":{"type":"string"},"web_url":{"type":"string"}},"additionalProperties":true},"CapabilitiesResponse":{"type":"object","properties":{"ok":{"type":"boolean"},"generation_policy":{"type":"string"},"features":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"operation":{"type":"string"},"cost":{"type":"string"}}}}}},"CommerceLinksResponse":{"type":"object","properties":{"ok":{"type":"boolean"},"links":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"description":{"type":"string"}}}}}},"SingleVideoResponse":{"type":"object","properties":{"video_url":{"type":"string"},"extract":{"type":"object","properties":{},"additionalProperties":true},"source_script":{"type":"string"},"warning":{"type":"string"},"generation_location":{"type":"string"},"cost_hint":{"type":"string"}}},"VisualBriefResponse":{"type":"object","properties":{"video_url":{"type":"string"},"source_script":{"type":"string"},"analysis":{"type":"string"},"chatgpt_instruction":{"type":"string"},"generation_location":{"type":"string"},"cost_hint":{"type":"string"},"billing":{"type":"object","properties":{},"additionalProperties":true}},"additionalProperties":true},"TopicBriefResponse":{"type":"object","properties":{"profile_url":{"type":"string"},"selected_protagonist":{"$ref":"#/components/schemas/ProtagonistProfile"},"profile_info":{"type":"string"},"requirements":{"type":"string"},"scan_count":{"type":"integer"},"videos":{"type":"array","items":{"$ref":"#/components/schemas/VideoPost"}},"chatgpt_instruction":{"type":"string"},"generation_location":{"type":"string"},"cost_hint":{"type":"string"}}}}},"paths":{"/api/action/p/9e52a5b5993df24104e4725e/health":{"get":{"operationId":"checkYuanbaoActionHealth","summary":"Check whether the private Yuanbao Action is available.","responses":{"200":{"description":"Action service status.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"mode":{"type":"string"},"text_generation":{"type":"string"}}}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/protagonists":{"get":{"operationId":"listYuanbaoProtagonists","summary":"List protagonist profiles from the user's protagonist library.","responses":{"200":{"description":"Protagonist profiles.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtagonistListResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/creator-profile":{"post":{"operationId":"readCreatorTopPosts","summary":"Read the most-liked public posts from a Douyin or Xiaohongshu creator profile.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatorProfileRequest"}}}},"responses":{"200":{"description":"Most-liked public posts and cost hints.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatorProfileResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/topic-brief":{"post":{"operationId":"buildTopicAndScriptBrief","summary":"Build a complete brief for ChatGPT to generate topics, copy, and scripts using subscription-side generation.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopicBriefRequest"}}}},"responses":{"200":{"description":"Creator videos, selected protagonist info, and prompt instructions for ChatGPT.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopicBriefResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/capabilities":{"get":{"operationId":"listYuanbaoActionCapabilities","summary":"List all Yuanbao features available to this ChatGPT Action and their cost behavior.","responses":{"200":{"description":"Available Yuanbao Action capabilities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapabilitiesResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/commerce-links":{"get":{"operationId":"listYuanbaoCommerceLinks","summary":"List Yuanbao ecommerce and gas-station convenience-store project pages.","responses":{"200":{"description":"Visible ecommerce project links on yuanbaotools.com.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommerceLinksResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/single-video":{"post":{"operationId":"parseSingleVideoLink","summary":"Parse one public video link into title, description, transcript/source copy, and cost hints.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleVideoRequest"}}}},"responses":{"200":{"description":"Parsed video source material.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleVideoResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/copy-brief":{"post":{"operationId":"buildCopyAndScriptBrief","summary":"Build a complete brief for ChatGPT to generate rewritten copy, shooting scripts, and image prompts from a video or transcript.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyBriefRequest"}}}},"responses":{"200":{"description":"Copy/script generation brief for ChatGPT subscription-side generation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionBriefResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/shooting-script-brief":{"post":{"operationId":"buildShootingScriptBrief","summary":"Build a normal live-action shooting script brief for ChatGPT to generate from final copy.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptBriefRequest"}}}},"responses":{"200":{"description":"Shooting script brief.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionBriefResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/ai-shooting-script-brief":{"post":{"operationId":"buildAiShootingScriptBrief","summary":"Build an AI video shooting/storyboard brief for ChatGPT to generate from final copy.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiScriptBriefRequest"}}}},"responses":{"200":{"description":"AI shooting/storyboard brief.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionBriefResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/image-brief":{"post":{"operationId":"buildImagePromptBrief","summary":"Build image or cover prompt guidance for ChatGPT, without calling the backend image API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageBriefRequest"}}}},"responses":{"200":{"description":"Image prompt brief.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionBriefResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/visual-brief":{"post":{"operationId":"buildOrRunVisualAnalysisBrief","summary":"Prepare visual viral-breakdown guidance, or run paid server-side frame analysis only when explicitly requested.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisualBriefRequest"}}}},"responses":{"200":{"description":"Visual analysis result or guidance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisualBriefResponse"}}}}}}},"/api/action/p/9e52a5b5993df24104e4725e/video-production-brief":{"post":{"operationId":"buildVideoProductionBrief","summary":"Build a web-tool task package for uploading assets and producing a final MP4 video.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoProductionBriefRequest"}}}},"responses":{"200":{"description":"Video production task package.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionBriefResponse"}}}}}}}}}