👆Use above tools to generate API request code snippets.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
This parameter defines the url of the long-form video. OpusClip can import public videos from the following platforms:
YouTube, Google Drive, Vimeo, Zoom, Rumble, Twitch, Facebook, LinkedIn, X, Dropbox, Riverside, Loom, Frame.io, StreamYard
Any public video s3 link of an mp4 file (up to 10GB per video)
Actions to be taken upon project conclusion, such as sending an email or triggering a webhook.
Specifies the action to be taken upon project conclusion. Options include sending an email or triggering a webhook.
Available options:
EMAIL,
WEBHOOK
conclusionActions. notifyFailure
Indicates whether to notify on failure.
Email address to send notifications to, if type is EMAIL.
Webhook URL to trigger, if type is WEBHOOK.
Preferences for advanced curation of the video.
curationPref. topicKeywords
Keywords used to find relevant moments to clip from
The range of the original long-form video to generate clips from.
curationPref.range. startSec
The start time of the range to be curated.
curationPref.range. endSec
The end time of the range to be curated.
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
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.
ID of the brand template to be used for the project.
The unique identifier of the project.
The unique identifier of the user.
The unique identifier of the organization.
Indicates whether the project is deleted.
Indicates whether the project is purged.
The unique identifier of the project.
The platform from which the video is sourced.
Available options:
YOUTUBE,
UPLOADED,
YTDLP_LINK,
GDRIVE,
ZOOM,
STREAM_YARD
The unique identifier for the video on the source platform.
Labels associated with the project.
The product tier of the project.
The current stage of the project.
Available options:
PENDING,
QUEUED,
IMPORT,
CURATE,
REFINE,
RENDER,
UPLOAD,
COMPLETE,
STALLED
The total size of the project in bytes.
The storage status of the project.
The expiration date of the project storage.
The date and time when the project was created.
The date and time when the project was last updated.
The unique identifier of the cluster job processing the project.
The cluster on which the project is running.
The visibility of the project.
Available options:
DEFAULT,
PUBLIC,
PUBLIC_VIEW
Permissions associated with the project.
Recommendations for project prompts.
The URI of the source video.
The number of times the project has stalled.
The URL of the worker processing the project.
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].
curationPref. topicKeywords
Keywords used to find relevant moments to clip from
The range of the original long-form video to generate clips from.
curationPref.range. startSec
The start time of the range to be curated.
curationPref.range. endSec
The end time of the range to be curated.
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
Preferences for rendering the video, including layout and overlay options.
renderPref. enableAutoLayout
Enables automatic layout adjustment.
renderPref. enableScreenLayout
Enables screen layout for the video.
Enables cropping of the video.
Enables caption overlay on the video.
renderPref. enableUppercase
Converts all characters to uppercase in captions.
renderPref. enableHighlight
Enables keyword highlighting in captions.
Enables emoji overlay on the video.
renderPref. enableFillLayout
Enables fill layout for a single person.
renderPref. enableSplitLayout
Enables split layout for two people.
renderPref. enableThreeLayout
Enables layout for three people.
renderPref. enableFourLayout
Enables layout for four people.
renderPref. enableFitLayout
Enables fit layout for multiple people.
renderPref. fitLayoutCropRatio
Specifies the crop ratio for fit layout.
renderPref. enableVisualHook
Enables visual hook overlay, deprecated and should always be false.
renderPref. enableWatermark
Enables watermark overlay.
Font settings for captions.
The stroke settings of the font.
renderPref.font.stroke. enabled
Indicates if the stroke is enabled.
renderPref.font.stroke. color
renderPref.font.stroke. width
The shadow settings of the font.
renderPref.font.shadow. enabled
Indicates if the shadow is enabled.
renderPref.font.shadow. color
The x offset of the shadow.
The y offset of the shadow.
renderPref.font.shadow. blur
The blur radius of the shadow.
renderPref.font.shadow. useWordHighlightColor
Indicates if the word highlight color should be used for the shadow.
Available options:
CustomizedFont,
System
The storage path of the font.
Available options:
Large,
Middle,
Small
renderPref.font. numericalSize
The numerical size of the font.
renderPref.font. textDecoration
The text decoration of the font.
Available options:
line-through,
underline,
renderPref. highlightColor
Highlight colors for keywords in captions.
renderPref.highlightColor. primary
renderPref.highlightColor. secondary
Secondary highlight color.
renderPref. layoutAspectRatio
Specifies the layout aspect ratio.
Available options:
portrait,
landscape,
square
Enables B-Roll overlay on the video.
The refund status of the project.
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.
