# FastPix

FastPix is the only API that brings everything video, data & AI together for developers to build next-gen video products. The full stack to realize VOD and live streaming in your product vision. Build great video & AI experiences, improve performance, expand into new markets and engage customers. FastPix APIs are simple enough for easy implementation and powerful enough to scale as fast and as far as you need.

## New to FastPix
- [Welcome](https://docs.fastpix.io/docs/overview-1): Introduction to FastPix's video streaming capabilities and features.  
- [Activate account](https://docs.fastpix.io/docs/activate-account): Guide to creating a FastPix account and obtaining authentication credentials.  
- [Set up workspace​](https://docs.fastpix.io/docs/workspace): Get familiar with creating orgs, workspaces, teams, and user roles to use FastPix fully.  
- [Language SDKs](https://docs.fastpix.io/docs/sdks): Information on integrating FastPix using Python and Node.js SDKs.  
- [Setup webhooks](https://docs.fastpix.io/docs/webhooks-for-status): Steps to configure webhooks for receiving real-time event notifications from FastPix.  
- [Webhooks collection](https://docs.fastpix.io/docs/webhooks-collection): Overview of available webhook events for media and live streaming operations.  
- [Media events](https://docs.fastpix.io/docs/media-events): Details on webhook events related to media processing and status changes.  
- [Live events](https://docs.fastpix.io/docs/live-events): Information on webhook events specific to live streaming sessions.  
- [In-video AI events](https://docs.fastpix.io/docs/ai-events): Descriptions of AI-generated events within videos, such as scene detection and content analysis.


## Video on Demand
- [Get started](https://docs.fastpix.io/docs/video-on-demand-overview): Introduction to FastPix's Video on Demand features and capabilities.
- [VOD quickstart](https://docs.fastpix.io/docs/get-started-in-5-minutes): FastPix’s video API allows you to build and stream video per your workflow and design.

### Input and playback
- [Upload videos directly](https://docs.fastpix.io/docs/upload-videos-directly): Instructions for uploading videos directly from your device to FastPix. (Push method)
- [Upload videos from URL](https://docs.fastpix.io/docs/upload-videos-from-url): Guide to uploading videos to FastPix using a direct URL. (Pull method)
- [Upload 4K videos](https://docs.fastpix.io/docs/upload-4k-videos): Steps for uploading and processing 4K resolution videos on FastPix.
- [Resumable uploads SDK for web](https://docs.fastpix.io/docs/resumable-uploads-sdk-for-web): Overview of the SDK enabling resumable video uploads via web applications.
- [Upload SDK for Android](https://docs.fastpix.io/docs/upload-sdk-for-android): The FastPix Android Resumable Uploads SDK helps you efficiently upload large files from the browser by splitting them into chunks and also gives you the ability to pause and resume your uploads.
- [Upload SDK for iOS](https://docs.fastpix.io/docs/upload-sdk-for-ios): The FastPix iOS Upload SDK helps you to upload videos from your iOS app to the FastPix platform.
- [Upload SDK for Flutter](https://docs.fastpix.io/docs/upload-sdk-for-flutter): Upload large media files directly to FastPix from a Flutter app with resumable upload capabilities.
- [Play your videos](https://docs.fastpix.io/docs/play-your-videos): This guide walks you through everything you need to start playing your videos - whether you're building a web app, integrating into a mobile SDK, or need a direct HLS URL.
- [Embed your video](https://docs.fastpix.io/docs/embed-your-video):After uploading a video to FastPix, you can either embed it directly with a ready-to-use player or stream it using your own custom player. This guide walks you through both options.
- [Create and manage playlist](https://docs.fastpix.io/docs/create-and-manage-playlist): Group media assets around a common theme, project, or workflow. 

### Secure your playback
- [Secure playback with signed URLs](https://docs.fastpix.io/docs/secure-playback-with-signed-urls): FastPix Player offers powerful token-based authentication to ensure secure access to your media assets, whether you’re dealing with on-demand or live streams. 
- [Secure playback with JWTs](https://docs.fastpix.io/docs/secure-playback-with-jwts):JSON Web Tokens (JWTs) are a standardized method for securely transmitting authentication and authorization data between systems. 
- [Secure playback with DRM](https://docs.fastpix.io/docs/secure-playback-with-drm): Digital Rights Management (DRM) is an essential security feature for video content streamed via FastPix.

### Transform (Basics)
- [Add metadata to videos](https://docs.fastpix.io/docs/add-metadata-to-videos): In FastPix, metadata is custom information you can attach to any on-demand video.  
- [Add watermark to videos](https://docs.fastpix.io/docs/watermark-your-videos): Instructions for adding watermarks to videos to protect content.
- [Create thumbnails from video](https://docs.fastpix.io/docs/extract-thumbnails-and-images-from-video): Guide to extracting thumbnail images from video files.
- [Create GIFs from videos](https://docs.fastpix.io/docs/create-gifs-form-videos): Steps to generate GIFs from video content for sharing and engagement.
- [Create clips from existing media](https://docs.fastpix.io/docs/create-clips-from-existing-media): Instructions for creating shorter clips from existing video files.
- [Add timeline hovers](https://docs.fastpix.io/docs/add-timeline-hovers-using-spritesheet): Guide to implementing timeline hover previews using spritesheets.
- [Add own subtitle tracks](https://docs.fastpix.io/docs/manage-subtitle-tracks): Instructions for adding and managing custom subtitle tracks in videos.
- [Add own audio tracks](https://docs.fastpix.io/docs/manage-audio-tracks): Guide to adding and managing custom audio tracks in video content.

### Transform (Advanced)
- [Optimize audio loudness](https://docs.fastpix.io/docs/optimize-the-loudness-of-audio): Adjusts audio levels to ensure consistent and optimal loudness across your video content. 
- [Add auto-generated subtitles](https://docs.fastpix.io/docs/add-auto-generated-subtitles-to-videos): Automatically generates subtitles for videos using speech recognition. 
- [Add intro and outro](https://docs.fastpix.io/docs/add-intro-and-outro-to-your-base-video): Appends introductory and concluding segments to your main video content. 
- [Remove unwanted parts](https://docs.fastpix.io/docs/remove-unwanted-content-from-video): Enables trimming or removing specific sections from your video. 
- [Replace existing audio](https://docs.fastpix.io/docs/replace-existing-audio-with-new-audio): Allows substitution of the original audio track with a new one. 
- [Overlay audio at specific timeline](https://docs.fastpix.io/docs/overlay-audio-at-specific-timeline-in-your-video): Adds additional audio tracks at designated timestamps within the video. 
- [Use MP4 support for offline viewing](https://docs.fastpix.io/docs/mp4-support-for-offline-viewing): Provides MP4 format support to facilitate offline video playback. 
- [Stitch multiple videos into one](https://docs.fastpix.io/docs/stitch-multiple-videos-into-one): Combine multiple video files into a single continuous video using FastPix’s stitching API.
- [Enable DRM protection](https://docs.fastpix.io/docs/enable-drm-protection): Digital Rights Management (DRM) is an essential security feature for video content streamed via FastPix. 

### Transform (In-video AI)
- [Moderate NSFW & Profanity](https://docs.fastpix.io/docs/using-nsfw-and-profanity-filter-for-video-moderation): Detects and flags inappropriate content, such as NSFW material and profanity, to maintain a safe viewing environment.  
- [Categorize into named entities](https://docs.fastpix.io/docs/generate-named-entities): Utilizes natural language processing to identify and tag entities like names, places, and organizations within video transcripts.  
- [Generate video chapters](https://docs.fastpix.io/docs/generate-video-chapters): Automatically creates navigable chapters in videos, enhancing viewer experience by allowing easy access to specific sections.  
- [Generate video summary](https://docs.fastpix.io/docs/generate-video-summary): Produces concise summaries of video content, enabling quick understanding of key points without watching the entire video.   


## Live Streaming
- [Get started](https://docs.fastpix.io/docs/live-stream-overview): Introduction to FastPix's live streaming capabilities and setup process. 
- [Live stream quickstart](https://docs.fastpix.io/docs/how-to-livestream): The FastPix Live Streaming API simplifies adding live video streaming to your application or product.

### Input & Stream
- [How to live stream](https://docs.fastpix.io/docs/how-to-livestream): Step-by-step guide to initiating a live stream using FastPix. 
- [Streaming with RTMPS](https://docs.fastpix.io/docs/get-started-with-live-streaming): Instructions for setting up live streaming using the RTMPS protocol with FastPix. 
- [Streaming with SRT](https://docs.fastpix.io/docs/using-srt-to-live-stream): Guide to configuring live streaming using the Secure Reliable Transport (SRT) protocol for low-latency and secure broadcasts. 
- [Broadcast using OBS](https://docs.fastpix.io/docs/using-obs): Steps to integrate and broadcast live streams using OBS Studio with FastPix. 

### Manage
- [Manage streams](https://docs.fastpix.io/docs/manage-streams): Overview of tools and features for monitoring and controlling live streams on FastPix. 
- [Handling disconnects](https://docs.fastpix.io/docs/live-stream-disconnects): Strategies and FastPix features to manage unexpected stream interruptions and ensure continuity. 
- [Webhooks in live stream](https://docs.fastpix.io/docs/what-are-webhooks-in-live-streaming): Explanation of how to use webhooks to receive real-time updates and automate responses during live streaming sessions.  

### Transform
- [Add metadata to livestream](https://docs.fastpix.io/docs/add-metadata-to-livestreams): FastPix lets you attach metadata to any livestream at the time of creation. This metadata can be used to label the stream, organize dashboards, or trigger automations in your systems. 
- [Instant live clipping](https://docs.fastpix.io/docs/instant-live-clipping): Enables real-time creation of video clips during live streaming sessions. 
- [Simulcast to 3rd party platforms](https://docs.fastpix.io/docs/simulcast-to-3rd-party-platforms): Allows simultaneous broadcasting of live streams to multiple external platforms. 
- [Stream pre-recorded live](https://docs.fastpix.io/docs/stream-pre-recorded-live): Facilitates streaming of pre-recorded videos as live broadcasts. 
- [Stream recordings of live streams](https://docs.fastpix.io/docs/stream-recordings-of-live-streams): Provides options to stream previously recorded live sessions. 
- [DVR-like time shifting in live stream](https://docs.fastpix.io/docs/live-time-shifting-like-dvr): Live time-shifting, also known as DVR (Digital Video Recorder) mode, allows viewers to interact dynamically with live streams by enabling features like pausing, rewinding, and fast-forwarding.


## Video Data
- [Overview](https://docs.fastpix.io/docs/video-data-overview): Introduction to FastPix's video data analytics capabilities and features. 
- [Understand dashboard UI](https://docs.fastpix.io/docs/understand-dashboard-ui): Once playback events and metrics are collected and processed into data, video performance can be visualized across our four major dashboard screens. When using the bottom-up approach, data can be consumed from these dashboards in sequence.
- [Use passable dimensions](https://docs.fastpix.io/docs/user-passable-metadata-1):User Passable Dimensions (metadata) refers to the customizable data fields that users can provide during the initialization of a video playback session.
- [Use custom dimensions](https://docs.fastpix.io/docs/custom-business-metadata): Custom dimensions (metadata) in FastPix allows you to extend beyond the predefined dimensions already available on the platform.  
- [Troubleshoot errors](https://docs.fastpix.io/docs/track-playback-errors): For video platforms, performance is crucial for user retention and maintaining a positive brand image. 

### Install SDKs
- [Install SDKs](https://docs.fastpix.io/docs/install-video-data-sdk): Instructions for integrating FastPix's SDKs to collect and analyze video playback data. 
- [Monitor Shaka player (Web)](https://docs.fastpix.io/docs/monitor-shaka-player): Guidance on integrating FastPix Data SDK with Shaka Player to track viewer engagement and playback quality.  
- [Monitor HLS.js (Web)](https://docs.fastpix.io/docs/monitor-hlsjs): Steps to integrate FastPix Data SDK with HLS.js for monitoring streaming performance and user interactions.  
- [Exo player (Android)](https://docs.fastpix.io/docs/exo-player-android): Instructions for integrating FastPix Data SDK with ExoPlayer on Android to collect playback analytics. 
- [AV player (iOS)](https://docs.fastpix.io/docs/av-player-ios): Documentation for integrating FastPix Data SDK with AVPlayer on iOS devices. 
- [Monitor AndroidX Media3](https://docs.fastpix.io/docs/monitor-androidx-media3): FastPix Data SDK for AndroidX Media3 (latest version of ExoPlayer) helps you track key video metrics like user interactions, playback quality, and performance to enhance the viewing experience.
- [Monitor Video.js (Web)](https://docs.fastpix.io/docs/monitor-videojs): The FastPix Data SDK for Video.js monitors and analyzes key Video.js player metrics, providing actionable insights to optimize video streaming performance and deliver a smoother viewing experience.
- [Monitor DASH.js (Web)](https://docs.fastpix.io/docs/monitor-dashjs): FastPix Video Data SDK for dash.js helps you track and analyze video playback metrics in real time. It gives you clear insights to improve performance, reduce errors, and deliver a smooth viewing experience. 

### Understand Data Definitions
- [Audience metrics](https://docs.fastpix.io/docs/audience-metrics): Metrics that provide insights into viewer behavior, including watch time, unique viewers, and engagement patterns. 
- [Quality of experience (QoE) metrics](https://docs.fastpix.io/docs/quality-of-experience-qoe-metrics): Metrics that assess the viewer's experience, focusing on factors like buffering, playback failures, and video quality. 
- [Playback metrics](https://docs.fastpix.io/docs/playback-metrics): Data related to video playback performance, including start times, buffering events, and playback errors. 
- [Video startup metrics](https://docs.fastpix.io/docs/video-startup-metrics): Metrics that measure the time taken for a video to start playing after the viewer initiates playback. 
- [Stability metrics](https://docs.fastpix.io/docs/stability-metrics): Metrics that assess the reliability of video playback by measuring interruptions during streaming. A higher Stability Score indicates fewer disruptions, leading to a smoother viewing experience, while a lower score reflects increased interruptions.  
- [Render quality metrics](https://docs.fastpix.io/docs/render-quality-metrics): Metrics that evaluate the visual quality of video playback, including resolution and frame rate consistency. 



## Video player

### Getting started  
- [Overview and features](https://docs.fastpix.io/docs/overview-and-features): Highlights key capabilities of the FastPix Player including ease of setup, customization, and cross-platform compatibility.  
- [Installation process](https://docs.fastpix.io/docs/installation-process): Step-by-step guide for installing and embedding the player into your application.  
- [Playback uploaded videos](https://docs.fastpix.io/docs/playback-uploaded-videos): Shows how to play videos using playback IDs for seamless streaming.  
- [Integrate video data with player](https://docs.fastpix.io/docs/integrate-video-data-with-player): Instructions to connect video analytics with the player for in-depth insights.  
- [Error handling](https://docs.fastpix.io/docs/error-handling): Guides on identifying and resolving playback errors effectively.

### HLS streams for playback  
- [Get an HLS stream URL](https://docs.fastpix.io/docs/get-an-hls-stream-url): Explains how to generate an HLS URL for direct video playback.  
- [Playback in HLS player](https://docs.fastpix.io/docs/playback-in-hls-player): Details steps for using HLS-compatible players to stream content.

### Responsiveness and UI adaptation  
- [Overview](https://docs.fastpix.io/docs/overview-2): Introduction to responsive behavior and UI customization in the player.  
- [Practical examples for player UI](https://docs.fastpix.io/docs/practical-examples-for-player-ui): Real-world configurations to adapt the player UI for various screen sizes.

### Customizing player interface  
- [Color attributes](https://docs.fastpix.io/docs/color-attributes): Customize player elements with brand colors.  
- [Aspect ratio](https://docs.fastpix.io/docs/aspect-ratio): Set and manage player aspect ratios for different layouts.  
- [Show or hide player controls](https://docs.fastpix.io/docs/show-or-hide-player-controls): Control visibility of UI elements dynamically.  
- [Customize control sections](https://docs.fastpix.io/docs/customize-control-sections): Modify which controls appear and where.  
- [Change controls backdrop color](https://docs.fastpix.io/docs/change-controls-backdrop-color): Update the background style of control bars.  
- [Display title on video](https://docs.fastpix.io/docs/display-title-on-video): Overlay titles directly on videos for better context.

### Customize video playback experience  
- [Autoplay, loop, muted playback](https://docs.fastpix.io/docs/autoplay-loop-muted-playback): Enable or disable autoplay, loop, and muted playback behavior.  
- [Control playback speed](https://docs.fastpix.io/docs/control-playback-speed): Set playback speed options and controls for users.  
- [Personalize volume preference](https://docs.fastpix.io/docs/personalize-volume-preference): Retain and apply user volume settings across sessions.  
- [Customizing playback resolution](https://docs.fastpix.io/docs/customizing-playback-resolution): Define available resolution settings for playback.  
- [Setting playback start point](https://docs.fastpix.io/docs/setting-playback-start-point): Start playback from a custom timestamp.  
- [Optimize seek functionality](https://docs.fastpix.io/docs/optimize-seek-functionality): Enhance seek experience with fast and smooth jumping.  
- [Switch subtitles and audio tracks](https://docs.fastpix.io/docs/subtitle-switching-and-multi-track-audio): Allow switching between multiple subtitle and audio tracks.  
- [Timeline hover previews](https://docs.fastpix.io/docs/timeline-hover-previews): Show preview thumbnails while hovering over the video timeline.  
- [Adding Chapters in video timeline](https://docs.fastpix.io/docs/adding-chapters-in-video-timeline): Define chapter markers within the video for easy navigation.

### Advanced player operations  
- [Keyboard shortcuts for player](https://docs.fastpix.io/docs/keyboard-shortcuts-for-player): Use keyboard controls to enhance video interaction.  
- [Setting preview thumbnail](https://docs.fastpix.io/docs/setting-preview-thumbnail): Define custom thumbnail images for video previews.  
- [Video preload and crossorigin](https://docs.fastpix.io/docs/video-preload-and-crossorigin): Configure preload behavior and cross-origin settings.  
- [Use custom domain in player](https://docs.fastpix.io/docs/use-custom-domain-in-player): Brand your player with a custom domain URL.  
- [Protect videos with private streams](https://docs.fastpix.io/docs/playback-signed-url-streams): Secure playback using signed URLs for private access.  
- [Enable lazy loading in player](https://docs.fastpix.io/docs/enable-lazy-loading-in-player): Improve page performance by deferring player load.  
- [Listening video events in player](https://docs.fastpix.io/docs/listening-video-events-in-player): Monitor player events for custom integrations and analytics.

## Resources  
- [Usage and billing](https://docs.fastpix.io/docs/account): Learn how to track usage, billing cycles, and manage account settings.
- [Secured playback with JWTs](https://docs.fastpix.io/docs/secured-playback-with-jwts): JSON Web Tokens (JWTs) are a standardized method for securely transmitting authentication and authorization data between systems. 

### Batch migration to FastPix  
- [Batch migration to FastPix](https://docs.fastpix.io/docs/batch-migration-to-fastpix): Overview of migrating multiple videos in bulk to FastPix.  
- [Migrate from Cloudflare Stream](https://docs.fastpix.io/docs/migrate-from-cloudflare-stream): Step-by-step guide to move from Cloudflare Stream.  
- [Migrate from AWS](https://docs.fastpix.io/docs/migrate-from-aws-to-fastpix): Instructions to migrate media assets from AWS.  
- [Migrate from Mux](https://docs.fastpix.io/docs/migrate-from-mux-to-fastpix): Migrate videos and metadata from Mux.  
- [Migrate from api.video](https://docs.fastpix.io/docs/migrate-from-apivideo-to-fastpix): Move content from api.video to FastPix.  
- [Migrate from Vimeo](https://docs.fastpix.io/docs/migrate-from-vimeo-to-fastpix): Transfer your videos from Vimeo to FastPix.  
- [Webhooks for migration status](https://docs.fastpix.io/docs/webhooks-to-listen-to-migration-status): Get real-time updates on migration progress using webhooks.


## API references

### System API
- [Create a signing key](https://docs.fastpix.io/reference/create_signing_key): This endpoint allows you to create a new signing key pair for FastPix. When you call this endpoint, the API generates a 2048-bit RSA key pair. The privateKey will be returned in the response, encoded in Base64 format, and you will receive a unique key id to reference the key in future operations. FastPix will securely store the public key to validate signed tokens.
- [Get list of signing key](https://docs.fastpix.io/reference/list_signing_keys): This endpoint returns a list of all the signing keys associated with an organization in FastPix. Each key entry in the response includes metadata such as the key id, creation date, and workspace details. This helps you manage multiple keys, track their usage, and identify which keys are valid for signing API requests.
- [Delete a signing key](https://docs.fastpix.io/reference/delete_signing_key): This endpoint allows you to delete an existing signing key, and the action is permanent. Once a key is deleted, any signatures or tokens generated using that key will immediately become invalid. This means you can no longer use the key to sign JSON Web Tokens (JWTs) or authenticate API requests.
- [Get signing key by ID](https://docs.fastpix.io/reference/get-signing_key_by_id): This endpoint allows you to retrieve detailed information about a specific signing key using its unique key id. While the private key is not returned for security reasons, you'll be able to see the key's creation date, status, and other associated metadata. This endpoint also returns the workspaceId and publicKey in the response.


### Video on demand API

#### Input video
- [Create media from URL](https://docs.fastpix.io/reference/create-media): This endpoint allows developers or users to create a new video or audio media in FastPix using a publicly accessible URL. FastPix will fetch the media from the provided URL, process it, and store it on the platform for use.
- [Upload media from device](https://docs.fastpix.io/reference/direct-upload-video-media): This endpoint enables you to upload a video file directly from your local device to FastPix for processing, storage. When you invoke this API with your preferred media settings, the response returns an uploadId and a pre-signed URL, providing a streamlined experience for uploading.

#### Manage videos
- [Get list of all media](https://docs.fastpix.io/reference/list-media): This endpoint returns a list of all media files created from a URL or uploaded as file objects within your organization. Each media entry contains metadata such as the media ID, creation date, status, and type. It allows you to retrieve a comprehensive overview of your media assets, making it easier to manage and review them.
- [Get a media by ID](https://docs.fastpix.io/reference/get-media): By calling this endpoint, you can retrieve detailed information about a specific media item, including its current status and a playbackId. This is particularly useful for retrieving specific media details when managing large content libraries.
- [Update a media by ID](https://docs.fastpix.io/reference/updated-media): This endpoint allows you to update specific parameters of an existing media file. You can modify the key-value pairs of the metadata that were provided in the payload during the creation of media from a URL or when uploading the media as a file object.
- [Delete a media by ID](https://docs.fastpix.io/reference/delete-media): This endpoint allows you to permanently delete a a specific video or audio media file along with all associated data. If you wish to remove a media file from FastPix storage, use this endpoint with the mediaId (either uploadId or id) received during the media's creation or upload.
- [Update the source access of a media by ID](https://docs.fastpix.io/reference/updated-source-access): This endpoint allows you to update the sourceAccess setting of an existing media file. The sourceAccess parameter determines whether the original media file is accessible or restricted. Setting this to true enables access to the media source, while setting it to false restricts access.
- [Get info of media inputs](https://docs.fastpix.io/reference/retrievemediainputinfo): Allows you to retrieve detailed information about the media inputs associated with a specific media item. You can use this endpoint to verify the media file’s input URL, track creation status, and container format. The mediaId (either uploadId or id) must be provided to fetch the information.
- [Get all unused upload URLs](https://docs.fastpix.io/reference/list-uploads): This endpoint retrieves a paginated list of all unused upload signed URLs within your organization. It provides comprehensive metadata including upload IDs, creation dates, status, and URLs, helping you manage your media resources efficiently.
- [Add audio / subtitle track](https://docs.fastpix.io/reference/add-media-track): This endpoint allows you to add an audio or subtitle track to an existing media file using its media ID. You need to provide the track URL along with its type (audio or subtitle), language name and language code in the request payload. 
- [Update audio / subtitle track](https://docs.fastpix.io/reference/update-media-track): This endpoint allows you to update an existing audio or subtitle track associated with a media file. When updating a track, you must provide the new track URL, language name, and language code, ensuring all three parameters are included in the request.
- [Delete audio / subtitle track](https://docs.fastpix.io/reference/delete-media-track): This endpoint allows you to delete an existing audio or subtitle track from a media file using its media ID and track ID. Once deleted, the track will no longer be available for playback.
- [Generate track subtitle](https://docs.fastpix.io/reference/generate-subtitle-track): This endpoint allows you to generate subtitles for an existing audio track in a media file using its media ID and track ID. You need to provide the language name and language code in the request payload.
- [Update the mp4Support of a media by ID](https://docs.fastpix.io/reference/updated-mp4support): This endpoint allows you to update the mp4Support setting of an existing media file using its media ID. You can specify the MP4 support level, such as none, capped_4k, audioOnly, or a combination of audioOnly,capped_4k, in the request payload.
- [Get all clips of a media](https://docs.fastpix.io/reference/get-media-clips): This endpoint retrieves a list of all media clips associated with a given source media ID. It helps in organizing and managing media's efficiently by providing metadata, including clip media IDs and other relevant details.  
- [Get all clips of a live stream](https://docs.fastpix.io/reference/list-live-clips): Retrieves a list of all media clips generated from a specific livestream. Each media entry includes metadata such as the clip media IDs, and other relevant details. A media clip is a segmented portion of an original media file (source live stream). Clips are often created for various purposes such as previews, highlights, or customized edits.
- [Cancel ongoing upload](https://docs.fastpix.io/reference/cancel-upload): This endpoint allows you to cancel ongoing upload by its uploadId. Once cancelled, the upload will be marked as cancelled. Use this if a user aborts an upload or if you want to programmatically stop an in-progress upload.

#### In-video AI features
- [Generate video summary](https://docs.fastpix.io/reference/update-media-summary): This endpoint allows you to generate the summary for an existing media.
- [Generate video chapters](https://docs.fastpix.io/reference/update-media-chapters): This endpoint enables you to generate chapters for an existing media file.
- [Generate named entities](https://docs.fastpix.io/reference/update-media-named-entities): This endpoint allows you to extract named entities from an existing media.
Named Entity Recognition (NER) is a fundamental natural language processing (NLP) technique that identifies and classifies key information (entities) in text into predefined categories
- [Enable video moderation](https://docs.fastpix.io/reference/update-media-moderation): This endpoint enables moderation features, such as NSFW and profanity filtering, to detect inappropriate content in existing media

#### Playback
- [Create a playback ID](https://docs.fastpix.io/reference/create-media-playback-id): You can create a new playback ID for a specific media asset. If you have already retrieved an existing playbackId using the Get Media by ID endpoint for a media asset, you can use this endpoint to generate a new playback ID with a specified access policy.
- [Delete a playback ID](https://docs.fastpix.io/reference/delete-media-playback-id): This endpoint allows you to remove a specific playback ID associated with a media asset. Deleting a playbackId will revoke access to the media content linked to that ID. 
- [Get a playback ID](https://docs.fastpix.io/reference/get-playback-id): This endpoint retrieves details about a specific playback ID associated with a media asset. This endpoint is commonly used to check the access policy (e.g., public or private) with the specific playback ID.

#### Playlist
- [Create a new playlist](https://docs.fastpix.io/reference/create-a-playlist): This endpoint creates a new playlist within a specified workspace. A playlist acts as a container for organizing media items either manually or based on filters and metadata.
- [Get all playlists](https://docs.fastpix.io/reference/get-all-playlists): This endpoint retrieves all playlists present within a specified workspace. It allows users to view the collection of playlists that have been created, whether manual or smart, along with their associated metadata.
- [Get a playlist by ID](https://docs.fastpix.io/reference/get-playlist-by-id): This endpoint retrieves detailed information about a specific playlist using its unique playlistId. It provides comprehensive metadata about the playlist, including its title, creation mode (manual or smart), media items along with the metadata of each media in the playlist.
- [Update a playlist by ID](https://docs.fastpix.io/reference/update-a-playlist): This endpoint allows you to update the name and description of an existing playlist. It enables modifications to the playlist’s metadata without altering the media items or playlist structure.
- [Delete a playlist by ID](https://docs.fastpix.io/reference/delete-a-playlist): This endpoint allows you to delete an existing playlist from the workspace. Once deleted, the playlist and its metadata are permanently removed and cannot be recovered.
- [Add media to a playlist by ID](https://docs.fastpix.io/reference/add-media-to-playlist): This endpoint allows you to add one or more media items to an existing playlist. By passing the media ID(s) in the request, the specified media items are appended to the playlist in the order provided.
- [Change media order in a playlist by ID](https://docs.fastpix.io/reference/change-media-order-in-playlist): This endpoint allows you to change the order of media items within a playlist. By passing the complete list of media IDs in the desired sequence, the playlist’s play order is updated accordingly.
- [Delete media in a playlist by ID](https://docs.fastpix.io/reference/delete-media-from-playlist):This endpoint allows you to delete one or more media items from an existing playlist. By passing the media ID(s) in the request, the specified media items are removed from the playlist.   

#### DRM configurations
- [Get list of DRM configuration IDs](https://docs.fastpix.io/reference/getdrmconfiguration): This endpoint retrieves the DRM configuration (DRM ID) associated with a workspace. It returns a list of DRM configurations, identified by a unique DRM ID, which is used for creating DRM encrypted asset.
- [Get DRM configuration by ID](https://docs.fastpix.io/reference/getdrmconfigurationbyid): This endpoint retrieves a DRM configuration ID. It is used to fetch the DRM-related ID for a workspace, typically required when validating or applying DRM policies to video assets.


### Live stream API

#### Start live streaming
- [Create a new stream](https://docs.fastpix.io/reference/create-new-stream): Allows you to initiate a new RTMP or SRT live stream on FastPix. Upon creating a stream, FastPix generates a unique stream key and SRT secret, which can be used with any broadcasting software (like OBS) to connect to FastPix's RTMP or SRT servers. Users can configure the stream settings, including metadata (such as stream name and description), reconnect window (in case of disconnection), privacy options (public or private), and advanced features like enabling DVR mode.
Leverage SRT for live streaming in environments with unstable networks, taking advantage of its error correction and encryption features for a resilient and secure broadcast.

#### Manage live streams
- [Get all live streams](https://docs.fastpix.io/reference/get-all-streams): Retrieves a list of all live streams associated with the user’s account (workspace). It provides an overview of both current and past live streams, including details like streamId, title, status, and creation time.
- [Get stream by ID](https://docs.fastpix.io/reference/get-live-stream-by-id): This endpoint retrieves detailed information about a specific live stream by its unique streamId. It includes data such as the stream’s status (idle, preparing, active, disabled), metadata (title, description), and more.
- [Delete a stream](https://docs.fastpix.io/reference/delete-live-stream): Permanently removes a specified live stream from the workspace. If the stream is still active, the encoder will be disconnected, and the ingestion will stop. This action cannot be undone, and any future playback attempts will fail. By providing the streamId, the API will terminate any active connections to the stream and remove it from the list of available live streams. You can further look for video.live_stream.deleted webhook to notify your system about the status.
- [Update a stream](https://docs.fastpix.io/reference/update-live-stream): This endpoint allows users to modify the parameters of an existing live stream, such as its metadata (title, description) or the reconnect window. It’s useful for making changes to a stream that has already been created but not yet ended. Once the live stream is disabled, you cannot update a stream. The updated stream parameters and the streamId needs to be shared in the request, and FastPix will return the updated stream details. Once updated, video.live_stream.updated webhook event notifies your system.
- [Get stream views by ID](https://docs.fastpix.io/reference/get-live-stream-viewer-count-by-id): This endpoint retrieves the current number of viewers watching a specific live stream, identified by its unique streamId.
- [Enable a stream](https://docs.fastpix.io/reference/enable-live-stream): This endpoint allows you to enable a livestream by transitioning its status from disabled to idle. Once enabled, the stream becomes available and ready to accept an incoming broadcast from a streaming tool.
- [Disable a stream](https://docs.fastpix.io/reference/disable-live-stream): This endpoint disables a livestream by setting its status to disabled. Use this to stop a livestream when it's no longer needed or should be taken offline intentionally.
- [Complete a stream](https://docs.fastpix.io/reference/complete-live-stream): This endpoint marks a livestream as completed by stopping the active stream and transitioning its status to idle. It is typically used after a livestream session has ended.    

#### Playback 
- [Create a playbackId](https://docs.fastpix.io/reference/create-playbackid-of-stream): Generates a new playback ID for the live stream, allowing viewers to access the stream through this ID. The playback ID can be shared with viewers for direct access to the live broadcast.
By calling this endpoint with the streamId, FastPix returns a unique playbackId, which can be used to stream the live content. 
- [Delete a playbackId](https://docs.fastpix.io/reference/delete-playbackid-of-stream): Deletes a previously created playback ID for a live stream. This will prevent any new viewers from accessing the stream through the playback ID, though current viewers will be able to continue watching for a limited time before being disconnected. By providing the playbackId, FastPix deletes the ID and ensures new playback requests will fail.
- [Get stream's playbackId](https://docs.fastpix.io/reference/get-live-stream-playback-id): Retrieves details about a previously created playback ID. If you provide the distinct playback ID that was given back to you in the previous stream or playbackId create request, FastPix will provide the relevant playback details such as the access policy.

#### Simulcast stream
- [Create a simulcast](https://docs.fastpix.io/reference/create-simulcast-of-stream): Lets you to create a simulcast for a parent live stream. A simulcast enables you to broadcast the live stream to multiple platforms simultaneously (e.g., YouTube, Facebook, or Twitch). This feature is useful for expanding your audience reach across different platforms. However, a simulcast can only be created when the parent live stream is in an idle state (i.e., not currently live or disabled). Additionally, only one simulcast target can be created per API call.
- [Delete a simulcast](https://docs.fastpix.io/reference/delete-simulcast-of-stream): Allows you to delete a simulcast using its unique simulcastId, which was returned during the simulcast creation process. Deleting a simulcast stops the broadcast to the associated platform, but the parent stream will continue to run if it is live. This action is irreversible, and a new simulcast would need to be created if you want to resume streaming to the same platform.
- [Get a specific simulcast of a stream](https://docs.fastpix.io/reference/get-specific-simulcast-of-stream):Retrieves the details of a specific simulcast associated with a parent live stream. By providing both the streamId of the parent stream and the simulcastId, FastPix returns detailed information about the simulcast, such as the stream URL, the status of the simulcast (active or idle), and metadata.
- [Update a specific simulcast of a stream](https://docs.fastpix.io/reference/update-specific-simulcast-of-stream): Allows you to enable or disable a specific simulcast associated with a parent live stream. The status of the simulcast can be updated at any point, whether the live stream is active or idle. However, once the live stream is disabled, the simulcast can no longer be modified.


### Video data API

#### Views 
- [List video views](https://docs.fastpix.io/reference/list_video_views): Retrieves a list of video views that fall within the specified filters and have been completed within a defined timespan. It allows you to analyse viewer interactions with your video content effectively.
- [Get details of video view](https://docs.fastpix.io/reference/get_video_view_details): This endpoint allows you to retrieve detailed information about a specific video view using its unique viewId. This is useful for gaining insights into individual viewer interactions with your video content. This detailed information is valuable for enhancing user experience and improving engagement with your video assets.
Make a GET request to the /viewlist/{viewId} endpoint and you will receive a response containing detailed information about the specified video view, including metrics and attributes related to that view.
- [List by top content](https://docs.fastpix.io/reference/list_by_top_content): Retrieves a list of the top video views that fall within the specified filters and have been completed within a defined timespan. It allows you to identify the most popular content based on viewer interactions.

#### Dimensions
- [List the dimensions](https://docs.fastpix.io/reference/list_dimensions): The endpoint retrieves a comprehensive list of dimensions that can be utilized as query parameters across various data endpoints. Each dimension has a unique id that can be used to filter data effectively.
The dimensions retrieved from this endpoint can be used in conjunction with the List Video Views and List by Top Content endpoints to filter results based on specific criteria. For example, you can filter views by browser name, operating system, device type, and more.
- [List the filter values for a dimension](https://docs.fastpix.io/reference/list_filter_values_for_dimension): This endpoint returns the filter values associated with a specific dimension, along with the total number of video views for each value. For example, it can list all browser names (dimensions) and show how many views occurred for all available browsers like Chrome, Safari (filter values).
In order to use the Custome Dimensions, you must enable them in the dashboard under settings option based on the plan you have opted for.  

#### Metrics
- [List breakdown values](https://docs.fastpix.io/reference/list_breakdown_values): Retrieves breakdown values for a specified metric and timespan, allowing you to analyze the performance of your content based on various dimensions. It provides insights into how different factors contribute to the overall metrics.
- [List overall values](https://docs.fastpix.io/reference/list_overall_values): Retrieves overall values for a specified metric, providing summary statistics that help you understand the performance of your content. The response includes key metrics such as totalWatchTime, uniqueViews, totalPlayTime and totalViews.
- [Get timeseries data](https://docs.fastpix.io/reference/get_timeseries_data): This endpoint retrieves timeseries data for a specified metric, providing insights into how the metric values change over time. The response includes an array of data points, each representing the metric's value at specific intervals.
- [List comparison values](https://docs.fastpix.io/reference/list_comparison_values): This endpoint allows you to compare multiple metrics across specified dimensions. Before using this endpoint, you should first retrieve all available dimensions using the List Dimensions endpoint. You can then specify the metrics you want to compare in the query parameters, and the response will include the relevant metrics for the specified dimensions. 

#### Errors 
- [List errors](https://docs.fastpix.io/reference/list_errors): This endpoint returns the total number of playback errors that occurred, along with the total number of views captured, based on the specified timespan and filters. It provides insights into the overall playback quality and helps identify potential issues that may impact viewer experience.