Opus Clip

App · 20 actions

Create clip projects, organize clips into collections and manage social publishing.

Actions

ActionWhat it does
Add clip to collectionAdd clip to collection.
Cancel scheduled social postCancel a scheduled publish task before its publish time.
Create censor jobCreate censor job.
Create clip projectCreate clip project.
Create collectionCreate collection.
Create thumbnail jobExperimental.
Delete collectionDelete collection.
Export collectionExport collection.
Get censor jobGet censor job.
Get clip projectGet clip project.
Get thumbnail jobExperimental.
Get transcriptFetch the trimmed source-video transcript for a project.
List brand templatesList brand templates.
List collectionsList collections.
List exportable clipsList exportable clips.
List social accountsRetrieve the connected social destinations available for social posting.
Publish social postPublish a clip immediately to a connected social account.
Remove clip from collectionRemove clip from collection.
Schedule social postSchedule a clip to be published later.
Update clip project visibilityUpdate clip project visibility.

Add clip to collection

Add clip to collection.

Inputs

Collectioncollection_idtextRequired
The collectionID of the collection that you want to add the clip to.
Content IDcontent_idtextRequired
The ID of the clip that you want to add to the collection. FullClipId: {projectId}.{curationId}

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "collectionId": "example",
      "contentId": "example"
    }
  }
}

Cancel scheduled social post

Cancel a scheduled publish task before its publish time.

Inputs

Schedule IDschedule_idtextRequired
Unique ID of the schedule task to cancel

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {}
  }
}

Create censor job

Create censor job.

Inputs

Project IDproject_idtextRequired
The project id that you want to censor.
Clip IDclip_idtextRequired
The clip id that you want to censor.
Optionsoptionsobject
Some options for the censor job.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "jobId": "example",
    "message": "example"
  }
}

Create clip project

Create clip project.

Inputs

Video URLvideo_urltextRequired
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…
Conclusion actionsconclusion_actionslist
Actions to be taken upon project conclusion, such as sending an email or triggering a webhook.
Curation prefcuration_prefobject
Preferences for advanced curation of the video.
Import prefimport_prefobject
Preferences for importing the video, such as source language.
Brand templatebrand_template_idtext
ID of the brand template to be used for the project.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "cluster": "example",
    "clusterJobId": "example",
    "createdAt": "example",
    "curationPref": {
      "clipDurations": [],
      "enableAutoHook": false,
      "genre": "example",
      "range": {
        "endSec": 1.0,
        "startSec": 1.0
      },
      "topicKeywords": []
    },
    "error": "example",
    "id": "example",
    "importPref": {
      "sourceLang": "example"
    },
    "isDeleted": false,
    "isPurged": false,
    "labels": [],
    "model": "example",
    "orgId": "example",
    "permissions": [],
    "productTier": "example",
    "projectId": "example",
    "promptRecommendations": [],
    "refundStatus": "example",
    "renderPref": {
      "enableAutoLayout": false,
      "enableBroll": false,
      "enableCaption": false,
      "enableCrop": false,
      "enableEmoji": false,
      "enableFillLayout": false,
      "enableFitLayout": false,
      "enableFourLayout": false,
      "enableHighlight": false,
      "enableScreenLayout": false,
      "enableSplitLayout": false,
      "enableThreeLayout": false,
      "enableUppercase": false,
      "enableVisualHook": false,
      "enableWatermark": false,
      "fitLayoutCropRatio": "example",
      "font": {
        "color": "example",
        "family": "example",
        "id": "example",
        "name": "example",
        "numericalSize": 1.0,
        "path": "example",
        "shadow": {},
        "size": "example",
        "stroke": {},
        "style": [],
        "textDecoration": "example",
        "type": "example"
      },
      "highlightColor": {
        "primary": "example",
        "secondary": "example"
      },
      "layoutAspectRatio": "example"
    },
    "sourceId": "example",
    "sourcePlatform": "example",
    "sourceUri": "example",
    "stage": "example",
    "stallCount": 1.0,
    "storageExpireAt": "example",
    "storageSize": 1.0,
    "storageStatus": "example",
    "updatedAt": "example",
    "userId": "example",
    "visibility": "example",
    "workerUrl": "example"
  }
}

Create collection

Create collection.

Inputs

Collection namecollection_nametextRequired
The name of the collection that you want to create.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "collectionId": "example",
      "collectionName": "example",
      "createdAt": "example",
      "updatedAt": "example"
    }
  }
}

Create thumbnail job

Experimental. Subject to change; daily caps apply and the endpoint may be temporarily disabled via a runtime kill switch. Currently the only published jobType is thumbnail (7 credits/call, charged on success and refunded on failure).

