OpusClip

https://help.opus.pro/
Admin
OpusClip is the #1 video clipping tool that transforms long videos into short-form content and...
Tokens:180,538
Snippets:1,753
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install Mintlify CLI

Source: https://help.opus.pro/_quickstart

Install the Mintlify CLI globally to preview documentation changes locally.

```bash
npm i -g mintlify
```

--------------------------------

### renderPref object example

Source: https://help.opus.pro/api-reference/schemas/project-representation

Example of the renderPref object with layout and overlay preferences.

```json
{
  "enableSplitLayout": true,  
  "enableFitLayout": false,  
  "enableFillLayout": false,  
  "enableScreenLayout": true,  
  "enableThreeLayout": true,  
  "enableFourLayout": true,  
  "enableAutoLayout": false,  
  "fitLayoutCropRatio": "4:3",  
  "enableCrop": true,  
  "layoutAspectRatio": "portrait"
}
```

--------------------------------

### Install skill in OpenClaw

Source: https://help.opus.pro/api-reference/skill

Install the OpusClip skill plugin in OpenClaw.

```bash
openclaw plugins install clawhub:opusclip-pro

```

--------------------------------

### promptRecommendations field example

Source: https://help.opus.pro/api-reference/schemas/project-representation

Example value for the promptRecommendations field, an array of two strings.

```json
["Foo", "Boo"]
```

--------------------------------

### Generate Upload Link - Response Example

Source: https://help.opus.pro/api-reference/endpoints/upload-video-create-project

Example response containing the upload URL and upload ID.

```json
{
  "url": "https://storage.googleapis.com/ext.gcs.opus.pro/upload/org_000000000/google-upload",
  "uploadId": "abc123xyz456",
  "dnsUrl": "https://api.opus.pro",
  "useAmount": 0,
  "totalAmount": 107974182498
}
```

--------------------------------

### range Example

Source: https://help.opus.pro/api-reference/schemas/curation-preferences

Example of the range object specifying the start and end seconds of the original video to generate clips from.

```json
{ "startSec": 106, "endSec": 204 }
```

--------------------------------

### Word object JSON example

Source: https://help.opus.pro/api-reference/schemas/transcript-export-word

Example of a Word object with a single word, start and end timings, and an optional filler-word flag.

```json
{
  "word": "hello",
  "start": 0.12,
  "end": 0.48,
  "isFillerWord": false
}
```

--------------------------------

### Go example

Source: https://help.opus.pro/api-reference/playground/share-project

Uses net/http to POST the visibility update. Prints the response body.

```go
package main

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

func main() {

	url := "https://api.opus.pro/api/clip-projects/{projectId}/update-visibility"

	payload := strings.NewReader("{\n  \"visibility\": \"PUBLIC\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### Install skill in Claude.ai Web and Claude Cowork

Source: https://help.opus.pro/api-reference/skill

Clone the repository and create a zip file for uploading to Claude.ai Web or Claude Cowork.

```bash
git clone https://github.com/opus-pro/opus-skills.git

```

```bash
cd skills && zip -r opusclip-skill.zip opusclip

```

--------------------------------

### 200 response example for get brand templates

Source: https://help.opus.pro/api-reference/playground/get-brand-templates

Example response returned by the /api/brand-templates endpoint, showing a brand template with its preferences and font settings.

```json
[
  {
    "templateId": "cm32g2poc0002t5bnhmg2kfyx",
    "name": "Karaoke Template",
    "isDefault": true,
    "preferences": {
      "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"
      }
    },
    "type": "PresetOverwrite"
  }
]
```

--------------------------------

### Response Example for GET Social Copy Job

Source: https://help.opus.pro/api-reference/endpoints/social-posting/get-social-copy-job

Example 200 response showing the job data including status, title, description, and hashtags.

```json
{
  "data": {
    "jobId": "96e3d68c-49ef-4c19-b3b6-595f9564537c",
    "status": "COMPLETED",
    "cached": false,
    "title": "My Daughter's 'Gift' at 3 AM",
    "description": "Thought I was losing my mind. Hear walking at 3 AM, check the house - everyone's asleep. Then I see it... my daughter's 'gift' moved. My wife has some explaining to do!",
    "hashtags": "#ParentingFails #CreepyKids #MomLife #FunnyParenting #WhatDidISignUpFor"
  }
}
```

--------------------------------

### Create a New Project - Basic Usage (curl)

Source: https://help.opus.pro/api-reference/quickstart

Creates a new clip project with minimal preferences by sending a POST request to the /api/clip-projects endpoint. Requires the videoUrl and an API key in the Authorization header. Use this basic example when you only need to provide a video URL.

```shell
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"
}'

```

--------------------------------

### Go example for creating collection content

Source: https://help.opus.pro/api-reference/endpoints/collection-contents/create-collection-content

Uses net/http to send a POST request with a JSON payload. Prints the response body.

```go
package main

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

func main() {

	url := "https://api.opus.pro/api/collection-contents"

	payload := strings.NewReader("{\n  \"collectionId\": \"xmAwhhFi0IJt\",\n  \"contentId\": \"P0000000demo.CUexample2\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### 200 Response for GET /api/social-accounts

Source: https://help.opus.pro/api-reference/endpoints/social-posting/get-social-accounts

Example successful response containing a list of social accounts with platform details.

```json
{
  "data": [
    {
      "postAccountId": "postAccountId_xxx1",
      "subAccountId": "subAccountId_xxx1",
      "platform": "FACEBOOK_PAGE",
      "extUserId": "extUserId_xxx",
      "extUserName": "Page Name",
      "extUserPictureLink": "https://example.com/avatar.png",
      "extUserProfileLink": "https://www.facebook.com/page_id"
    },
    {
      "postAccountId": "postAccountId_xxx2",
      "platform": "TIKTOK_BUSINESS",
      "extUserId": "extUserId_xxx",
      "extUserName": "tiktok_account",
      "extUserPictureLink": "https://example.com/avatar.jpeg",
      "extUserProfileLink": "https://www.tiktok.com/@username"
    }
  ]
}
```

--------------------------------

### curl example with query parameters

Source: https://help.opus.pro/api-reference/endpoints/get-clips

Example curl command to retrieve exportable clips by project ID, using query parameters and headers. Replace API_KEY, PROJECT_ID, and ORG_ID with your actual values.

```Shell
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>'
```

--------------------------------

### 200 response example for GET /api/transcripts

Source: https://help.opus.pro/api-reference/endpoints/transcripts/get-transcript

Example 200 response body for the transcripts endpoint. Contains a data array with transcript segments, each including id, start/end times, text, word-level details, and speaker label.

```json
{
  "data": [
    [
      {
        "id": 0,
        "start": 0,
        "end": 10.5,
        "text": "Hello and welcome to the show.",
        "words": [
          {
            "word": "hello",
            "start": 0.12,
            "end": 0.48,
            "isFillerWord": false
          }
        ],
        "speaker": "SPEAKER_00"
      }
    ]
  ]
}
```

--------------------------------

### 200 Response: Get generative job

Source: https://help.opus.pro/api-reference/endpoints/generative-jobs/get-generative-job

Example successful response showing the job status, result, progress, and error fields.

```json
{
  "status": "QUEUED",
  "result": {
    "generatedThumbnailUris": [
      "<string>"
    ]
  },
  "progress": {
    "status": "QUEUED",
    "percentage": 0.5
  },
  "error": {
    "type": "<string>",
    "message": "<string>"
  }
}
```

--------------------------------

### Initiate Resumable Upload Session - Example Response Headers

Source: https://help.opus.pro/api-reference/endpoints/upload-video-create-project

Example response headers showing the `location` header containing the resumable upload URL.

```http
HTTP/2 201
x-goog-resumable-upload-id: AAkIAwy-YC6V...
location: https://storage.googleapis.com/ext.gcs.opus.pro/upload/org_000000000/google-upload

```

--------------------------------

### Create a clip project with the Karaoke preset brand template

Source: https://help.opus.pro/api-reference/endpoints/create-project

Use this cURL command to create a clip project with the 'Karaoke' preset brand template. Replace `API_KEY` with your actual API key. The request posts to the `/clip-projects` endpoint with the video URL and brand template ID.

```bash
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"
  }'
```

--------------------------------

### Get source-video transcript with cURL, Python, JavaScript, PHP, Go, Java, Ruby

Source: https://help.opus.pro/api-reference/endpoints/transcripts/get-transcript

Send a GET request to the transcripts endpoint using the Authorization header with a bearer token. The response is printed or logged. Each example uses the same endpoint and authentication method.

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

```python
import requests

url = "https://api.opus.pro/api/transcripts"

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

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

print(response.text)
```

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

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

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opus.pro/api/transcripts",
  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;
}
```

```go
package main

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

func main() {

	url := "https://api.opus.pro/api/transcripts"

	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))

}
```

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

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.opus.pro/api/transcripts")

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
```

--------------------------------

### Example preferences Object

Source: https://help.opus.pro/api-reference/playground/get-brand-templates

