Live2VOD for Organization

Make a clip for all VODs

Starts a job to create a clip for all VODs for the channel identified in the request.

post/v2/{org}/channels/{channel-id}/clips

Request

  • Base URL: https://api.istreamplanet.com
  • URL: https://api.istreamplanet.com/v2/{org}/channels/{channel-id}/clips
  • Auth: authcode (defined in the document in a form this page cannot read) and m2m (defined in the document in a form this page cannot read)

Path parameters

orgstring required

Organization name

channel-idstring required

Unique channel identifier

Request body

$schemastring uri

A URL to the JSON Schema for this object.

correlation_idstring

Identifer that is carried through archive and collapse notifications for the clip creation

create_mp4boolean

If true, creates the mp4. Default: false

descriptionstring

Description of the clip being created

endstring required

End timestamp in RFC3339Nano format

mp4_file_pathstring

If set, overrides the mp4 file path for archiving.

overwriteboolean

Overwrite existing clip. Default: false

startstring required

Start timestamp in RFC3339Nano format

Example request

{
  "$schema": "https://api.istreamplanet.com/schemas/PostClipRequest.json",
  "end": "2006-01-02T15:04:05.9999Z",
  "start": "2006-01-02T15:04:05.9999Z"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

correlation_idstring

Identifer that is carried through archive and collapse notifications for the clip creation

task_idsstring[] nullable required

Identifies clipping tasks, each task producing N VodItems

Example response

{
  "$schema": "https://api.istreamplanet.com/schemas/PostClipResponseBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.