Submit a Video for Clipping

post

https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

lang

string

required

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#/

preferLength

array of integers

required

The parameter preferLength controls how long each output video will be. Value can be:
- 0: Automatically chosen
- 1: Less than 30 seconds
- 2: 30 to 60 seconds
- 3: 60 to 90 seconds
- 4: 90 seconds to 3 minutes

preferLength*

videoUrl

string

required

URL of your video source.

videoType

integer

required

The source of a video. Value can be:
- 1: Remote video file
- 2: YouTube
- 3: Google Drive
- 4: Vimeo
- 5: StreamYard
- 6: TikTok
- 7: Twitter(X)
- 9: Twitch
- 10: Loom
- 11: Facebook
- 12: LinkedIn

ratioOfClip

integer

Defaults to 1

The ratioOfClip parameter controls the output video shape for all generated clips. Value can be:
- 1(default): 9:16 (Vertical)
- 2: 1:1 (Square)
- 3: 4:5 (Portrait)
- 4: 16:9 (Horizontal)

templateId

int64

The templateId parameter allows you to apply a custom template to the generated clips. https://docs.vizard.ai/docs/advanced#/apply-a-template

removeSilenceSwitch

integer

Defaults to 0

The removeSilenceSwitch parameter controls whether silent gaps and filler words (like “um”, “uh”) are removed from your final clips. Value can be:
- 0(default): disable remove silence
- 1: enable remove silence

maxClipNumber

integer

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.

keywords

string

Use the keywords parameter to include content related to specific topics in your clips.

subtitleSwitch

integer

Defaults to 1

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.

headlineSwitch

integer

Defaults to 1

Use the headlineSwitch parameter to control whether an AI-generated headline (also called a hook) is added to your clip. Value can be:
- 1(default): show headline
- 0: no headline

projectName

string

Use the projectName parameter to set a custom name for the clipping project created from your submitted video.

ext

string

required

Video file extension. Supported video file extensions are: mp4, 3gp, avi, and mov.
This parameter is required only when videoType is set to 1.

emojiSwitch

integer

Defaults to 0

Use the emojiSwitch parameter to control whether auto emoji in subtitles is enabled or not.

highlightSwitch

integer

Defaults to 0

Use the highlightSwitch parameter to control whether auto highlight keywords function is enabled or not.

autoBrollSwitch

integer

Defaults to 0

Use the autoBrollSwitch parameter to control whether auto B-roll function is enabled or not.

Headers

VIZARDAI_API_KEY

string

required

Response

200