POST
/
api
/
clip-projects

👆Use above tools to generate API request code snippets.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
videoUrl
string
required

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)
conclusionActions
object[]

Actions to be taken upon project conclusion, such as sending an email or triggering a webhook.

curationPref
object

Preferences for advanced curation of the video.

importPref
object

Preferences for importing the video, such as source language.

brandTemplateId
string

ID of the brand template to be used for the project.

Response

201 - application/json
id
string
required

The unique identifier of the project.

userId
string
required

The unique identifier of the user.

orgId
string
required

The unique identifier of the organization.

isDeleted
boolean
required

Indicates whether the project is deleted.

isPurged
boolean
required

Indicates whether the project is purged.

projectId
string
required

The unique identifier of the project.

sourcePlatform
enum<string>
required

The platform from which the video is sourced.

Available options:
YOUTUBE,
UPLOADED,
YTDLP_LINK,
GDRIVE,
ZOOM,
STREAM_YARD
sourceId
string
required

The unique identifier for the video on the source platform.

labels
string[]
required

Labels associated with the project.

productTier
string
required

The product tier of the project.

stage
enum<string>
required

The current stage of the project.

Available options:
PENDING,
QUEUED,
IMPORT,
CURATE,
REFINE,
RENDER,
UPLOAD,
COMPLETE,
STALLED
storageSize
number
required

The total size of the project in bytes.

storageStatus
string
required

The storage status of the project.

storageExpireAt
string
required

The expiration date of the project storage.

createdAt
string
required

The date and time when the project was created.

updatedAt
string
required

The date and time when the project was last updated.

clusterJobId
string
required

The unique identifier of the cluster job processing the project.

cluster
string
required

The cluster on which the project is running.

visibility
enum<string>
required

The visibility of the project.

Available options:
DEFAULT,
PUBLIC,
PUBLIC_VIEW
permissions
string[]
required

Permissions associated with the project.

promptRecommendations
string[]
required

Recommendations for project prompts.

sourceUri
string

The URI of the source video.

error
string

Error message, if any.

stallCount
number

The number of times the project has stalled.

workerUrl
string

The URL of the worker processing the project.

curationPref
object

Preferences for advanced curation of the video.

renderPref
object

Preferences for rendering the video, including layout and overlay options.

refundStatus
string

The refund status of the project.

importPref
object

Preferences for importing the video, such as source language.