### Preview changes Source: https://help.opus.pro/_quickstart Install the Mintlify CLI to preview the documentation changes locally. ```bash npm i -g mintlify ``` ```bash mintlify dev ``` -------------------------------- ### Install OpusClip Skill for Claude.ai Web / Claude Cowork Source: https://help.opus.pro/api-reference/agent-setup Clone the repository, zip the skill, and upload it via the OpusClip dashboard. ```bash git clone https://github.com/opus-pro/opus-skills.git cd skills && zip -r opusclip-skill.zip opusclip ``` -------------------------------- ### Install OpusClip Skill for Codex Source: https://help.opus.pro/api-reference/agent-setup Add the OpusClip skill from the marketplace for Codex. ```bash codex plugin marketplace add https://github.com/opus-pro/opus-skills ``` -------------------------------- ### ClipBasic Example Source: https://help.opus.pro/api-reference/endpoints/create-project Example of creating a project with ClipBasic curation preferences. ```bash curl --request POST \ --url https://api.opus.pro/api/clip-projects \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ \ "videoUrl": "https://www.youtube.com/watch?v=tEXaoozFRes", \ "uploadedVideoAttr": { \ "title": "AI Agents: The Future of Work?" \ }, \ "curationPref": { \ "model":"ClipBasic", \ "clipDurations": [ \ [ \ 0, \ 180 \ ] \ ], \ "genre": "Auto", \ "topicKeywords": [ \ "OpusClip" \ ], \ "range": { \ "startSec": 105, \ "endSec": 300 \ } \ } \ }' ``` -------------------------------- ### Install OpusClip Skill for other hosts with npx skills Source: https://help.opus.pro/api-reference/agent-setup Add the OpusClip skill using npx skills. ```bash npx skills add opus-pro/opus-skills ``` -------------------------------- ### ClipAnything Example Source: https://help.opus.pro/api-reference/endpoints/create-project Example of creating a project with ClipAnything curation preferences. ```bash curl --request POST \ --url https://api.opus.pro/api/clip-projects \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ \ "videoUrl": "https://www.youtube.com/watch?v=tEXaoozFRes", \ "uploadedVideoAttr": { \ "title": "AI Agents: The Future of Work?" \ }, \ "curationPref": { \ "model":"ClipAnything", \ "clipDurations": [ \ [ \ 0, \ 90 \ ] \ ], \ "genre": "Auto", \ "customPrompt": "OpusClip", \ "range": { \ "startSec": 105, \ "endSec": 300 \ } \ } \ }' ``` -------------------------------- ### Get Clips API Request Example Source: https://help.opus.pro/api-reference/endpoints/get-clips Example of how to make a GET request to the /api/exportable-clips endpoint to retrieve clips for a specific project. ```bash curl --request GET \ --url 'https://api.opus.pro/api/exportable-clips?q=findByProjectId&projectId=' \ --header 'Authorization: ' \ --header 'x-opus-org-id: ' ``` -------------------------------- ### Basic Usage Source: https://help.opus.pro/api-reference/quickstart This code snippet demonstrates the basic usage of the Create a New Project endpoint, providing only the required videoUrl. ```bash curl --request POST \ --url https://api.opus.pro/api/clip-projects \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "videoUrl": "https://www.youtube.com/watch?v=tEXaoozFRes" }' ``` -------------------------------- ### Get Brand Templates Example Source: https://help.opus.pro/api-reference/endpoints/get-brand-templates This example shows how to retrieve a list of brand templates available for your organization using curl. ```bash curl --request GET \ --url 'https://api.opus.pro/api/brand-templates?q=mine' \ --header 'Authorization: ' ``` -------------------------------- ### Install OpusClip Skill for OpenClaw Source: https://help.opus.pro/api-reference/agent-setup Install the OpusClip skill using OpenClaw. ```bash openclaw plugins install clawhub:opusclip-pro ``` -------------------------------- ### Create Clip Project - cURL Example Source: https://help.opus.pro/api-reference/endpoints/upload-video-create-project cURL example for creating a clip project. ```bash curl --request POST \ --url https://api.opus.pro/api/clip-projects \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ' \ --data '{ \ "videoUrl": "", \ "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" \ }' ``` -------------------------------- ### OpenAPI Specification Example Source: https://help.opus.pro/api-reference/playground/get-clips An example snippet from the OpenAPI specification detailing the structure for shadow properties and security schemes. ```yaml OpenAPI example: 2 blur: type: number description: The blur radius of the shadow. example: 16 useWordHighlightColor: type: boolean description: Indicates if the word highlight color should be used for the shadow. example: false required: - enabled - color - x - 'y' - blur securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ``` -------------------------------- ### Advanced Usage Source: https://help.opus.pro/api-reference/quickstart This code snippet demonstrates advanced usage of the Create a New Project endpoint, including customization of brand templates, curation preferences, import preferences, and conclusion actions. ```bash curl --request POST \ --url https://api.opus.pro/api/clip-projects \ --header 'Authorization: Bearer ' \ --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" } ] }' ``` -------------------------------- ### Start local development server Source: https://help.opus.pro/_development Run the mintlify dev command in the docs directory to start the local development server. ```bash mintlify dev ``` -------------------------------- ### Get Clips Source: https://help.opus.pro/api-reference/quickstart This code snippet shows how to use the Get Clips endpoint to retrieve exportable clips for a given project ID. ```bash curl --request GET \ --url 'https://api.opus.pro/api/exportable-clips?q=findByProjectId&projectId={projectId}' \ --header 'Authorization: Bearer ' \ --header 'x-opus-org-id: ' ``` -------------------------------- ### Share a Project Source: https://help.opus.pro/api-reference/quickstart This code snippet demonstrates how to use the Share a Project endpoint to update the visibility of a project. ```bash curl --request POST \ --url https://api.opus.pro/api/clip-projects//update-visibility \ --header 'Authorization: ' \ --header 'Content-Type: application/json' \ --data '{ "visibility": "PUBLIC" }' ``` -------------------------------- ### OpenAPI Specification for Social Copy Job Source: https://help.opus.pro/api-reference/endpoints/social-posting/get-social-copy-job This OpenAPI specification details the GET /api/social-copy-jobs/{jobId} endpoint, including its parameters, responses, and example output. ```yaml openapi: 3.0.0 info: title: Clip API description: Clip API documentation version: '1.0' contact: {} servers: - url: https://api.opus.pro description: OpusClip Open API Production Server security: [] tags: [] paths: /api/social-copy-jobs/{jobId}: get: tags: - social-posting - enterprise description: >- Get the current status and generated copy for a social copy generation job. operationId: SocialCopyJobController_getSocialCopyJob parameters: - name: jobId required: true in: path description: Unique ID of the social copy generation job schema: type: string responses: '200': description: Successfully retrieved the social copy generation result content: application/json: example: 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 schema: type: object required: - data properties: data: type: object required: - jobId - status properties: jobId: type: string description: Unique ID of the social copy generation job status: type: string enum: - RUNNING - COMPLETED - FAILED description: Status of the social copy generation job cached: type: boolean description: Whether the result came from cache title: type: string description: Generated title description: type: string description: Generated description hashtags: type: string description: Generated hashtags security: - bearer: [] components: securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ```