Create Draft Clip

Creates a draft of a video clip by identifying:

• An asset in your library.
• The clip's starting and stopping point.

Convert drafts to video clips from within the Clipping tool.

Request

Request syntax:

POST /clipping_draft

Request body:

Define a draft video clip through the following properties:

Identifying a Video Segment

Define a clip's starting and stopping point by passing any of the following combination of properties:

You must specify one of the above property combinations. Do not specify additional time properties. For example, if you define start and stop, do not include start_time, stop_time, or duration in the request.

Use the following syntax to specify a timestamp (ISO 8601 - seconds; UTC):

Syntax:

YYYY-MM-DDThh:mm:ssZ

Example:

2023-01-08T20:31:11Z

Response

The response for a successful request contains the following properties:

Sample Request/Response

Call the create_draft_clip module (Python 3) to create a draft of a video clip. This module imports names from the api_auth module.

import json
import requests
from api_auth import APICredentials, APIParams

class CreateDraftClip:
    def __init__(self):
        self.host = "services.uplynk.com"

    def run(self):
        """
        Create a draft of a video clip.
        """
        self._create_draft()

    def _create_draft(self):
        url = "{}{}".format(self.host, "/api/v4/clipping_draft")

        start_milliseconds = 55000 # how far into the asset should the clip start
        stop_seconds = 10 # how long after the start point should the clip stop
        payload = {
            'beam':'0123456789abcdefghijklmnopqrstuv',
            'title':'My Clip',
            'start': start_milliseconds,
            'duration': stop_seconds,
        }

        headers = {'Content-Type': 'application/json'}

        response = requests.post(
            url, params=APIParams(APICredentials()).get_params({}), data=json.dumps(payload), headers=headers
        )

        print(response.json())

CreateDraftClip().run()

Response:

{
	"@id": "/api/v4/clipping_draft/abc0123def456ghi789klmno0123pqrs",
	"@type": "ClippingDraft",
	"id": "abc0123def456ghi789klmno0123pqrs"
}