Get Clips

GET

api

exportable-clips

curl --request GET \
  --url https://api.opus.pro/api/exportable-clips \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "Q1111307CTmI.CU67da38",
    "projectId": "Q1111307CTmI",
    "runId": "20241113071229217.FP",
    "curationId": "CU67da38",
    "orgId": "org_G5vEaJsd4111",
    "userId": "google-oauth2|106053850538038134300",
    "uriForPreview": "https://ext.cdn.opus.pro/media/org_G5vEaJsd4111/google-oauth2|106053850538038134000/Q1111307CTmI/c.CU67da38/esd.mp4?v=1731482302577650",
    "uriForExport": "https://ext.cdn.opus.pro/media/org_G5vEaJsd4111/google-oauth2|106053850538038134000/Q1111307CTmI/c.CU67da38/ehd.mp4?v=1731482302564330",
    "storageUsed": 15537888,
    "durationMs": 19478,
    "timeRanges": [
      [
        192170,
        211630
      ]
    ],
    "keywords": [
      "Q&A"
    ],
    "promptName": "Q&A",
    "title": "Connect Through Passion: The Power of Ensemble Performance",
    "description": "Experience the magic of live performance as our talented cellist captivates the audience with her passionate playing. Witness the seamless coordination of the ensemble in a breathtaking display of musical artistry that will leave you inspired!",
    "hashtags": "#ClassicalMusic #CelloPerformance #EnsembleMusic #LiveConcert #MusicPassion #CoordinatedPerformance #MusicalArtistry #Cellist #AudienceEngagement #StageMagic",
    "text": "Clip text content",
    "genre": "Auto",
    "subgenre": "general",
    "createdAt": "2024-11-13T07:18:22.811Z",
    "updatedAt": "2024-11-13T07:18:22.811Z",
    "clipCopilotTaskId": "taskid",
    "productTier": "PAID.CAT",
    "renderPref": {
      "enableAutoLayout": false,
      "enableFillLayout": false,
      "enableFitLayout": false,
      "fitLayoutCropRatio": "4:3",
      "enableSplitLayout": true,
      "enableThreeLayout": true,
      "enableFourLayout": true,
      "enableScreenLayout": true,
      "enableVisualHook": false,
      "enableWatermark": false,
      "enableCrop": true,
      "enableCaption": true,
      "enableUppercase": true,
      "enableHighlight": true,
      "enableEmoji": true,
      "font": {
        "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
        }
      },
      "highlightColor": {
        "primary": "#04f827",
        "secondary": "#FFFD03"
      }
    }
  }
]

👆Use above tools to generate API request code snippets.

Authorizations

Authorization

string

header

required

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

Query Parameters

enum<string>

required

Query type

Available options:

findByProjectId

projectId

string

required

Project ID

Response

200 - application/json

Successfully retrieved exportable clips

string

required

Full clip id. Format: {project_id}.{curation_id}

Example:

"Q1111307CTmI.CU67da38"

projectId

string

required

Project ID

Example:

"Q1111307CTmI"

runId

string

required

Run ID

Example:

"20241113071229217.FP"

curationId

string

required

Curation ID

Example:

"CU67da38"

orgId

string

required

Organization ID

Example:

"org_G5vEaJsd4111"

userId

string

required

User ID

Example:

"google-oauth2|106053850538038134300"

storageUsed

number

required

Storage used in bytes

Example:

15537888

durationMs

number

required

Duration in milliseconds

Example:

19478

title

string

required

Title of the clip

Example:

"Connect Through Passion: The Power of Ensemble Performance"

text

string

required

Text content of the clip

Example:

"Clip text content"

createdAt

string

required

Creation date

Example:

"2024-11-13T07:18:22.811Z"

updatedAt

string

required

Last update date

Example:

"2024-11-13T07:18:22.811Z"

productTier

string

required

Product tier

Example:

"PAID.CAT"

renderPref

object

required

Render preference

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>

Specifies the layout aspect ratio.

Available options:

portrait,

landscape,

square

renderPref.enableBroll

boolean

default:false

Enables B-Roll overlay on the video.

Example:

false

Example:

{
  "enableAutoLayout": false,
  "enableFillLayout": false,
  "enableFitLayout": false,
  "fitLayoutCropRatio": "4:3",
  "enableSplitLayout": true,
  "enableThreeLayout": true,
  "enableFourLayout": true,
  "enableScreenLayout": true,
  "enableVisualHook": false,
  "enableWatermark": false,
  "enableCrop": true,
  "enableCaption": true,
  "enableUppercase": true,
  "enableHighlight": true,
  "enableEmoji": true,
  "font": {
    "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
    }
  },
  "highlightColor": {
    "primary": "#04f827",
    "secondary": "#FFFD03"
  }
}

