Sign in

v1

latestOpenAPI 3.0.02026-07-26213850.5 KB
ExportableClip
exportable-clips
enterprise

get/api/exportable-clips

Query parameters

q'findByCollectionId' | 'findByProjectId' required
Example:findByProjectId

Query type

projectIdstring
Example:P0000000demo

Project ID, required when q=findByProjectId

collectionIdstring
Example:xmAwhhFi0IJt

Collection ID, required when q=findByCollectionId

pageNumnumber
Example:1

Page Num, started with 1

pageSizenumber
Example:10

Page Size

Headers

x-opus-org-idstring
Example:org_Example00000001

Organization ID. Required for users with multiple organizations.

Response

Successfully retrieved exportable clips

idstring required

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

projectIdstring required

Project ID

runIdstring required

Run ID

curationIdstring required

Curation ID

orgIdstring required

Organization ID

userIdstring required

User ID

uriForPreviewstring

Google Cloud Storage URI of video for preview

uriForExportstring

Google Cloud Storage URI of video for export/download

storageUsednumber required

Storage used in bytes

durationMsnumber required

Duration in milliseconds

keywordsstring[]

Keywords of this clip

promptNamestring

Prompt name

titlestring required

Title of the clip

descriptionstring

Description of the clip

hashtagsstring

Hashtags for the clip

textstring required

Text content of the clip

genrestring

Genre of the clip

subgenrestring

Subgenre of the clip

createdAtstring required

Creation date

updatedAtstring required

Last update date

clipCopilotTaskIdstring

Clip copilot task ID

productTierstring required

Product tier

Example response

[
  {
    "id": "P0000000demo.CUexample1",
    "projectId": "P0000000demo",
    "runId": "20241113071229217.FP",
    "curationId": "CUexample1",
    "orgId": "org_Example00000001",
    "userId": "google-oauth2|100000000000000000001",
    "uriForPreview": "https://ext.cdn.opus.pro/media/org_Example00000001/google-oauth2|100000000000000000001/P0000000demo/c.CUexample1/esd.mp4?v=1731482302577650",
    "uriForExport": "https://ext.cdn.opus.pro/media/org_Example00000001/google-oauth2|100000000000000000001/P0000000demo/c.CUexample1/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": "PRO",
    "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"
      }
    }
  }
]