v1
latestOpenAPI 3.0.02026-07-24508.6 KBSubmit a Video for Clipping
Headers
Request body
The lang parameter tells Vizard what spoken language is used in your submitted video. For supported language codes, please refer to https://vizard.readme.io/docs/supported-languages#/
The parameter preferLength controls how long each output video will be. Value can be: <br> - 0: Automatically chosen <br> - 1: Less than 30 seconds <br> - 2: 30 to 60 seconds <br> - 3: 60 to 90 seconds <br> - 4: 90 seconds to 3 minutes
URL of your video source.
The source of a video. Value can be: <br> - 1: Remote video file <br> - 2: YouTube <br> - 3: Google Drive <br> - 4: Vimeo <br> - 5: StreamYard <br> - 6: TikTok <br> - 7: Twitter(X) <br> - 9: Twitch <br> - 10: Loom <br> - 11: Facebook <br> - 12: LinkedIn
The ratioOfClip parameter controls the output video shape for all generated clips. Value can be: <br> - 1(default): 9:16 (Vertical) <br> - 2: 1:1 (Square) <br> - 3: 4:5 (Portrait) <br> - 4: 16:9 (Horizontal)
The templateId parameter allows you to apply a custom template to the generated clips. https://docs.vizard.ai/docs/advanced#/apply-a-template
The removeSilenceSwitch parameter controls whether silent gaps and filler words (like “um”, “uh”) are removed from your final clips. Value can be: <br> - 0(default): disable remove silence <br> - 1: enable remove silence
Parameter maxClipNumber sets the maximum number of clips to return from a long video (range: 1 to 100). This does not control the exact number of clips—only the upper limit. If this parameter is not included in your request, all clips will be returned.
Use the keywords parameter to include content related to specific topics in your clips.
Use the subtitleSwitch parameter to control whether subtitles are displayed in the final clips. By default, this is set to 1, meaning subtitles are turned on. When set to 0, subtitles will be set to hidden.
Use the headlineSwitch parameter to control whether an AI-generated headline (also called a hook) is added to your clip. Value can be: <br> - 1(default): show headline <br> - 0: no headline
Use the projectName parameter to set a custom name for the clipping project created from your submitted video.
Video file extension. Supported video file extensions are: mp4, 3gp, avi, and mov. <br> This parameter is required only when videoType is set to 1.
Use the emojiSwitch parameter to control whether auto emoji in subtitles is enabled or not.
Use the highlightSwitch parameter to control whether auto highlight keywords function is enabled or not.
Use the autoBrollSwitch parameter to control whether auto B-roll function is enabled or not.
The clipModel parameter specifies which AI clip model is used to analyze the submitted video and generate clips. Value can be: <br> - clip_v1: Use Model v1 with the existing processing and billing logic <br> - clip_v2: Use Model v2, charged at 1.25x the v1 rate. <br> If omitted, clip_v1 is used by defualt.