Shows the structure of the preferences object returned in the response. Contains layout, font, and highlight color settings.

```json
{  
  "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"  
  }  
}
```

--------------------------------

### JavaScript GET Social Copy Job

Source: https://help.opus.pro/api-reference/endpoints/social-posting/get-social-copy-job

Use this JavaScript fetch example to retrieve a social copy job. Replace <token> with your bearer token.

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

fetch('https://api.opus.pro/api/social-copy-jobs/{jobId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Sample response for GET /api/exportable-clips

Source: https://help.opus.pro/api-reference/endpoints/get-clips

Example JSON response containing an array of exportable clip objects with fields like id, title, text, renderPref, and URIs for preview and export.

```json
[
  {
    "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"
  }
]
```

--------------------------------

### Install skill in Codex (CLI and App)

Source: https://help.opus.pro/api-reference/skill

Add the OpusClip skill marketplace in Codex.

```bash
codex plugin marketplace add opus-pro/opus-skills

```

--------------------------------

### enableAutoHook Example

Source: https://help.opus.pro/api-reference/schemas/curation-preferences

Example of the enableAutoHook boolean value, which is false by default.

```json
false
```

--------------------------------

### Complete Render Preferences JSON Example

Source: https://help.opus.pro/api-reference/schemas/render-preferences

A complete JSON object showing all render preference options with their default or example values.

```json
{
  "enableAutoLayout": false,
  "enableScreenLayout": true,
  "enableCrop": true,
  "enableCaption": true,
  "enableUppercase": true,
  "enableHighlight": true,
  "enableEmoji": true,
  "enableFillLayout": false,
  "enableSplitLayout": true,
  "enableThreeLayout": true,
  "enableFourLayout": true,
  "enableFitLayout": false,
  "fitLayoutCropRatio": "4:3",
  "enableVisualHook": false,
  "enableWatermark": false,
  "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": "#ff0000",
    "secondary": "#00ff00"
  },
  "layoutAspectRatio": "portrait",
  "enableBroll": false
}
```

--------------------------------

### Create clip project with source language

Source: https://help.opus.pro/api-reference/endpoints/create-project

Creates a clip project by posting a video URL and import preferences to the Opus API. Replace API_KEY with your actual API key and set sourceLang to the desired language code.

```bash
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",
  "uploadedVideoAttr": {
    "title": "AI Agents: The Future of Work?"
  },
  "importPreference": {
    "sourceLang": "de"
  }
}'
```

```bash
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",
  "uploadedVideoAttr": {
    "title": "AI Agents: The Future of Work?"
  },
  "importPreference": {
    "sourceLang": "de"
  }
}'
```

--------------------------------

### Run Mintlify dev server

Source: https://help.opus.pro/_quickstart

Run the Mintlify development server at the root of your documentation where mint.json is located.

```bash
mintlify dev
```

--------------------------------

### labels field example

Source: https://help.opus.pro/api-reference/schemas/project-representation

Example value for the labels field, an empty array.

```json
[]
```

--------------------------------

### Python requests example

Source: https://help.opus.pro/api-reference/playground/share-project

Uses the requests library to POST the visibility update. Prints the response text.

```python
import requests

url = "https://api.opus.pro/api/clip-projects/{projectId}/update-visibility"

payload = { "visibility": "PUBLIC" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

--------------------------------

### Create Clip Project - cURL Example

Source: https://help.opus.pro/api-reference/endpoints/upload-video-create-project

cURL command to create a clip project. Replace `<API_KEY>` with your API key and `<uploadId>` with the ID returned in Step 1.

```bash
curl --request POST \
  --url https://api.opus.pro/api/clip-projects \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <API_KEY>' \
  --data '{
    "videoUrl": "<uploadId>",
    "conclusionActions": [
      {
        "type": "EMAIL",
        "notifyFailure": true,
        "email": "opusclip@opus.pro"
      }
    ],
    "curationPref": {
      "range": {
        "startSec": 28,
        "endSec": 636
      },
      "clipDurations": [
        [
          0,
          90
        ]
      ],
      "topicKeywords": [
        "OpusClip"
      ],
      "genre": "Auto",
      "skipCurate": false
    },
    "importPref": {
      "sourceLang": "auto"
    },
    "brandTemplateId": "preset-fancy-Karaoke"
  }'

```

--------------------------------

### type Field Example

Source: https://help.opus.pro/api-reference/schemas/brand-template-representation

Example of the type field. Specifies the template type as PresetOverwrite.

```json
{
  "type": "PresetOverwrite"
}
```
Tokens:
Raw