Get Clips

cURL

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

import requests

url = "https://api.opus.pro/api/exportable-clips"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.opus.pro/api/exportable-clips', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opus.pro/api/exportable-clips",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.opus.pro/api/exportable-clips"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.opus.pro/api/exportable-clips")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opus.pro/api/exportable-clips")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "P0000000demo.CUexample1",
    "projectId": "P0000000demo",
    "runId": "20241113071229217.FP",
    "curationId": "CUexample1",
    "orgId": "org_Example00000001",
    "userId": "google-oauth2|100000000000000000001",
    "storageUsed": 15537888,
    "durationMs": 19478,
    "title": "Connect Through Passion: The Power of Ensemble Performance",
    "text": "Clip text content",
    "createdAt": "2024-11-13T07:18:22.811Z",
    "updatedAt": "2024-11-13T07:18:22.811Z",
    "productTier": "PRO",
    "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"
      }
    },
    "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",
    "timeRanges": [
      [
        192170,
        211630
      ]
    ],
    "keywords": [
      "Q&A"
    ],
    "promptName": "Q&A",
    "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",
    "genre": "Auto",
    "subgenre": "general",
    "clipCopilotTaskId": "taskid"
  }
]

GET

api

exportable-clips

cURL

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

import requests

url = "https://api.opus.pro/api/exportable-clips"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.opus.pro/api/exportable-clips', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opus.pro/api/exportable-clips",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.opus.pro/api/exportable-clips"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.opus.pro/api/exportable-clips")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opus.pro/api/exportable-clips")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "P0000000demo.CUexample1",
    "projectId": "P0000000demo",
    "runId": "20241113071229217.FP",
    "curationId": "CUexample1",
    "orgId": "org_Example00000001",
    "userId": "google-oauth2|100000000000000000001",
    "storageUsed": 15537888,
    "durationMs": 19478,
    "title": "Connect Through Passion: The Power of Ensemble Performance",
    "text": "Clip text content",
    "createdAt": "2024-11-13T07:18:22.811Z",
    "updatedAt": "2024-11-13T07:18:22.811Z",
    "productTier": "PRO",
    "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"
      }
    },
    "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",
    "timeRanges": [
      [
        192170,
        211630
      ]
    ],
    "keywords": [
      "Q&A"
    ],
    "promptName": "Q&A",
    "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",
    "genre": "Auto",
    "subgenre": "general",
    "clipCopilotTaskId": "taskid"
  }
]

Introduction

The GET /api/exportable-clips endpoint returns a list of clips that are available for use in your projects. Each clip is associated with a unique ID that you can use to reference it in your project.

Request Parameters

q (required): Query type, must be one of findByProjectId findByCollectionId.
projectId (required when q=findByProjectId): The unique identifier of the project.
collectionId (required when q=findByCollectionId): The unique identifier of the collection.

Example

curl --request GET \
  --url 'https://api.opus.pro/api/exportable-clips?q=findByProjectId&projectId=<PROJECT_ID>' \
  --header 'Authorization: <API_KEY>' \
  --header 'x-opus-org-id: <ORG_ID>'

Ensure you replace API_KEY, PROJECT_ID, and ORG_ID with your actual values.

Playground

Generate Code Snippet

Use this code generator to easily create code snippets.

Response Schema

API Response Schema

For more details of response, please refer to the API response schema.

Authorizations

Authorization

string

header

required

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

Headers

x-opus-org-id

string

Organization ID. Required for users with multiple organizations.

Example:

"org_Example00000001"

Query Parameters

enum<string>

required

Query type

Available options:

findByCollectionId,

findByProjectId

Example:

"findByProjectId"

projectId

string

Project ID, required when q=findByProjectId

Example:

"P0000000demo"

collectionId

string

Collection ID, required when q=findByCollectionId

Example:

"xmAwhhFi0IJt"

pageNum

number

Page Num, started with 1

Example:

1

pageSize

number

Page Size

Example:

10

Response

200 - application/json

Successfully retrieved exportable clips

string

required

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

Example:

"P0000000demo.CUexample1"

projectId

string

required

Project ID

Example:

"P0000000demo"

runId

string

required

Run ID

Example:

"20241113071229217.FP"

curationId

string

required

Curation ID

Example:

"CUexample1"

orgId

string

required

Organization ID

Example:

"org_Example00000001"

userId

string

required

User ID

Example:

"google-oauth2|100000000000000000001"

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:

"PRO"

renderPref

object

required

Render preference

Show child attributes

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_Example00000001/google-oauth2|100000000000000000001/P0000000demo/c.CUexample1/esd.mp4?v=1731482302577650"

uriForExport

string

Google Cloud Storage URI of video for export/download

Example:

"https://ext.cdn.opus.pro/media/org_Example00000001/google-oauth2|100000000000000000001/P0000000demo/c.CUexample1/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"

Get Brand Templates Create a Censor Job

Getting started

Endpoints

Playground

Introduction

Request Parameters

Example

Playground

Generate Code Snippet

Response Schema

API Response Schema

Authorizations

Headers

Query Parameters

Response

​Introduction

​Request Parameters

​Example

​Playground

Generate Code Snippet

​Response Schema

API Response Schema

Authorizations

Headers

Query Parameters

Response

Introduction

Request Parameters

Example

Playground

Response Schema