Project representation

string

required

The unique identifier of the project.

Example:

"P1111908HgB1"

userId

string

required

The unique identifier of the user.

Example:

"google-oauth2|106053850538038134111"

orgId

string

required

The unique identifier of the organization.

Example:

"org_G5vEaJsd4111"

isDeleted

boolean

required

Indicates whether the project is deleted.

Example:

false

isPurged

boolean

required

Indicates whether the project is purged.

Example:

false

projectId

string

required

The unique identifier of the project.

Example:

"P1111908HgB0"

sourcePlatform

enum<string>

required

The platform from which the video is sourced.

Available options:

YOUTUBE,

UPLOADED,

YTDLP_LINK,

GDRIVE,

ZOOM,

STREAM_YARD

Example:

"YOUTUBE"

sourceId

string

required

The unique identifier for the video on the source platform.

Example:

"YT_tEXaoozFRes"

labels

string[]

required

Labels associated with the project.

Example:

[]

productTier

string

required

The product tier of the project.

Example:

"PRO"

stage

enum<string>

required

The current stage of the project.

Available options:

PENDING,

QUEUED,

IMPORT,

CURATE,

REFINE,

RENDER,

UPLOAD,

COMPLETE,

STALLED

Example:

"QUEUED"

storageSize

number

required

The total size of the project in bytes.

Example:

0

storageStatus

string

required

The storage status of the project.

Example:

"TEMPORARY"

storageExpireAt

string

required

The expiration date of the project storage.

Example:

"2024-12-19T08:17:42.832Z"

createdAt

string

required

The date and time when the project was created.

Example:

"2024-11-19T08:17:42.832Z"

updatedAt

string

required

The date and time when the project was last updated.

Example:

"2024-11-19T08:17:42.860Z"

clusterJobId

string

required

The unique identifier of the cluster job processing the project.

Example:

"FP.P1111908HgB1:20241119081742853.FP"

cluster

string

required

The cluster on which the project is running.

Example:

"gold"

visibility

enum<string>

required

The visibility of the project.

Available options:

DEFAULT,

PUBLIC,

PUBLIC_VIEW

Example:

"DEFAULT"

permissions

string[]

required

Permissions associated with the project.

Example:

[
  "PROJECT_SHARE",
  "PROJECT_EDIT",
  "PROJECT_VIEW"
]

promptRecommendations

string[]

required

Recommendations for project prompts.

Example:

["Foo", "Boo"]

sourceUri

string

The URI of the source video.

Example:

null

error

string

Error message, if any.

Example:

null

stallCount

number

The number of times the project has stalled.

Example:

null

workerUrl

string

The URL of the worker processing the project.

Example:

null

curationPref

object

Preferences for advanced curation of the video.

curationPref.clipDurations

array

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].

Example:

[[0, 30], [30, 60], [60, 90], [90, 180]]

curationPref.topicKeywords

string[]

Keywords used to find relevant moments to clip from

Example:

["Fancy Words"]

curationPref.range

object

The range of the original long-form video to generate clips from.

Example:

{ "startSec": 106, "endSec": 204 }

curationPref.genre

enum<string>

default:Auto

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

Example:

"Auto"

Example:

{
  "range": { "startSec": 28, "endSec": 636 },
  "clipDurations": [[0, 90]],
  "topicKeywords": ["OpusClip"],
  "genre": "Auto",
  "skipCurate": false
}

renderPref

object

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

renderPref.enableAutoLayout

boolean

default:false

required

Enables automatic layout adjustment.

Example:

false

renderPref.enableScreenLayout

boolean

default:false

required

Enables screen layout for the video.

Example:

true

renderPref.enableCrop

boolean

default:false

required

Enables cropping of the video.

Example:

true

renderPref.enableCaption

boolean

default:false

required

Enables caption overlay on the video.

Example:

true

renderPref.enableUppercase

boolean

default:false

required

Converts all characters to uppercase in captions.

Example:

true

renderPref.enableHighlight

boolean

default:false

required

Enables keyword highlighting in captions.

Example:

true

renderPref.enableEmoji

boolean

default:false

required

Enables emoji overlay on the video.

Example:

true

renderPref.enableFillLayout

boolean

default:false

required

Enables fill layout for a single person.

Example:

false

renderPref.enableSplitLayout

boolean

default:false

required

Enables split layout for two people.

Example:

true

renderPref.enableThreeLayout

boolean

default:false

required

Enables layout for three people.

Example:

true

renderPref.enableFourLayout

boolean

default:false

required

Enables layout for four people.

Example:

true

renderPref.enableFitLayout

boolean

default:false

required

Enables fit layout for multiple people.

Example:

false

renderPref.fitLayoutCropRatio

string

default:4:3

required

Specifies the crop ratio for fit layout.

Example:

"4:3"

renderPref.enableVisualHook

boolean

default:false

required

Enables visual hook overlay, deprecated and should always be false.

Example:

false

renderPref.enableWatermark

boolean

default:false

required

Enables watermark overlay.

Example:

false

renderPref.font

object

required

Font settings for captions.

renderPref.font.color

string

required

The color of the font.

Example:

"#ffffff"

renderPref.font.style

string[]

required

The style of the font.

Example:

["900"]

renderPref.font.family

string

required

The family of the font.

Example:

"Komika-axis"

renderPref.font.stroke

object

required

The stroke settings of the font.

Example:

{
  "enabled": false,
  "color": "#000000FF",
  "width": 16
}

renderPref.font.shadow

object

required

The shadow settings of the font.

Example:

{
  "enabled": true,
  "color": "#FFFFFFFF",
  "x": 2,
  "y": 2,
  "blur": 16
}

renderPref.font.id

string

The ID of the font.

Example:

"font123"

renderPref.font.type

enum<string>

The type of the font.

Available options:

CustomizedFont,

System

Example:

"CustomizedFont"

renderPref.font.name

string

The name of the font.

Example:

"Arial"

renderPref.font.path

string

The storage path of the font.

Example:

"/fonts/arial.ttf"

renderPref.font.size

enum<string>

The size of the font.

Available options:

Large,

Middle,

Small

Example:

"Large"

renderPref.font.numericalSize

number

The numerical size of the font.

Example:

50

renderPref.font.textDecoration

enum<string>

The text decoration of the font.

Available options:

line-through,

underline,

Example:

"underline"

Example:

{
  "color": "#ffffff",
  "style": ["900"],
  "family": "Komika-axis",
  "stroke": {
    "enabled": false,
    "color": "#000000FF",
    "width": 16
  },
  "shadow": {
    "enabled": true,
    "color": "#FFFFFFFF",
    "x": 2,
    "y": 2,
    "blur": 16
  }
}

renderPref.highlightColor

object

required

Highlight colors for keywords in captions.

Example:

{
  "primary": "#ff0000",
  "secondary": "#00ff00"
}

renderPref.layoutAspectRatio

enum<string>

default:portrait

Specifies the layout aspect ratio.

Available options:

portrait,

landscape,

square

Example:

"portrait"

renderPref.enableBroll

boolean

default:false

Enables B-Roll overlay on the video.

Example:

false

Example:

{
  "skipReframe": false,
  "enableSplitLayout": true,
  "enableFitLayout": false,
  "enableFillLayout": false,
  "enableScreenLayout": true,
  "enableThreeLayout": true,
  "enableFourLayout": true,
  "enableGameLayout": null,
  "enableAutoLayout": false,
  "disableFitLayout": false,
  "disableFillLayout": false,
  "fitLayoutCropRatio": "4:3",
  "enableCrop": true,
  "layoutAspectRatio": "portrait",
  "enableVisualHook": false,
  "enableCaption": true,
  "captionStyle": "one-line",
  "captionPosition": "auto",
  "enableCaptionAnimation": true,
  "captionAnimation": {
    "name": "pop",
    "highlightColor": "#04f827",
    "bgColor": ""
  },
  "enableHighlight": true,
  "enableEmoji": true,
  "emojiStyle": {
    "pos": null,
    "scaleX": null,
    "scaleY": null,
    "rect": {
      "xPct": 0,
      "yPct": -0.79,
      "wPct": 0.133,
      "hPct": 0.075,
      "type": "CPct"
    }
  },
  "enableUppercase": true,
  "highlightColor": {
    "primary": "#04f827",
    "secondary": "#FFFD03"
  },
  "font": {
    "id": null,
    "type": null,
    "name": null,
    "path": null,
    "size": "Large",
    "numericalSize": 50,
    "color": "#ffffff",
    "style": ["900"],
    "textDecoration": "",
    "family": "Komika-axis",
    "stroke": {
      "enabled": true,
      "color": "#000000FF",
      "width": 16
    },
    "shadow": {
      "enabled": true,
      "color": "#FFFFFFFF",
      "x": 2,
      "y": 2,
      "blur": 16,
      "useWordHighlightColor": false
    }
  },
  "screenOverlay": null,
  "screenOverlayFileId": null,
  "screenOverlays": [
    {
      "object": {
        "id": null,
        "kind": null,
        "name": "overlay/org_G5vEaJsd4310/google-oauth2|106053850538038134310/1731395502191.png",
        "displayName": "test.png",
        "selfLink": null,
        "mediaLink": null,
        "bucket": "ext.gcs.opus.pro",
        "metageneration": null,
        "storageClass": null,
        "md5Hash": null,
        "etag": null,
        "crc32c": null,
        "contentType": null,
        "size": null,
        "updated": null,
        "timeCreated": null,
        "generation": null,
        "timeStorageClassUpdated": null
      },
      "style": null,
      "rect": {
        "xPct": 0.5806182121971597,
        "yPct": 0.6965845864661654,
        "wPct": 0.4193817878028405,
        "hPct": 0.3035714285714285,
        "type": "CPct"
      }
    }
  ],
  "enableBroll": null,
  "enableScreenOverlay": null,
  "disableScreenOverlay": null,
  "enableAutoTransition": true,
  "selectedTransitions": ["crossFade"],
  "enableVoiceEnhancement": null,
  "enableWatermark": false
}

