Skip to main content
GET
cURL
👆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.

Headers

x-opus-org-id
string

Organization ID. Required for users with multiple organizations.

Example:

"org_Example00000001"

Query Parameters

q
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

id
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

Example:
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:
keywords
string[]

Keywords of this clip

Example:
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"