VOD quickstart

The FastPix Video API lets you build and stream videos that fit your workflow and design. You can customize videos for specific users and use cases. With streamlined setup and integration, developers can build modern video interactions and experiences for any stack, any app, at any scale, anywhere - with a faster time to market.

Start using FastPix

Quickly get started with streaming videos; upload and playback videos in your application with FastPix video APIs.

Sign up with FastPix

To get started, create a FastPix account. You must sign up to get the API access token and access to the dashboard.

Get an API access token from the dashboard

After signing up, all you need now is to generate your API access token. FastPix Video API uses a token key-pair comprising a Access Token ID and Secret Key for authentication. Navigate to your Settings and create a new Access Token in the Access Token settings within your dashboard.

Access Tokens play a crucial role in FastPix, allowing you to securely interact with the platform. After you click Generate new token, a pop-up appears with input fields to create your new Access Token.

Understanding workspace
Workspaces act as parent containers for Access Tokens, Signing Keys, and other elements in FastPix. When you create an Access Token, it is associated with a specific Workspace. The Access Tokens are created for the workspace you are in (i.e, the workspace selected in the top-right corner of your dashboard).

Access token permissions
Access Tokens come with different permissions, regulating the actions and extent of modifications they can perform. As you follow this guide, ensure that your Access Token has both FastPix Video Read and Write permissions. This ensures that you can read existing videos and upload new ones seamlessly.

To keep track of your Access Tokens within your application or project, you can assign them any name, like “Test”. This helps in managing and identifying them easily.

When you’re ready, proceed by clicking the ‘Generate access token’ button. This creates a new Access Token ID and Secret Key for you.

With your newly generated Access Token ID and Secret Key, you’re now set to upload your first video to FastPix. Remember, proper management of your Access Tokens is crucial for the smooth operation of your application.

IMPORTANT

To keep the Access Token information (Secret Key) for future use, download an workspace file (.env) that stores these details. FastPix doesn’t store the exact Secret Key.

It's important to note that FastPix only stores a secret hash, not the Secret Key itself. If the Secret Key is lost, FastPix cannot retrieve it, necessitating the creation of a new Access Token. Also, make sure to keep your Secret Key safe and avoid exposing it, which might cause a security breach on your account.

Upload a video

To upload a video to FastPix, you need to follow these steps:

a. Identify the video : Every video that you store in FastPix is called a Media.

b. Create a Media: To create your first media, send a POST request to the /on-demand API endpoint, where the input value must be the URL of a video file that is accessible online.

c. Use a demo video link: For your convenience, we’ve provided a demo video link that you can use to send the request. FastPix retrieves the video from the provided URL and store it as a media asset.

https://static.fastpix.io/fp-sample-video.mp4

By using this link, you can easily familiarize yourself with the process of creating a media in FastPix. Once you’re comfortable with the process, you can start uploading your own videos and expanding your media library.

In the following curl command, replace ACCESS_TOKEN_ID and SECRET_KEY with the Access Token ID and Secret Key values from the .env file you downloaded.

curl -X POST "https://api.fastpix.io/v1/on-demand" \
  -u ACCESS_TOKEN_ID:SECRET_KEY \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": [
      {
        "type": "video",
        "url": "https://static.fastpix.io/fp-sample-video.mp4"
      }
    ],
    "accessPolicy": "public"
  }'

The response contains unique identifiers like a Media ID and a Playback ID.

1. Media IDs are essential for media management on api.fastpix.io/v1. For instance, you can use them to read or delete specific media files.
2. Playback IDs are used to deliver media content to a video player through stream.fastpix.io. You can link multiple playback IDs to a single media file to create streaming or playback URLs with different access permissions. Additionally, you can also delete playback IDs to revoke viewing rights without the need to erase the actual media file.

{
  "success": true,
  "data": {
    "id": "4ee2ec6a-7426-4501-8051-277ea1eb4014",
    "trial": true,
    "status": "Created",
    "createdAt": "2025-10-30T09:46:32.098964Z",
    "updatedAt": "2025-10-30T09:46:32.098967Z",
    "playbackIds": [
      {
        "id": "fe142e1f-c9c6-4098-b350-1bdf97b9b332",
        "accessPolicy": "public",
        "accessRestrictions": {
          "domains": {
            "defaultPolicy": "allow",
            "allow": [],
            "deny": []
          },
          "userAgents": {
            "defaultPolicy": "allow",
            "allow": [],
            "deny": []
          }
        }
      }
    ],
    "sourceAccess": false,
    "maxResolution": "1080p",
    "inputs": [
      {
        "type": "video",
        "url": "https://static.fastpix.io/fp-sample-video.mp4"
      }
    ],
    "subtitles": {},
    "optimizeAudio": false
  }
}

NOTE

FastPix does not store the original video file in it's exact form. Therefore, if preserving your original high-quality files is crucial, refrain from deleting them after uploading to FastPix.

Check for status: ready

After initiating thePOST request, FastPix initiates the download and processing of the video content. This operation is generally completed within seconds for smaller-sized files, but larger files or slower internet connections might extend this duration to several minutes.

Once the video is fully processed and ready for playback, the media status changes to "ready". It is essential to wait until this status update before attempting to play the video.

For timely updates on media status changes, the best way is through webhooks. FastPix can send over a webhook notification as soon as the asset is ready. (Refer to the webhooks guide for more details.)

Watch your video

To initialize playback of the media, you can insert the playbackId received from the API response or from the dashboard in the stream URL below.

https://stream.fastpix.io/{PLAYBACK_ID}.m3u8

You can use this URL (with .m3u8 extension) in other video players as per your use case.

To directly stream your video on a browser, you can also use the playback stream URL which is sharable. Simply preview your video by adding the playbackId to the stream URL.

 https://play.fastpix.io/?playbackId=d983edb7-c672-4474-8e41-adc8d4d83b05

FastPix Player integration with HTML

You can integrate uploaded videos in FastPix Player which is built-in with video data tracking to enhance your application’s media experience.

<script src="https://cdn.jsdelivr.net/npm/@fastpix/fp-player@<fp-player-version>/dist/player.js"></script>  
 
<fastpix-player  
    playback-id="{PLAYBACK_ID}"  
</fastpix-player> 

In the HTML snippet replace <fp-player-version> with the version of the player to activate the player functionality.

Refer to the player guide for more details on integrating with the FastPix video player. You can further customize your player interface and video playback experience as per your requirements.

After you have successfully implemented the integration, connect FastPix Video Data with your player to monitor playback performance.

Manage your media

Upload and playback of your video is just one part of geting started. To build video effectively into your product, you need other functionalities. After you have already added media files into your FastPix workspace, the following endpoints would come in handy:

• Create media from URL API
• Get list of all media API
• Get a media by ID API
• Update a media by ID API
• Delete a media by ID API
• Get info of media inputs API
• Create a playback I API
• Delete a playback ID API
• Upload media from device API