API Reference
Login

Create media from URL

post
https://api.fastpix.io/v1/on-demand

This endpoint allows developers or users to create a new video or audio media in FastPix using a publicly accessible URL. FastPix fetches the media from the provided URL, processes it, and stores it on the platform for use.

Public URL requirement:

The provided URL must be publicly accessible and must point to a video stored in one of the following supported formats: .m4v, .ogv, .mpeg, .mov, .3gp, .f4v, .rm, .ts, .wtv, .avi, .mp4, .wmv, .webm, .mts, .vob, .mxf, asf, m2ts

Supported storage types:

The URL can originate from various cloud storage services or content delivery networks (CDNs) such as:

  • Amazon S3: URLs from Amazon's Simple Storage Service.

  • Google Cloud Storage: URLs from Google Cloud's storage solution.

  • Azure Blob Storage: URLs from Microsoft's Azure storage.

  • Public CDNs: URLs from public content delivery networks that host video files.

Upon successful creation, the API returns an id that must be retained for future operations related to this media.

How it works

  1. Send a POST request to this endpoint with the media URL (typically a video or audio file) and optional media settings.

  2. FastPix uploads the video from the provided URL to its storage.

  3. Receive a response containing the unique id for the newly created media item.

  4. Use the id in subsequent API calls, such as checking the status of the media with the Get Media by ID endpoint to determine when the media is ready for playback.

FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, after the media file is created (but not yet processed or encoded), FastPix sends a POST request to your specified webhook URL with the event video.media.created.

After processing completes, monitor the events video.media.ready and video.media.failed to track the status of the media file.

Related guide: Upload videos from URL

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for uploading a video media from URL

inputs
array
required
Defaults to [object Object]

Add one input object at a time. For example, first add a VideoInput object. If you also need a watermark, click Add item again and select WatermarkInput. Repeat this process for AudioInput or SubtitleInput as needed. For a complete explanation of how media uploads from URL and processing work, refer to the
FastPix Video on Demand Overview.

inputs*
string
required
Defaults to video

Defines the type of input.

string
required
Defaults to https://static.fastpix.io/fp-sample-video.mp4

The URL hosts the media file for FastPix, which needs to be downloaded to use further. It supports formats like MP3, MP4, MOV, MKV, or TS, and includes text tracks for subtitles or closed captions (SRT/VTT files). The URL must be valid, publicly accessible, and downloadable to ensure FastPix can fetch the file successfully.

While FastPix can handle various audio and video formats and codecs, using standard and widely supported formats helps achieve optimal processing speed.

integer

Start time indicates where encoding must begin within the video file. For example, if you want to encode a segment from 3 minutes (180 seconds) to 6 minutes (360 seconds) in a 10-minute (600 seconds) video, the start time is 3 minutes (180 seconds). Note: Start time is always mentioned in seconds.

integer

End time indicates where encoding must end within the video file. For example, if you want to encode a segment from 3 minutes (180 seconds) to 6 minutes (360 seconds) in a 10-minute (600 seconds) video, the end time is 6 minutes (360 seconds). Note: End time is always mentioned in seconds.

string

The URL of the intro video to be added at the beginning of the media file.
The URL must be valid, publicly accessible, and downloadable so that FastPix can fetch the file successfully.
Supported video formats include MP4, MOV, MKV, and TS for optimal processing performance.

string

The URL of the outro video to be added at the end of the media file.
The URL must be valid, publicly accessible, and downloadable so that FastPix can retrieve the file successfully.
Supported video formats include MP4, MOV, MKV, and TS for best compatibility and processing speed.

expungeSegments
array of strings

The list of start and end times (in seconds) of the segments to be removed from the actual video.

expungeSegments
segments
array of objects

A list of media segments to be added or processed. Each segment includes details such as the URL of the media file and instructions on where it should be inserted in the final media composition. A segment can either specify an exact timestamp (insertAt) or indicate that it must be added at the end (insertAtEnd).

segments
metadata
object

You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.

uuid

UUID of the DRM configuration to be used

string
length ≤ 255

Title of the media file.

string
length ≤ 255

The unique identifier of the user who created this media.

subtitles
object

Generates subtitle files for audio/video files.

string
enum
required
Defaults to public

Determines whether access to the streamed content is kept private or available to all.

Allowed:
string
enum

"capped_4k": Generates an mp4 video file up to 4k resolution "audioOnly": Generates an m4a audio file of the media file "audioOnly,capped_4k": Generates both video and audio media files for offline viewing

Allowed:
boolean

The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it

boolean

normalize volume of the audio track. This is available for pre-recorded content only.

string
enum
Defaults to 1080p

The maximum resolution tier defines the highest quality at which your media is available.

Allowed:
string
enum
Defaults to standard

The quality tier applied to the media.

Allowed:
summary
object
boolean

Enable or disable the chapters feature for the media. Set to true to enable chapters or false to disable.

boolean

Enable or disable named entity extraction. Set to true to enable or false to disable.

moderation
object
accessRestrictions
object
Responses

Updated 5 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago