Sign in

v1

latestOpenAPI 3.0.02026-07-26213850.5 KB
clip-project
enterprise

post/api/clip-projects

Request body

videoUrlstring 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)
brandTemplateIdstring

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

Example request

{
  "videoUrl": "https://www.youtube.com/watch?v=LXvv6CbGg8A",
  "conclusionActions": [
    {
      "type": "EMAIL",
      "notifyFailure": true,
      "email": "opusclip@opus.pro"
    }
  ],
  "curationPref": {
    "clipDurations": [
      [
        0,
        30
      ],
      [
        30,
        60
      ],
      [
        60,
        90
      ],
      [
        90,
        180
      ]
    ],
    "topicKeywords": [
      "Fancy Words"
    ],
    "range": {
      "startSec": 106,
      "endSec": 204
    }
  },
  "importPref": {
    "sourceLang": "en"
  },
  "brandTemplateId": "preset-fancy-Karaoke"
}

Response

idstring required

The unique identifier of the project.

userIdstring required

The unique identifier of the user.

orgIdstring required

The unique identifier of the organization.

isDeletedboolean required

Indicates whether the project is deleted.

isPurgedboolean required

Indicates whether the project is purged.

projectIdstring required

The unique identifier of the project.

sourcePlatform'YOUTUBE' | 'UPLOADED' | 'YTDLP_LINK' | 'GDRIVE' | 'ZOOM' | 'STREAM_YARD' required

The platform from which the video is sourced.

sourceIdstring required

The unique identifier for the video on the source platform.

sourceUristring

The URI of the source video.

labelsstring[] required

Labels associated with the project.

productTierstring required

The product tier of the project.

stage'PENDING' | 'QUEUED' | 'IMPORT' | 'CURATE' | 'REFINE' | 'RENDER' | 'UPLOAD' | 'COMPLETE' | 'STALLED' required

The current stage of the project.

model'ClipAnything' | 'ClipBasic'

The AI clipping model used for the project.

errorstring

Error message, if any.

stallCountnumber

The number of times the project has stalled.

workerUrlstring

The URL of the worker processing the project.

storageSizenumber required

The total size of the project in bytes.

storageStatusstring required

The storage status of the project.

storageExpireAtstring required

The expiration date of the project storage.

refundStatusstring

The refund status of the project.

createdAtstring date-time required

The date and time when the project was created.

updatedAtstring date-time required

The date and time when the project was last updated.

clusterJobIdstring required

The unique identifier of the cluster job processing the project.

clusterstring required

The cluster on which the project is running.

visibility'DEFAULT' | 'PUBLIC' | 'PUBLIC_VIEW' required

The visibility of the project.

permissionsstring[] required

Permissions associated with the project.

promptRecommendationsstring[] required

Recommendations for project prompts.

Example response

{
  "id": "P0000000demo",
  "userId": "google-oauth2|100000000000000000001",
  "orgId": "org_Example00000001",
  "projectId": "P0000000demo",
  "sourcePlatform": "YOUTUBE",
  "sourceId": "YT_tEXaoozFRes",
  "labels": [],
  "productTier": "PRO",
  "stage": "QUEUED",
  "model": "ClipBasic",
  "curationPref": {
    "clipDurations": [
      [
        0,
        30
      ],
      [
        30,
        60
      ],
      [
        60,
        90
      ],
      [
        90,
        180
      ]
    ],
    "topicKeywords": [
      "Fancy Words"
    ],
    "range": {
      "startSec": 106,
      "endSec": 204
    }
  },
  "storageStatus": "TEMPORARY",
  "storageExpireAt": "2024-12-19T08:17:42.832Z",
  "renderPref": {
    "enableScreenLayout": true,
    "enableCrop": true,
    "enableCaption": true,
    "enableUppercase": true,
    "enableHighlight": true,
    "enableEmoji": true,
    "enableSplitLayout": true,
    "enableThreeLayout": true,
    "enableFourLayout": true,
    "fitLayoutCropRatio": "4:3",
    "font": {
      "color": "#ffffff",
      "style": [
        "900"
      ],
      "family": "Komika-axis",
      "stroke": {
        "enabled": true,
        "color": "#000000FF",
        "width": 16
      },
      "shadow": {
        "enabled": true,
        "color": "#FFFFFFFF",
        "x": 2,
        "y": 2,
        "blur": 16
      },
      "id": "font123",
      "type": "CustomizedFont",
      "name": "Arial",
      "path": "/fonts/arial.ttf",
      "size": "Large",
      "numericalSize": 50,
      "textDecoration": "underline"
    },
    "highlightColor": {
      "primary": "#ff0000",
      "secondary": "#00ff00"
    }
  },
  "createdAt": "2024-11-19T08:17:42.832Z",
  "updatedAt": "2024-11-19T08:17:42.860Z",
  "clusterJobId": "FP.P0000000demo:20241119081742853.FP",
  "cluster": "gold",
  "importPref": {
    "sourceLang": "en"
  },
  "visibility": "DEFAULT",
  "permissions": [
    "PROJECT_SHARE",
    "PROJECT_EDIT",
    "PROJECT_VIEW"
  ],
  "promptRecommendations": [
    "Foo",
    "Boo"
  ]
}