refundStatus

string

The refund status of the project.

Example:

null

importPref

object

Preferences for importing the video, such as source language.

Example:

{ "sourceLang": "en" }

Was this page helpful?

{
  "id": "P1111908HgB1",
  "userId": "google-oauth2|106053850538038134111",
  "orgId": "org_G5vEaJsd4111",
  "isDeleted": false,
  "isPurged": false,
  "projectId": "P1111908HgB0",
  "sourcePlatform": "YOUTUBE",
  "sourceId": "YT_tEXaoozFRes",
  "sourceUri": null,
  "labels": [],
  "productTier": "PRO",
  "stage": "QUEUED",
  "error": null,
  "stallCount": null,
  "workerUrl": null,
  "curationPref": {
    "range": {
      "startSec": 28,
      "endSec": 636
    },
    "clipDurations": [
      [
        0,
        90
      ]
    ],
    "topicKeywords": [
      "OpusClip"
    ],
    "genre": "Auto",
    "skipCurate": false
  },
  "storageSize": 0,
  "storageStatus": "TEMPORARY",
  "storageExpireAt": "2024-12-19T08:17:42.832Z",
  "renderPref": {
    "skipReframe": false,
    "enableSplitLayout": true,
    "enableFitLayout": false,
    "enableFillLayout": false,
    "enableScreenLayout": true,
    "enableThreeLayout": true,
    "enableFourLayout": true,
    "enableGameLayout": null,
    "enableAutoLayout": false,
    "disableFitLayout": false,
    "disableFillLayout": false,
    "fitLayoutCropRatio": "4:3",
    "enableCrop": true,
    "layoutAspectRatio": "portrait",
    "enableVisualHook": false,
    "enableCaption": true,
    "captionStyle": "one-line",
    "captionPosition": "auto",
    "enableCaptionAnimation": true,
    "captionAnimation": {
      "name": "pop",
      "highlightColor": "#04f827",
      "bgColor": ""
    },
    "enableHighlight": true,
    "enableEmoji": true,
    "emojiStyle": {
      "pos": null,
      "scaleX": null,
      "scaleY": null,
      "rect": {
        "xPct": 0,
        "yPct": -0.79,
        "wPct": 0.133,
        "hPct": 0.075,
        "type": "CPct"
      }
    },
    "enableUppercase": true,
    "highlightColor": {
      "primary": "#04f827",
      "secondary": "#FFFD03"
    },
    "font": {
      "id": null,
      "type": null,
      "name": null,
      "path": null,
      "size": "Large",
      "numericalSize": 50,
      "color": "#ffffff",
      "style": [
        "900"
      ],
      "textDecoration": "",
      "family": "Komika-axis",
      "stroke": {
        "enabled": true,
        "color": "#000000FF",
        "width": 16
      },
      "shadow": {
        "enabled": true,
        "color": "#FFFFFFFF",
        "x": 2,
        "y": 2,
        "blur": 16,
        "useWordHighlightColor": false
      }
    },
    "screenOverlay": null,
    "screenOverlayFileId": null,
    "screenOverlays": [
      {
        "object": {
          "id": null,
          "kind": null,
          "name": "overlay/org_G5vEaJsd4310/google-oauth2|106053850538038134310/1731395502191.png",
          "displayName": "test.png",
          "selfLink": null,
          "mediaLink": null,
          "bucket": "ext.gcs.opus.pro",
          "metageneration": null,
          "storageClass": null,
          "md5Hash": null,
          "etag": null,
          "crc32c": null,
          "contentType": null,
          "size": null,
          "updated": null,
          "timeCreated": null,
          "generation": null,
          "timeStorageClassUpdated": null
        },
        "style": null,
        "rect": {
          "xPct": 0.5806182121971597,
          "yPct": 0.6965845864661654,
          "wPct": 0.4193817878028405,
          "hPct": 0.3035714285714285,
          "type": "CPct"
        }
      }
    ],
    "enableBroll": null,
    "enableScreenOverlay": null,
    "disableScreenOverlay": null,
    "enableAutoTransition": true,
    "selectedTransitions": [
      "crossFade"
    ],
    "enableVoiceEnhancement": null,
    "enableWatermark": false
  },
  "refundStatus": null,
  "createdAt": "2024-11-19T08:17:42.832Z",
  "updatedAt": "2024-11-19T08:17:42.860Z",
  "clusterJobId": "FP.P1111908HgB1:20241119081742853.FP",
  "cluster": "gold",
  "importPref": {
    "sourceLang": "en"
  },
  "visibility": "DEFAULT",
  "permissions": [
    "PROJECT_SHARE",
    "PROJECT_EDIT",
    "PROJECT_VIEW"
  ],
  "promptRecommendations": [
    "Foo",
    "Boo"
  ]
}

GET STARTED

ENDPOINTS

PLAYGROUND

Project representation