Skip to navigation
VIDEO ON DEMAND APIManage videos

Get all clips of a media

This endpoint retrieves a list of all media clips associated with a given source media ID. It helps you organize and manage media efficiently by providing metadata such as clip media IDs and other relevant details.

A media clip is a segmented portion of an original media file (source media). Clips are often created for various purposes such as previews, highlights, or customized edits. This API allows you to fetch all such clips linked to a specific source media, making it easier to track and manage clips.

How it works

  • The endpoint returns metadata for all media clips associated with the given mediaId.
  • Results are paginated to efficiently handle large datasets.
  • Each entry includes detailed metadata such as media id, duration, and status.
  • Helps in organizing clips effectively by providing structured information.

Example

Imagine you’re managing a video editing platform where users upload full-length videos and create short clips for social media sharing. To keep track of all clips linked to a particular video, you call this API with the sourceMediaId. The response provides a list of all associated clips, allowing you to manage, edit, or repurpose them as needed.

Related guide: Create clips from existing media

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

mediaIdstringRequiredformat: "uuid"
The unique identifier assigned to the media when created. The value must be a valid UUID.

Query parameters

offsetintegerOptional>=1Defaults to 1
Offset determines the starting point for data retrieval within a paginated list.
limitintegerOptional1-50Defaults to 10
The number of media clips to retrieve per request.
orderByenumOptionalDefaults to desc

The values in the list can be arranged in two ways DESC (Descending) or ASC (Ascending).

Allowed values:

Response

Get media clips
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
datalist of objectsOptional
paginationobjectOptional