Create media from URL | FastPix Developer Documentation

curl -X POST https://api.fastpix.com/v1/on-demand \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "inputs": [
    {
      "type": "video",
      "url": "https://static.fastpix.com/fp-sample-video.mp4"
    }
  ],
  "accessPolicy": "public",
  "metadata": {
    "key1": "value1"
  },
  "maxResolution": "1080p",
  "mediaQuality": "standard"
}'

{
  "success": true,
  "data": {
    "id": "a1d1acdd-8f4e-4add-b498-6b398cf349d9",
    "trial": true,
    "status": "Created",
    "createdAt": "2023-10-20T10:50:34.594302Z",
    "updatedAt": "2023-10-20T10:50:34.594302Z",
    "playbackIds": [
      {
        "id": "6ta85f64-5717-4562-b3fc-2c963f66afa6",
        "accessPolicy": "public",
        "accessRestrictions": {
          "domains": {
            "defaultPolicy": "allow",
            "allow": [
              "string"
            ],
            "deny": [
              "string"
            ]
          },
          "userAgents": {
            "defaultPolicy": "allow",
            "allow": [
              "string"
            ],
            "deny": [
              "string"
            ]
          }
        }
      }
    ],
    "metadata": {
      "key1": "value1"
    },
    "mediaQuality": "standard",
    "sourceAccess": false,
    "maxResolution": "1080p",
    "inputs": [
      {
        "type": "video",
        "url": "https://static.fastpix.com/fp-sample-video.mp4"
      }
    ],
    "optimizeAudio": false
  }
}

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

Send a POST request to this endpoint with the media URL (typically a video or audio file) and optional media settings.
FastPix uploads the video from the provided URL to its storage.
Receive a response containing the unique id for the newly created media item.
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

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

Request

Request body for uploading a video media from URL

inputslist of objectsRequired

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.

accessPolicyenumRequiredDefaults to public

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

Allowed values:

metadatamap from strings to stringsOptional

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.

drmConfigurationIdstringOptionalformat: "uuid"

UUID of the DRM configuration to be used

titlestringOptional<=255 characters

Title of the media file.

creatorIdstringOptional<=255 characters

The unique identifier of the user who created this media.

subtitlesobjectOptional

Generates subtitle files for audio/video files.

mp4SupportenumOptional

“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 values:

sourceAccessbooleanOptional

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

optimizeAudiobooleanOptional

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

maxResolutionenumOptionalDefaults to 1080p

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

Allowed values:

mediaQualityenumOptionalDefaults to standard

The quality tier applied to the media.

Allowed values:

summaryobjectOptional

chaptersbooleanOptional

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

namedEntitiesbooleanOptional

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

moderationobjectOptional

accessRestrictionsobjectOptional

Response

Media is created successfully

successbooleanOptional

Shows the request status. Returns true for success and false for failure.

dataobjectOptional