👆Use above tools to generate API request code snippets.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The visibility of the project. DEFAULT: Team members can open, edit and export the project. PUBLIC: Anyone can open, edit and export the project.
Available options:
DEFAULT,
PUBLIC
The cluster on which the project is running.
The unique identifier of the cluster job processing the project.
The date and time when the project was created.
The unique identifier of the project.
Indicates whether the project is deleted.
Indicates whether the project is purged.
Labels associated with the project.
The unique identifier of the organization.
Permissions associated with the project.
The product tier of the project.
The unique identifier of the project.
Recommendations for project prompts.
The unique identifier for the video on the source platform.
The platform from which the video is sourced.
Available options:
YOUTUBE,
UPLOADED,
YTDLP_LINK,
GDRIVE,
ZOOM,
STREAM_YARD
The current stage of the project.
Available options:
PENDING,
QUEUED,
IMPORT,
CURATE,
REFINE,
RENDER,
UPLOAD,
COMPLETE,
STALLED
The expiration date of the project storage.
The total size of the project in bytes.
The storage status of the project.
The date and time when the project was last updated.
The unique identifier of the user.
The visibility of the project.
Available options:
DEFAULT,
PUBLIC,
PUBLIC_VIEW
Preferences for advanced curation of the video.
curationPref. clipDurations
Durations (in seconds) of the clips to be generated. Default value is [0, 90]. Other possible values are: [0, 30], [30, 60], [60, 90], [90, 180].
The genre of the clips, will apply suitable AI curation models to find the best results.
Available options:
Auto,
Q&A,
Commentary,
Marketing,
Webinar,
Motivational speech,
Podcast,
Academic,
Listicle,
Product reviews,
How-to,
Comedy,
Sports commentary,
Church,
News,
Vlog,
Gaming,
Others
The range of the original long-form video to generate clips from.
curationPref.range. endSec
The end time of the range to be curated.
curationPref.range. startSec
The start time of the range to be curated.
curationPref. topicKeywords
Keywords used to find relevant moments to clip from
Preferences for importing the video, such as source language.
Select the language to detect the video's spoken content, or leave it blank for automatic detection. Using ISO-639 language codes, examples: "en" for English, "de" for German, "fr" for French.
The refund status of the project.
Preferences for rendering the video, including layout and overlay options.
renderPref. enableAutoLayout
Enables automatic layout adjustment.
Enables caption overlay on the video.
Enables cropping of the video.
Enables emoji overlay on the video.
renderPref. enableFillLayout
Enables fill layout for a single person.
renderPref. enableFitLayout
Enables fit layout for multiple people.
renderPref. enableFourLayout
Enables layout for four people.
renderPref. enableHighlight
Enables keyword highlighting in captions.
renderPref. enableScreenLayout
Enables screen layout for the video.
renderPref. enableSplitLayout
Enables split layout for two people.
renderPref. enableThreeLayout
Enables layout for three people.
renderPref. enableUppercase
Converts all characters to uppercase in captions.
renderPref. enableVisualHook
Enables visual hook overlay, deprecated and should always be false.
renderPref. enableWatermark
Enables watermark overlay.
renderPref. fitLayoutCropRatio
Specifies the crop ratio for fit layout.
Font settings for captions.
The shadow settings of the font.
renderPref.font.shadow. blur
The blur radius of the shadow.
renderPref.font.shadow. color
renderPref.font.shadow. enabled
Indicates if the shadow is enabled.
The x offset of the shadow.
The y offset of the shadow.
renderPref.font.shadow. useWordHighlightColor
Indicates if the word highlight color should be used for the shadow.
The stroke settings of the font.
renderPref.font.stroke. color
renderPref.font.stroke. enabled
Indicates if the stroke is enabled.
renderPref.font.stroke. width
renderPref.font. numericalSize
The numerical size of the font.
The storage path of the font.
Available options:
Large,
Middle,
Small
renderPref.font. textDecoration
The text decoration of the font.
Available options:
line-through,
underline,
Available options:
CustomizedFont,
System
renderPref. highlightColor
Highlight colors for keywords in captions.
renderPref.highlightColor. primary
renderPref.highlightColor. secondary
Secondary highlight color.
Enables B-Roll overlay on the video.
renderPref. layoutAspectRatio
Specifies the layout aspect ratio.
Available options:
portrait,
landscape,
square
The URI of the source video.
The number of times the project has stalled.
The URL of the worker processing the project.