uriForPreview

string

Google Cloud Storage URI of video for preview

Example:

"https://ext.cdn.opus.pro/media/org_G5vEaJsd4111/google-oauth2|106053850538038134000/Q1111307CTmI/c.CU67da38/esd.mp4?v=1731482302577650"

uriForExport

string

Google Cloud Storage URI of video for export/download

Example:

"https://ext.cdn.opus.pro/media/org_G5vEaJsd4111/google-oauth2|106053850538038134000/Q1111307CTmI/c.CU67da38/ehd.mp4?v=1731482302564330"

timeRanges

array

Original time ranges of the clip (in seconds)

Example:

[[192170, 211630]]

keywords

string[]

Keywords of this clip

Example:

["Q&A"]

promptName

string

Prompt name

Example:

"Q&A"

description

string

Description of the clip

Example:

"Experience the magic of live performance as our talented cellist captivates the audience with her passionate playing. Witness the seamless coordination of the ensemble in a breathtaking display of musical artistry that will leave you inspired!"

hashtags

string

Hashtags for the clip

Example:

"#ClassicalMusic #CelloPerformance #EnsembleMusic #LiveConcert #MusicPassion #CoordinatedPerformance #MusicalArtistry #Cellist #AudienceEngagement #StageMagic"

genre

string

Genre of the clip

Example:

"Auto"

subgenre

string

Subgenre of the clip

Example:

"general"

clipCopilotTaskId

string

Clip copilot task ID

Example:

"taskid"

Was this page helpful?

Create a New Project Get Brand Templates

curl --request GET \
  --url https://api.opus.pro/api/exportable-clips \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "Q1111307CTmI.CU67da38",
    "projectId": "Q1111307CTmI",
    "runId": "20241113071229217.FP",
    "curationId": "CU67da38",
    "orgId": "org_G5vEaJsd4111",
    "userId": "google-oauth2|106053850538038134300",
    "uriForPreview": "https://ext.cdn.opus.pro/media/org_G5vEaJsd4111/google-oauth2|106053850538038134000/Q1111307CTmI/c.CU67da38/esd.mp4?v=1731482302577650",
    "uriForExport": "https://ext.cdn.opus.pro/media/org_G5vEaJsd4111/google-oauth2|106053850538038134000/Q1111307CTmI/c.CU67da38/ehd.mp4?v=1731482302564330",
    "storageUsed": 15537888,
    "durationMs": 19478,
    "timeRanges": [
      [
        192170,
        211630
      ]
    ],
    "keywords": [
      "Q&A"
    ],
    "promptName": "Q&A",
    "title": "Connect Through Passion: The Power of Ensemble Performance",
    "description": "Experience the magic of live performance as our talented cellist captivates the audience with her passionate playing. Witness the seamless coordination of the ensemble in a breathtaking display of musical artistry that will leave you inspired!",
    "hashtags": "#ClassicalMusic #CelloPerformance #EnsembleMusic #LiveConcert #MusicPassion #CoordinatedPerformance #MusicalArtistry #Cellist #AudienceEngagement #StageMagic",
    "text": "Clip text content",
    "genre": "Auto",
    "subgenre": "general",
    "createdAt": "2024-11-13T07:18:22.811Z",
    "updatedAt": "2024-11-13T07:18:22.811Z",
    "clipCopilotTaskId": "taskid",
    "productTier": "PAID.CAT",
    "renderPref": {
      "enableAutoLayout": false,
      "enableFillLayout": false,
      "enableFitLayout": false,
      "fitLayoutCropRatio": "4:3",
      "enableSplitLayout": true,
      "enableThreeLayout": true,
      "enableFourLayout": true,
      "enableScreenLayout": true,
      "enableVisualHook": false,
      "enableWatermark": false,
      "enableCrop": true,
      "enableCaption": true,
      "enableUppercase": true,
      "enableHighlight": true,
      "enableEmoji": true,
      "font": {
        "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
        }
      },
      "highlightColor": {
        "primary": "#04f827",
        "secondary": "#FFFD03"
      }
    }
  }
]

GET STARTED

ENDPOINTS

PLAYGROUND

Authorizations

Query Parameters

Response