Inputs

Source URIsource_uritextRequired
URL of the source video to extract thumbnails from.
Reference image URIreference_image_uritext
Optional reference image URL. The thumbnail composition draws stylistic cues from this image. Upload via POST /api/upload-links-v2 with usecase: 'FreeToolMedia' and the image's extension (for example png), send the returned requiredHeaders on the upload, then pass the…
Mask image URImask_image_uritext
Optional mask image URL for inpainting.
Promptprompttext
Optional text prompt steering the thumbnail composition.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "jobId": "example"
  }
}

Delete collection

Delete collection.

Inputs

Collectioncollection_idtextRequired
The unique collection ID of the collection that you want to delete.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": "example"
  }
}

Export collection

Export collection.

Inputs

Collectioncollection_idtextRequired
The collectionID of the collection that you want to export

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "contentList": []
    }
  }
}

Get censor job

Get censor job.

Inputs

Job IDjob_idtextRequired
The jobId that you want to get the status of.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "error": "example",
    "status": "example"
  }
}

Get clip project

Get clip project.

Inputs

Project IDproject_idtextRequired
Project ID.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "cluster": "example",
    "clusterJobId": "example",
    "createdAt": "example",
    "curationPref": {
      "clipDurations": [],
      "enableAutoHook": false,
      "genre": "example",
      "range": {
        "endSec": 1.0,
        "startSec": 1.0
      },
      "topicKeywords": []
    },
    "error": "example",
    "id": "example",
    "importPref": {
      "sourceLang": "example"
    },
    "isDeleted": false,
    "isPurged": false,
    "labels": [],
    "model": "example",
    "orgId": "example",
    "permissions": [],
    "productTier": "example",
    "projectId": "example",
    "promptRecommendations": [],
    "refundStatus": "example",
    "renderPref": {
      "enableAutoLayout": false,
      "enableBroll": false,
      "enableCaption": false,
      "enableCrop": false,
      "enableEmoji": false,
      "enableFillLayout": false,
      "enableFitLayout": false,
      "enableFourLayout": false,
      "enableHighlight": false,
      "enableScreenLayout": false,
      "enableSplitLayout": false,
      "enableThreeLayout": false,
      "enableUppercase": false,
      "enableVisualHook": false,
      "enableWatermark": false,
      "fitLayoutCropRatio": "example",
      "font": {
        "color": "example",
        "family": "example",
        "id": "example",
        "name": "example",
        "numericalSize": 1.0,
        "path": "example",
        "shadow": {},
        "size": "example",
        "stroke": {},
        "style": [],
        "textDecoration": "example",
        "type": "example"
      },
      "highlightColor": {
        "primary": "example",
        "secondary": "example"
      },
      "layoutAspectRatio": "example"
    },
    "sourceId": "example",
    "sourcePlatform": "example",
    "sourceUri": "example",
    "stage": "example",
    "stallCount": 1.0,
    "storageExpireAt": "example",
    "storageSize": 1.0,
    "storageStatus": "example",
    "updatedAt": "example",
    "userId": "example",
    "visibility": "example",
    "workerUrl": "example"
  }
}

Get thumbnail job

Experimental. Returns status, progress, and result for a job created via POST /api/generative-jobs. For thumbnail jobs, the result.generatedThumbnailUris array contains the CDN URLs of the produced thumbnails when status is CONCLUDED.

Inputs

Job IDjob_idtextRequired
The jobId returned by POST /api/generative-jobs.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "error": {
      "message": "example",
      "type": "example"
    },
    "progress": {
      "percentage": 1.0,
      "status": "example"
    },
    "result": {
      "generatedThumbnailUris": []
    },
    "status": "example"
  }
}

Get transcript

Fetch the trimmed source-video transcript for a project. ASR internals (seek, tokens, log-probabilities, etc.) are stripped. For API callers on a range-limited project, paragraphs are filtered to the billed curation range; internal callers and full-source submissions get the…

Inputs

Project IDproject_idtextRequired
Project ID.

Outputs

dataobject
Wrapper for the transcript response. data[0] is the transcript, or null when the project has no transcript yet.
Example output
{
  "data": {
    "data": []
  }
}

List brand templates

List brand templates.

Inputs

None.

Outputs

datalist
Result.
Example output
{
  "data": []
}

List collections

List collections.

Inputs

Qqtext
Query type q = mine means list collections of your account. q = findByContentId means list collections contained the specific content(clip).One of: findByContentId, mine.
Content IDcontent_idtext
If specified, will only return collections that contain the clip with this contentID.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "limit": 1.0,
      "list": [],
      "total": 1.0
    }
  }
}

List exportable clips

List exportable clips.

