Quickstart

Step 1: Get API Key

Get your API Key from the dashboard and include it in your request.

Step 2: Customize Brand Template

Follow below steps to customize the appearance of your clips by brand template:

Customizing Brand Templates

For a high level of customization, you can create and manage your brand templates.

Using Preset Brand Templates

Not familiar with it? No worries, we provide popular templates for your convenience.

Step 3: Create a New Project

Use the Create a New Project endpoint.Provide the videoUrl and API_KEY, then run the following command to create a new project with minimal preferences:

curl --request POST \
--url https://api.opus.pro/api/clip-projects \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "videoUrl": "https://www.youtube.com/watch?v=tEXaoozFRes"
}'

curl --request POST \
--url https://api.opus.pro/api/clip-projects \
--header 'Authorization: Bearer <API_KEY>' \
    --header 'Content-Type: application/json' \
    --data '{
        "videoUrl": "https://www.youtube.com/watch?v=tEXaoozFRes",
        "brandTemplateId": "preset-fancy-Karaoke",
        "curationPref": {
          "range": {
            "startSec": 28,
            "endSec": 636
          },
          "clipDurations": [
            [0, 180]
          ],
          "topicKeywords": [
            "OpusClip"
          ],
          "skipCurate": false,
          "genre": "Auto"
        },
        "importPref": {
          "sourceLang": "en"
        },
        "conclusionActions": [
          {
              "type": "WEBHOOK",
              "notifyFailure": true,
              "url": "https://webhook.site/#!/view/d3ba169d-f9eb-4c78-a229-771eab9d6e67"
          },
          {
              "type": "EMAIL",
              "notifyFailure": false,
              "email": "opusclip@opus.pro"
          }
        ]
    }'

You can customize the project creation request by providing additional preferences:

Switch to the advanced usage tab above to see an example with all preferences.

Step 4: Get Clips

Use the Get Clips endpoint. Provide the Project ID returned from the project creation response.

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

Step 5: Share the Project

Use the Share a Project endpoint to share the project you just created with others.

curl --request POST \
--url https://api.opus.pro/api/clip-projects/<PROJECT_ID>/update-visibility \
--header 'Authorization: <API_KEY>' \
    --header 'Content-Type: application/json' \
    --data '{
        "visibility": "PUBLIC"
    }'

Getting started

Endpoints

Playground

Steps to Get Started

Customizing Brand Templates

Using Preset Brand Templates

Using the Playground

​Steps to Get Started

Customizing Brand Templates

Using Preset Brand Templates

​Using the Playground

Steps to Get Started

Using the Playground