Inputs

X opus org IDx_opus_org_idtext
Organization ID. Required for users with multiple organizations.
Project IDproject_idtext
Project ID, required when q=findByProjectId
Collectioncollection_idtext
Collection ID, required when q=findByCollectionId
Page numpage_numnumber
Page Num, started with 1At least 1.
Page sizepage_sizenumber
Page SizeAt least 1.

Outputs

datalist
Result.
Example output
{
  "data": []
}

List social accounts

Retrieve the connected social destinations available for social posting.

Inputs

None.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": []
  }
}

Publish social post

Publish a clip immediately to a connected social account. Each X (formerly Twitter) post costs 3 credits.

Inputs

Project IDproject_idtextRequired
Project ID
Clip IDclip_idtextRequired
Bare clip ID (e.g. qU3iVMSO77). Not the composite {projectId}.{clipId} form returned as id by GET /api/exportable-clips. pass only the part after the dot.
Post account IDpost_account_idtextRequired
Unique ID of the connected social account record
Sub account IDsub_account_idtext
Sub-account ID used by Facebook pages, Instagram business accounts, or LinkedIn
Post detailpost_detailobjectRequired
Post detail.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "postId": "example"
    }
  }
}

Remove clip from collection

Remove clip from collection.

Inputs

Collectioncollection_idtextRequired
The collectionID of the collection that you want to remove the clip from.
Content IDcontent_idtextRequired
The ID of the clip that you want to remove from the collection. FullClipId: {projectId}.{curationId}

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": "example"
  }
}

Schedule social post

Schedule a clip to be published later. The publishAt value must be a future UTC ISO 8601 timestamp. Each X (formerly Twitter) post costs 3 credits.

Inputs

Project IDproject_idtextRequired
Project ID
Clip IDclip_idtextRequired
Bare clip ID (e.g. qU3iVMSO77). Not the composite {projectId}.{clipId} form returned as id by GET /api/exportable-clips. pass only the part after the dot.
Post account IDpost_account_idtextRequired
Unique ID of the connected social account record
Sub account IDsub_account_idtext
Sub-account ID used by Facebook pages, Instagram business accounts, or LinkedIn
Publish atpublish_atdate and timeRequired
Future publish time in UTC ISO 8601 format
Post detailpost_detailobjectRequired
Post detail.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "scheduleId": "example"
    }
  }
}

Update clip project visibility

Update clip project visibility.

Inputs

Project IDproject_idtextRequired
Project ID.
VisibilityvisibilitytextRequired
The visibility of the project. DEFAULT: Team members can open, edit and export the project. PUBLIC: Anyone can open, edit and export the project.One of: DEFAULT, PUBLIC.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "cluster": "example",
    "clusterJobId": "example",
    "createdAt": "example",
    "curationPref": {
      "clipDurations": [],
      "enableAutoHook": false,
      "genre": "example",
      "range": {
        "endSec": 1.0,
        "startSec": 1.0
      },
      "topicKeywords": []
    },
    "error": "example",
    "id": "example",
    "importPref": {
      "sourceLang": "example"
    },
    "isDeleted": false,
    "isPurged": false,
    "labels": [],
    "model": "example",
    "orgId": "example",
    "permissions": [],
    "productTier": "example",
    "projectId": "example",
    "promptRecommendations": [],
    "refundStatus": "example",
    "renderPref": {
      "enableAutoLayout": false,
      "enableBroll": false,
      "enableCaption": false,
      "enableCrop": false,
      "enableEmoji": false,
      "enableFillLayout": false,
      "enableFitLayout": false,
      "enableFourLayout": false,
      "enableHighlight": false,
      "enableScreenLayout": false,
      "enableSplitLayout": false,
      "enableThreeLayout": false,
      "enableUppercase": false,
      "enableVisualHook": false,
      "enableWatermark": false,
      "fitLayoutCropRatio": "example",
      "font": {
        "color": "example",
        "family": "example",
        "id": "example",
        "name": "example",
        "numericalSize": 1.0,
        "path": "example",
        "shadow": {},
        "size": "example",
        "stroke": {},
        "style": [],
        "textDecoration": "example",
        "type": "example"
      },
      "highlightColor": {
        "primary": "example",
        "secondary": "example"
      },
      "layoutAspectRatio": "example"
    },
    "sourceId": "example",
    "sourcePlatform": "example",
    "sourceUri": "example",
    "stage": "example",
    "stallCount": 1.0,
    "storageExpireAt": "example",
    "storageSize": 1.0,
    "storageStatus": "example",
    "updatedAt": "example",
    "userId": "example",
    "visibility": "example",
    "workerUrl": "example"
  }
}

On this page