fixed.yaml

openapi: 3.0.0
servers:
  - description: FastPix Video APIs
    url: https://api.fastpix.com/v1/
x-fastpix-retries:
  strategy: backoff
  backoff:
    strategy: exponential
    initialInterval: 1000
    maxInterval: 10000
    multiplier: 2
  maxAttempts: 3
  retryConnectionErrors: true
  statusCodes:
    - 408
    - 429
    - 500
    - 502
    - 503
    - 504
info:
  description: >-
    FastPix provides a comprehensive set of APIs that enable developers to manage both
    **on-demand media (video/audio)** and **live streaming experiences**, with built-in
    security features through **cryptographic signing keys**. These APIs cover the full
    lifecycle of content creation, management, distribution, playback, and secure access,
    making them ideal for building scalable video-first applications.

    ### Media APIs (Video & Audio on Demand)

    The **Media APIs** allow developers to create, retrieve, update, and delete media
    files, as well as manage metadata, playback settings, and additional tracks such as
    audio or subtitles. With these endpoints, developers can:

    - Upload videos directly or create media from URLs.  
    - Manage playback permissions and configure playback IDs.  
    - Add multilingual audio or subtitle tracks for global audiences.  
    - Build robust video-on-demand (VOD) and audio-on-demand (AOD) libraries.  

    **Use case scenarios**  
    - **Video-on-Demand Platforms:** Manage large content libraries for streaming services.  
    - **E-Learning Solutions:** Upload and organize lecture videos, metadata, and playback settings.  
    - **Multilingual Content Delivery:** Add multiple language tracks or subtitles to serve global users.  

    ### Live Stream APIs

    The **Live Stream APIs** simplify the process of creating, managing, and distributing
    live content. Developers can initiate broadcasts, configure stream settings, and extend
    streams to external platforms through simulcasting. These endpoints also support
    real-time interaction and customization of live events.

    - Start and manage live broadcasts programmatically.  
    - Control stream metadata, privacy, and playback options.  
    - Simulcast to platforms like YouTube, Facebook, or Twitch.  
    - Update stream details and manage live playback IDs in real time.  

    **Use case scenarios**  
    - **Event Broadcasting:** Enable organizers to set up live streams for conferences, concerts, or webinars.  
    - **Creator Platforms:** Provide streamers with tools for broadcasting gameplay, tutorials, or vlogs with simulcasting support.  
    - **Corporate Streaming:** Deliver secure internal town halls or meetings with privacy and playback controls.  
    
    ### Video Data APIs
    
    The **Video Data APIs** Provide insights into viewer interactions, performance metrics, and playback errors to optimize content delivery and user experience.
    
     - Track video views, unique viewers, and engagement metrics
     - Identify top-performing content and usage patterns
     - Break down data by browser, device, or geography
     - Detect playback errors and performance issues
     - Enable data-driven content strategy decisions
    
     **Use case scenarios** 
     - Analytics Dashboards: Monitor performance across content libraries
     - Quality Monitoring: Diagnose and resolve playback issues
     - Content Strategy Optimization: Identify high-value content
     - User Behavior Insights: Understand audience interactions

    ### Signing Keys

    FastPix also provides endpoints for managing **cryptographic signing keys**, which are
    essential for securely signing and verifying tokens, such as JSON Web Tokens (JWTs).
    These keys are critical for authenticating and authorizing API requests, as well as for
    protecting access to media assets.

    - **Private key:** Used to create digital signatures (kept secret).  
    - **Public key:** Used to verify digital signatures (shared for verification).  

    By rotating and managing signing keys regularly, developers can maintain strong
    security practices and prevent unauthorized access.  

    **Use case scenarios**  
    - **Token-based authentication:** Validate user access to premium or subscription-based content.  
    - **Key rotation:** Regularly rotate keys to reduce risk of compromise.  
    - **Protect intellectual property:** Prevent unauthorized distribution of valuable media assets.  
    - **Control usage:** Restrict access to specific users, groups, or contexts.  
    - **Prevent tampering:** Ensure requested assets have not been modified.  
    - **Time-bound access:** Enable signed URLs with expiration for controlled viewing windows.
  version: 1.0.0
  title: FASTPIX API'S
  contact:
    email: support@fastpix.com
tags:
  - name: on-demand
    description: On-demand APIs
  - name: livestream
    description: Livestream APIs
  - name: Signing keys
    description: Operations involving signing keys
  - name: Views
    description: Operations involving views
  - name: Dimensions
    description: Operations involving dimensions
  - name: Metrics
    description: Operations involving metrics
  - name: Errors
    x-fastpix-name-override: error_operations
    description: Operations involving errors
  - name: Live playback
    description: Operations for live stream playback management
  - name: Simulcast stream
    description: Operations for simulcast stream management
  - name: Input video
    description: Operations for inputting and creating video media
  - name: Manage videos
    description: Operations for managing video media
  - name: In-video AI features
    description: Operations for AI-powered video features
  - name: Playback
    description: Operations for video playback management
  - name: Playlist
    description: Operations for playlist management
  - name: DRM configurations
    description: Operations for DRM configuration management
  - name: Start live stream
    description: Operations for starting live streams
  - name: Manage live stream
    description: Operations for managing live streams
paths:
  /on-demand:
    post:
      security:
        - BasicAuth: []
      tags:
        - Input video
      summary: Create media from URL
      description: |
        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 <a href="https://fastpix.com/docs/video-on-demand-api/manage-videos/get-media">Get Media by ID</a> 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 <a href="https://fastpix.com/docs/vod-events/media-events#videomediacreated">video.media.created</a>. 


        After processing completes, monitor the events <a href="https://fastpix.com/docs/vod-events/media-events#videomediaready">video.media.ready</a> and <a href="https://fastpix.com/docs/vod-events/media-events#videomediafailed">video.media.failed</a> to track the status of the media file.

        Related guide: <a href="https://fastpix.com/docs/upload-videos/upload-videos-from-a-url">Upload videos from URL</a>
      operationId: create-media
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateMediaRequest"
            example:
              inputs:
                - type: video
                  url: https://static.fastpix.com/fp-sample-video.mp4
              metadata:
                key1: value1
              accessPolicy: public
              maxResolution: 1080p
              mediaQuality: standard
        description: Request body for uploading a video media from URL
      responses:
        "201":
          description: Media is created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateMediaSuccessResponse"
                example:
                  success: true
                  data:
                    id: 22ab3a33-bf96-4070-ae1f-60b3d0900fa5
                    trial: false
                    status: Created
                    createdAt: "2025-11-03T10:03:48.595604Z"
                    updatedAt: "2025-11-03T10:03:48.595624Z"
                    playbackIds:
                      - id: 5c9de6f2-3e90-40a5-b529-35ada8f7914f
                        accessPolicy: public
                        accessRestrictions:
                          domains:
                            defaultPolicy: allow
                            allow: []
                            deny: []
                          userAgents:
                            defaultPolicy: allow
                            allow: []
                            deny: []
                    metadata:
                      key1: value1
                    mediaQuality: standard
                    sourceAccess: false
                    maxResolution: 1080p
                    inputs:
                      - type: video
                        url: https://static.fastpix.com/fp-sample-video.mp4
                    optimizeAudio: false

        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"

    get:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Get list of all media
      description: |
        This endpoint returns a list of all media files uploaded to FastPix within a specific workspace. Each media entry contains data such as the media `id`, `createdAt`, `status`, `type` and more. It allows you to retrieve an overview of your media assets, making it easier to manage and review them. 


        #### How it works

        Use the access token and secret key related to the workspace in the request header. When called, the API provides a paginated response containing all the media items in that specific workspace. This is helpful for retrieving a large volume of media and managing content in bulk. 



        #### Example
        If you manage a video platform and need to review all uploaded media in your library to ensure that outdated or low-quality content isn’t being served, you can use this endpoint to retrieve a complete list of media. You can then filter, sort, or update items as needed.
      operationId: list-media
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 50
            example: 20
          description: Limit specifies the maximum number of items to display per page.
        - in: query
          name: offset
          schema:
            type: integer
            default: 1
            example: 1
          description: Offset determines the starting point for data retrieval within a paginated list.
        - in: query
          name: orderBy
          schema:
            type: string
            example: desc
            default: desc
            $ref: "#/components/schemas/SortOrder"
      responses:
        "200":
          description: List of video media
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Demonstrates whether the request is successful or not.
                  data:
                    description: Displays the result of the request.
                    type: array
                    items:
                      $ref: "#/components/schemas/GetAllMediaResponse"
                  pagination:
                    $ref: "#/components/schemas/Pagination"
                example:
                  success: true
                  data:
                    - thumbnail: https://images.fastpix.com/837f028b-dcaf-4c23-b368-3748641f74ac/thumbnail.png
                      id: cfeec1a3-6cbd-40df-a425-2ed7f8f72ced
                      workspaceId: 6dc2b4e0-0615-42fd-a580-1f4aad932dfe
                      metadata:
                        key1: value1
                      mediaQuality: standard
                      maxResolution: 1080p
                      sourceResolution: 1080p
                      status: Ready
                      sourceAccess: false
                      playbackIds:
                        - id: 837f028b-dcaf-4c23-b368-3748641f74ac
                          accessPolicy: public
                          accessRestrictions:
                            domains:
                              defaultPolicy: allow
                              allow: []
                              deny: []
                            userAgents:
                              defaultPolicy: allow
                              allow: []
                              deny: []
                      tracks:
                        - id: f301a2a1-b40d-40fa-b419-4d0cd92a62f8
                          type: video
                          width: 1920
                          height: 1080
                          status: available
                      generatedSubtitles: []
                      isAudioOnly: false
                      subtitleAvailable: true
                      duration: "00:00:10"
                      aspectRatio: "16:9"
                      createdAt: "2025-01-09T06:44:44.617138Z"
                      updatedAt: "2025-01-09T06:44:53.742648Z"
                  pagination:
                    totalRecords: 100
                    currentOffset: 1
                    offsetCount: 10
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{livestreamId}/live-clips:
    get:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Get all clips of a live stream
      description: |
        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.
        #### How it works
        1. Provide the livestreamId as a parameter when calling this endpoint.

        2. The API returns a paginated list of media clips created from the specified livestream.
        
        3. Pagination helps maintain performance and usability when handling large sets of media files, making it easier to organize and manage content in bulk.
        
        #### Use case
        Suppose you’re hosting a live gaming event and want to showcase key moments from the stream — such as top plays or final match highlights. You can use this endpoint to fetch all clips generated from that livestream, display them in your dashboard, or use them for post-event editing and sharing.


        Related guide: <a href="https://fastpix.com/docs/edit-and-transform-live-stream/clip-moments-from-a-live-stream">Instant live clipping</a>
      operationId: list-live-clips
      parameters:
        - in: path
          name: livestreamId
          required: true
          schema:
            type: string
            format: uuid
            example: b6f71268143f70c798a7851a0a92dcbf
          description: The stream Id is unique identifier assigned to the live stream.
        - in: query
          name: limit
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 50
            example: 20
          description: Limit specifies the maximum number of items to display per page.
        - in: query
          name: offset
          schema:
            type: integer
            default: 1
            example: 1
          description: Offset determines the starting point for data retrieval within a paginated list.
        - in: query
          name: orderBy
          schema:
            type: string
            example: desc
            default: desc
            $ref: "#/components/schemas/SortOrder"
      responses:
        "200":
          description: List of video media
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Demonstrates whether the request is successful or not.
                  data:
                    description: Displays the result of the request.
                    type: array
                    items:
                      $ref: "#/components/schemas/Live-Media-Clips"
                  pagination:
                    $ref: "#/components/schemas/Pagination"
                example:
                  success: true
                  data:
                    - thumbnail: https://images.fastpix.com/837f028b-dcaf-4c23-b368-3748641f74ac/thumbnail.png
                      id: cfeec1a3-6cbd-40df-a425-2ed7f8f72ced
                      workspaceId: 6dc2b4e0-0615-42fd-a580-1f4aad932dfe
                      streamId: 98f28be5ac9bd7a4205634691a1a096b
                      maxResolution: 1080p
                      sourceResolution: 1080p
                      status: Ready
                      sourceAccess: false
                      playbackIds:
                        - id: 837f028b-dcaf-4c23-b368-3748641f74ac
                          accessPolicy: public
                          accessRestrictions:
                            domains:
                              defaultPolicy: allow
                              allow: []
                              deny: []
                            userAgents:
                              defaultPolicy: allow
                              allow: []
                              deny: []
                      tracks:
                        - id: f301a2a1-b40d-40fa-b419-4d0cd92a62f8
                          type: video
                          width: 1920
                          height: 1080
                          frameRate: 30/1
                          status: available
                      isAudioOnly: false
                      subtitleAvailable: true
                      duration: "00:00:10"
                      aspectRatio: "16:9"
                      createdAt: "2025-01-09T06:44:44.617138Z"
                      updatedAt: "2025-01-09T06:44:53.742648Z"
                  pagination:
                    totalRecords: 100
                    currentOffset: 1
                    offsetCount: 10
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}:
    get:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Get a media by ID
      description: |
        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. 



        #### How it works

        1. Send a GET request to this endpoint. Use the `<mediaId>` you received after uploading the media file.
        
        2. The response includes details about the media:
           - **status** – Indicates whether the media is still *Processing* or has transitioned to *Ready*.
           - **playbackId** – A unique identifier that allows you to stream the media once it is *Ready*.  
             You can construct the stream URL as follows:  
             `https://stream.fastpix.com/<playbackId>.m3u8`

        #### Example

        If your platform provides users with a dashboard to manage uploaded content, a user might want to check whether a video has finished processing and is ready for playback. You can use the media ID to retrieve the information from FastPix and display it in the user’s dashboard.
      operationId: get-media
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
      responses:
        "200":
          description: Get a video media by id
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Demonstrates whether the request is successful or not.
                  data:
                    $ref: "#/components/schemas/GetMediaResponse"
                example:
                  success: true
                  data:
                    thumbnail: https://images.fastpix.com/837f028b-dcaf-4c23-b368-3748641f74ac/thumbnail.png
                    id: cfeec1a3-6cbd-40df-a425-2ed7f8f72ced
                    workspaceId: 6dc2b4e0-0615-42fd-a580-1f4aad932dfe
                    metadata:
                      key1: value1
                    mediaQuality: standard
                    maxResolution: 1080p
                    sourceResolution: 1080p
                    status: Ready
                    mp4Support: capped_4k
                    sourceAccess: false
                    playbackIds:
                      - id: 837f028b-dcaf-4c23-b368-3748641f74ac
                        accessPolicy: public
                        accessRestrictions:
                          domains:
                            defaultPolicy: allow
                            allow: []
                            deny: []
                          userAgents:
                            defaultPolicy: allow
                            allow: []
                            deny: []
                    tracks:
                      - id: f301a2a1-b40d-40fa-b419-4d0cd92a62f8
                        type: video
                        width: 1920
                        height: 1080
                        frameRate: 30/1
                        status: available
                    isAudioOnly: false
                    subtitleAvailable: true
                    duration: "00:00:10"
                    aspectRatio: "16:9"
                    createdAt: "2025-01-09T06:44:44.617138Z"
                    updatedAt: "2025-01-09T06:44:53.742648Z"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    patch:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Update a media by ID
      description: |
        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 directly from device. 


        #### How it works

        1. Make a PATCH request to this endpoint. Replace `<mediaId>` with the unique ID (`uploadId` or `id`) of the media you received after uploading to FastPix

        2. Include the updated parameters in the request body.

        3. The response returns the updated media data, confirming the changes. 

        4. Monitor the <a href="https://fastpix.com/docs/vod-events/media-events#videomediaupdated">video.media.updated</a> webhook event to track the update status in your system.

        #### Example
        If a user uploads a video and later needs to change the title, add a new description, or update tags, you can use this endpoint to update the media metadata without re-uploading the entire video.
      operationId: updated-media
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            example:
              metadata:
                user: fastpix_admin
              title: test title
              creatorId: 8fa85f64-5717-4562-b3fc-2c963f66afa6
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  additionalProperties:
                    type: string
                    maxLength: 255
                  maxProperties: 10
                  example:
                    user: fastpix_admin
                  default:
                    user: fastpix_admin
                title:
                  type: string
                  maxLength: 255
                  example: My Video Title
                  default: My Video Title
                  description: Title of the media file.
                creatorId:
                  type: string
                  maxLength: 255
                  example: 8fa85f64-5717-4562-b3fc-2c963f66afa6
                  default: 8fa85f64-5717-4562-b3fc-2c963f66afa6
                  description: The unique identifier of the user who created this media.
      responses:
        "200":
          description: Media details updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Demonstrates whether the request is successful or not.
                  data:
                    $ref: "#/components/schemas/Update-Media"
                example:
                  success: true
                  data:
                    thumbnail: https://images.fastpix.com/837f028b-dcaf-4c23-b368-3748641f74ac/thumbnail.png
                    id: cfeec1a3-6cbd-40df-a425-2ed7f8f72ced
                    workspaceId: 6dc2b4e0-0615-42fd-a580-1f4aad932dfe
                    metadata:
                      user: fastpix_admin
                    mediaQuality: standard
                    creatorId: fastpix-123
                    title: Test-Video-Title
                    maxResolution: 1080p
                    sourceResolution: 1080p
                    status: Ready
                    sourceAccess: false
                    playbackIds:
                      - id: 837f028b-dcaf-4c23-b368-3748641f74ac
                        accessPolicy: public
                        accessRestrictions:
                          domains:
                            defaultPolicy: allow
                            allow: []
                            deny: []
                          userAgents:
                            defaultPolicy: allow
                            allow: []
                            deny: []
                    tracks:
                      - id: f301a2a1-b40d-40fa-b419-4d0cd92a62f8
                        type: video
                        width: 1920
                        height: 1080
                        frameRate: 30/1
                        status: available
                    generatedSubtitles: []
                    isAudioOnly: false
                    subtitleAvailable: true
                    duration: "00:00:10"
                    aspectRatio: "16:9"
                    createdAt: "2025-01-09T06:44:44.617138Z"
                    updatedAt: "2025-01-09T06:44:53.742648Z"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    delete:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Delete a media by ID
      operationId: delete-media
      description: |
        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 from FastPix storage, use this endpoint with the `mediaId` (either `uploadId` or `id`) received during the media's creation or upload. 


        #### How it works


        1. Send a DELETE request to this endpoint. Replace `<mediaId>` with the `uploadId` or the `id` of the media you want to delete. 

        2. This action is irreversible. Make sure you no longer need the media before proceeding. Once deleted, the media can’t be retrieved or played back. 

        3. Monitor the following webhook event: <a href="https://fastpix.com/docs/vod-events/media-events#videomediadeleted">video.media.deleted</a>

        #### Example
        A user on a video-sharing platform decides to remove an old video from their profile, or suppose you're running a content moderation system, and one of the videos uploaded by a user violates your platform's policies. Using this endpoint, the media is permanently deleted from your library, ensuring it's no longer accessible or viewable by other users.
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
      responses:
        "200":
          description: Delete a video media
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Demonstrates whether the request is successful or not.
                example:
                  success: true
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/tracks:
    post:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Add audio / subtitle track
      description: |
        This endpoint allows you to add an audio or subtitle track to an existing media file using its `mediaId`. You need to provide the track `url` along with its `type` (audio or subtitle), `languageName` and `languageCode` in the request payload.


        #### How it works

        1. Send a POST request to this endpoint, replacing `{mediaId}` with the media ID (`uploadId` or `id`).

        2. Provide the necessary details in the request body.

        3. Receive a response containing a unique track ID and the details of the newly added track.


        #### Webhook events

        1. After successfully adding a track, your system must receive the webhook event <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediatrackcreated">video.media.track.created</a>.

        2. Once the track is processed and ready, you must receive the webhook event <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediatrackready">video.media.track.ready</a>.

        3. Finally, an update event <a href="https://fastpix.com/docs/vod-events/media-events#videomediaupdated">video.media.updated</a> must notify your system about the media's updated status.


        #### Example
        Suppose you have a video uploaded to the FastPix platform, and you want to add an Italian audio track to it. By calling this API, you can attach an external audio file (https://static.fastpix.com/music-1.mp3) to the media file. Similarly, if you need to add subtitles in different languages, you can specify type: `subtitle` with the corresponding subtitle `url`, `languageCode` and `languageName`.

        Related guides: <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-subtitles-to-a-video">Add own subtitle tracks</a>, <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-audio-to-a-video">Add own audio tracks</a>
      operationId: Add-media-track
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - tracks
              properties:
                tracks:
                  $ref: "#/components/schemas/AddTrackRequest"
            example:
              tracks:
                url: https://static.fastpix.com/music-1.mp3
                type: audio
                languageCode: it
                languageName: Italian
      responses:
        "201":
          description: Media details updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Demonstrates whether the request is successful or not.
                  data:
                    $ref: "#/components/schemas/AddTrackResponse"
                example:
                  success: true
                  data:
                    id: ace60fc7-e876-4fc6-b9d9-c33fa242f84b
                    type: audio
                    url: https://static.fastpix.com/music-1.mp3
                    languageCode: it
                    languageName: Italian
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/upload/{uploadId}/cancel:
    put:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Cancel ongoing upload
      operationId: cancel-upload
      description: |
        This endpoint allows you to cancel ongoing upload by its `uploadId`. Once cancelled, the upload is marked as cancelled. Use this if a user aborts an upload or if you want to programmatically stop an in-progress upload.

        #### How it works

        1. Make a PUT request to this endpoint, replacing `{uploadId}` with the unique upload ID received after starting the upload.
        2. The response confirms the cancellation and provide the status of the upload.

        #### Webhook Events

        Once the upload is cancelled, you must receive the webhook event <a href="https://fastpix.com/docs/vod-events/media-events#videomediauploadcancelled">video.media.upload.cancelled</a>.

        #### Example

        Suppose a user starts uploading a large video file but decides to cancel before completion. By calling this API, you can immediately stop the upload and free up resources.
      parameters:
        - in: path
          name: uploadId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: When uploading the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
      responses:
        "200":
          description: Upload cancelled successfully
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Demonstrates whether the request is successful or not.
                  data:
                    $ref: "#/components/schemas/MediaCancelResponse"
                example:
                  success: true
                  data:
                    uploadId: beff5537-de85-42e1-a673-2a405cd94177
                    trial: false
                    status: cancelled
                    url: https://storage.googleapis.com/uploads-fp-asia/338acdeb-29d4-438b-a40c-1d4105134462/26b1a17d-4b0b-44f8-96b8-cc33cabc962e?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=fp-prod@fastpix-vms.iam.gserviceaccount.com/20250716/auto/storage/goog4_request&X-Goog-Date=20250716T132746Z&X-Goog-Expires=14400&X-Goog-SignedHeaders=host;x-goog-resumable&X-Goog-Signature=4eb42c38711d915f2b6792edacc48ed79bde9f02f829a084dfe09830e6d0e5ec50f2f3157964ed7e32d44b02e3967bf2e0ffeb7ca9335d65ae15b3ac33c7cb40ec710939c4a12202b749bdb4e3f7af8aba2746b41a642130280a372e4615e9773cea98f231388c9fde385f96142ffa901a900949e305c7d5b4c82590c3493aaf60ac5424d4f112fbf4120b7891adf9a7e17968328cd1128fe7b6f55447d15b562624a8e7539824d10e808a729906ac6fe8b2f561424f3e0db14eecad6e21f4f18513519a975c2c50e8304a5a723723e32aa9ac659d9b9875a85f29f007d57bb69c49b5ff9099e5a9834db7199e73ca01cf0dd85cae599203d3180fa27cfdd08d&upload_id=ABgVH88kcXwWvPOlER2G4UvAnrdQw80h_nfjMqwL-jFe6wpLvfBifpBtlnvPtN2BQQTOWggTpKAQ6uGHIJLDp1LHo2g1eePyfjqNi3oRiwxOBU8
                    timeout: 14400
                    corsOrigin: "*"
                    maxResolution: 1080p
                    accessPolicy: public
                    metadata:
                      key1: value1
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/tracks/{trackId}:
    patch:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Update audio / subtitle track
      description: |
        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`, `languageName`, and `languageCode`, ensuring all three parameters are included in the request.


        #### How it works

        1. Send a PATCH request to this endpoint, replacing `{mediaId}` with the media ID, and `{trackId}` with the ID of the track you want to update.

        2. Provide the necessary details in the request body.

        3. Receive a response confirming the track update.

        #### Webhook Events

        After updating a track, your system must receive webhook notifications:

        1. After successfully updating a track, your system must receive the webhook event <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediatrackupdated">video.media.track.updated</a>.

        2. Once the new track is processed and ready, you must receive the webhook event <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediatrackready">video.media.track.ready</a>.

        3. Once the media file is updated with the new track details, a <a href="https://fastpix.com/docs/vod-events/media-events#videomediaupdated">video.media.updated</a> event must be triggered.


        #### Example
        Suppose you previously added a French subtitle track to a video but now need to update it with a different file. By calling this API, you can replace the existing subtitle file (.vtt) with a new one while keeping the same track ID. This is useful when:

          - The original track file has errors and needs correction.
          - You want to improve subtitle translations or replace an audio track with a better-quality version.
        
        Related guides: <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-subtitles-to-a-video">Add own subtitle tracks</a>, <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-audio-to-a-video">Add own audio tracks</a>
      operationId: update-media-track
      parameters:
        - in: path
          name: trackId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTrackRequest"
            example:
              url: http://commondatastorage.googleapis.com/codeskulptor-assets/sounddogs/thrust.vtt
              languageCode: fr
              languageName: french
      responses:
        "200":
          description: Media details updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Demonstrates whether the request is successful or not.
                  data:
                    $ref: "#/components/schemas/UpdateTrackResponse"
                example:
                  success: true
                  data:
                    id: 2452ca23-b7ed-4daf-babf-841996b0100e
                    type: subtitle
                    url: http://commondatastorage.googleapis.com/codeskulptor-assets/sounddogs/thrust.vtt
                    languageCode: fr
                    languageName: french
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    delete:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Delete audio / subtitle track
      operationId: delete-media-track
      description: |
        This endpoint allows you to delete an existing audio or subtitle track from a media file. Once deleted, the track must no longer be available for playback.


        #### How it works


        1. Send a DELETE request to this endpoint, replacing `{mediaId}` with the media ID, and `{trackId}` with the ID of the track you want to remove.

        2. The track gets deleted from the media file, and you must receive a confirmation response.

        #### Webhook events

        1. After successfully deleting a track, your system must receive the webhook event **video.media.track.deleted**.

        2. Once the media file is updated to reflect the track removal, a <a href="https://fastpix.com/docs/vod-events/media-events#videomediaupdated">video.media.updated</a> event must be triggered.


        #### Example
        Suppose you uploaded an audio track in Italian for a video but later realize it's incorrect or no longer needed. By calling this API, you can remove the specific track while keeping the rest of the media file unchanged. This is useful when:

          - A track was mistakenly added and needs to be removed.
          - The content owner requests the removal of a specific subtitle or audio track.
          - A new version of the track gets uploaded to replace the existing one.
        
        Related guides: <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-subtitles-to-a-video">Add own subtitle tracks</a>, <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-audio-to-a-video">Add own audio tracks</a>
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        - in: path
          name: trackId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
      responses:
        "200":
          description: Delete a video media
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Demonstrates whether the request is successful or not.
                example:
                  success: true
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/tracks/{trackId}/generate-subtitles:
    post:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Generate track subtitle
      description: |
        This endpoint allows you to generate subtitles for an existing audio track in a media file. By calling this API, you can generate subtitles automatically using speech recognition

        #### How it works

        1. Send a `POST` request to this endpoint, replacing `{mediaId}` with the media ID and `{trackId}` with the track ID.

        2. Provide the necessary details in the request body, including the languageName and languageCode.

        3. You receive a response containing a unique subtitle track ID and its details.

        #### Webhook Events

        1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediasubtitlegeneratedready">video.media.subtitle.generated.ready</a>.

        2. Finally the <a href="https://fastpix.com/docs/vod-events/media-events#videomediaupdated">video.media.updated</a> event notifies your system about the media’s updated status.

        </br> Related guide: <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/generate-subtitles-automatically">Add auto-generated subtitles</a>
      operationId: Generate-subtitle-track
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        - in: path
          name: trackId
          required: true
          schema:
            type: string
            format: uuid
            example: d46f5df9-1a8f-4f0a-b56e-9f5b5d5b9e21
          description: A universally unique identifier (UUID) assigned to the specific track for which subtitles must be generated.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TrackSubtitlesGenerateRequest"
            example:
              languageCode: it
              languageName: Italian
      responses:
        "200":
          description: Media details updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Demonstrates whether the request is successful or not.
                  data:
                    $ref: "#/components/schemas/GenerateTrackResponse"
                example:
                  success: true
                  data:
                    id: ace60fc7-e876-4fc6-b9d9-c33fa242f84b
                    type: subtitle
                    languageCode: it
                    languageName: Italian
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/summary:
    patch:
      security:
        - BasicAuth: []
      tags:
        - In-video AI features
      summary: Generate video summary
      description: |
        This endpoint allows you to generate the summary for an existing media.

        #### How it works
        1. Send a `PATCH` request to this endpoint, replacing `<mediaId>` with the ID of the media you want to summarize.
        2. Include the `generate` parameter in the request body.
        3. Include the `summaryLength` parameter, specify the desired length of the summary in words (for example, 120 words), this determines how concise or detailed the summary will be. If no specific summary length is provided, the default length will be 100 words.
        4. The response includes the updated media data and confirmation of the changes applied.

        You can use the <a href="https://fastpix.com/docs/ai-events/in-video-ai-events#videomediaaisummaryready">video.mediaAI.summary.ready</a> webhook event to track and notify about the summary generation.





        **Use case**: This is particularly useful when a user uploads a video and later chooses to generate a summary without needing to re-upload the video.

        Related guide: <a href="https://fastpix.com/docs/video-intelligence/generate-a-video-summary">Video summary</a>
      operationId: update-media-summary
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: |
            The unique identifier assigned to the media when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                generate:
                  type: boolean
                  example: true
                  description: |
                    Enable or disable the summary feature for the media. Set to true to enable summary or false to disable.
                summaryLength:
                  type: integer
                  example: 100
                  default: 100
                  maximum: 250
                  minimum: 30
                  description: |
                    Specifies the desired word count for the generated summary. 
                    - The value must be between **30** and **250** words.
              required:
                - generate
              example:
                generate: true
                summaryLength: 100
      responses:
        "200":
          description: Media details updated successfully with the generated summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    $ref: "#/components/schemas/SummaryResponse"
                example:
                  success: true
                  data:
                    mediaId: c695988b-ff84-42ae-bb21-10f284fedb0e
                    isSummaryEnabled: true
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    get:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Get the summary of a video
      description: |
        This endpoint returns the generated summary of a video.  
        
        The summary is created using the **InVideo Summary** feature, which processes the video content and produces a textual summary.  

        To use this endpoint, you must first generate the video summary using the Generate Video Summary endpoint. This endpoint can return the summary only after that process is complete. 

        Typical use cases include:  
        - Providing viewers with a quick preview of the video's main content.  
        - Enabling search or recommendation systems to surface summarized insights.  
        - Supporting accessibility and content discovery without requiring users to watch the full video.  

        If the summary has not been generated or the feature is disabled for the requested media, the endpoint returns an error indicating that the summary is unavailable. 

      operationId: get-media-summary
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: fc733e3f-2fba-4c3d-9388-2511dc50d15f
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.

      responses:
        "200":
          description: Get media summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    type: string
                    example: "Grandmaster Igor Spirinov introduces the Kutch Gambit, an effective chess opening for players rated below 1500. He emphasizes quick development and pressure on the opponent, particularly targeting the f7 pawn. The gambit forces opponents to play precisely, as common moves can lead to quick defeats. Spirinov outlines various responses from Black, highlighting tactical opportunities for White, including sacrifices and double checks that can lead to checkmate. He also discusses strategies for handling more experienced opponents and emphasizes the importance of maintaining a strong position and advancing pawns in the middle game. A special training bundle is offered for players seeking improvement."
                    description: The summary of the particular video.

        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/chapters:
    patch:
      security:
        - BasicAuth: []
      tags:
        - In-video AI features
      summary: Generate video chapters
      description: |
        This endpoint enables you to generate chapters for an existing media file.

        #### How it works
        1. Make a `PATCH` request to this endpoint, replacing `<mediaId>` with the ID of the media for which you want to generate chapters.
        2. Include the `chapters` parameter in the request body to enable.
        3. The response contains the updated media data, confirming the changes made.

        You can use the <a href="https://fastpix.com/docs/ai-events/in-video-ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation.

        **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.

        Related guide: <a href="https://fastpix.com/docs/video-intelligence/generate-video-chapters">Video chapters</a>
      operationId: update-media-chapters
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: |
            The unique identifier assigned to the media when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                chapters:
                  type: boolean
                  example: true
                  default: true
                  description: |
                    Enable or disable the chapters feature for the media. Set to `true` to enable chapters or `false` to disable.
              required:
                - chapters
              example:
                chapters: true
      responses:
        "200":
          description: Media details updated successfully with the chapters feature enabled or disabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    $ref: "#/components/schemas/ChaptersResponse"
                example:
                  success: true
                  data:
                    mediaId: c695988b-ff84-42ae-bb21-10f284fedb0e
                    isChaptersEnabled: true
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/named-entities:
    patch:
      security:
        - BasicAuth: []
      tags:
        - In-video AI features
      summary: Generate named entities
      description: |
        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. For instance:

          - Organizations (for example, "Microsoft", "United Nations")
          - Locations (for example, "Paris", "Mount Everest")
          - Product names (for example, "iPhone", "Coca-Cola")

        #### How it works
        1. Make a PATCH request to this endpoint, replacing `<mediaId>` with the ID of the media you want to extract named-entities.
        2. Include the `namedEntities` parameter in the request body to enable.
        3. Receive a response containing the updated media data, confirming the changes made.

        You can use the <a href="https://fastpix.com/docs/ai-events/in-video-ai-events#videomediaainamedentitiesready">video.mediaAI.named-entities.ready</a> webhook event to track and notify about the named entities extraction.

        **Use case:** If a user uploads a video and later decides to enable named entity extraction without re-uploading the entire video.

        Related guide: <a href="https://fastpix.com/docs/video-intelligence/extract-named-entities-from-a-video">Named entities</a>
      operationId: update-media-named-entities
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 0cec3c88-c69d-4232-9b96-f0976327fa2d
          description: |
            The unique identifier assigned to the media when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                namedEntities:
                  type: boolean
                  example: true
                  description: |
                    Enable or disable named entity extraction. Set to `true` to enable or `false` to disable.
              required:
                - namedEntities
              example:
                namedEntities: true
      responses:
        "200":
          description: Media details updated successfully with the named entity extraction feature enabled or disabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Indicates if the request was successful or not.
                  data:
                    $ref: "#/components/schemas/NamedEntitiesResponse"
                example:
                  success: true
                  data:
                    mediaId: c695988b-ff84-42ae-bb21-10f284fedb0e
                    isNamedEntitiesEnabled: true
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/moderation:
    patch:
      security:
        - BasicAuth: []
      tags:
        - In-video AI features
      summary: Enable video moderation
      description: |
        This endpoint enables moderation features, such as NSFW and profanity filtering, to detect inappropriate content in existing media.

        #### How it works
        1. Make a `PATCH` request to this endpoint, replacing `<mediaId>` with the ID of the media you want to update.
        2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (for example, video/audio/av).
        4. The response contains the updated media data, confirming the changes made.

        You can use the <a href="https://fastpix.com/docs/ai-events/in-video-ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results.

        **Use case:** This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.

        Related guide: <a href="https://fastpix.com/docs/video-intelligence/detect-nsfw-content-and-profanity">Moderate NSFW & Profanity</a>
      operationId: update-media-moderation
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 0cec3c88-c69d-4232-9b96-f0976327fa2d
          description: |
            The unique identifier assigned to the media when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                moderation:
                  type: object
                  properties:
                    type:
                      $ref: "#/components/schemas/MediaType"
                      description: |
                        Defines the type of input. Possible values include video, audio, av.
              example:
                moderation:
                  type: video

      responses:
        "200":
          description: Media details updated successfully with the named entity extraction feature enabled or disabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    $ref: "#/components/schemas/ModerationResponse"
                example:
                  success: true
                  data:
                    mediaId: c695988b-ff84-42ae-bb21-10f284fedb0e
                    isModerationEnabled: true
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/source-access:
    patch:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Update the source access of a media by ID
      description: |
        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. 

        #### How it works

        1. Make a `PATCH` request to this endpoint, replacing `{mediaId}` with the ID of the media you want to update.

        2. Include the updated `sourceAccess` parameter in the request body.

        3. You receive a response confirming the update to the media’s source access status.
        4. Webhook events: <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediasourceready">video.media.source.ready</a>, <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediasourcedeleted">video.media.source.deleted</a>
      operationId: updated-source-access
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: |
            The unique identifier assigned to the media when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                sourceAccess:
                  type: boolean
                  example: true
                  description: The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.
              required:
                - sourceAccess
              example:
                sourceAccess: true
      responses:
        "200":
          description: Media details updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    $ref: "#/components/schemas/sourceAccessMedia"
                example:
                  success: true
                  data:
                    thumbnail: https://venus-images.fastpix.dev/cf41c9f7-ece3-4efe-8d31-c6e000dc422b/thumbnail.png
                    id: eb56a668-0354-40c2-9233-f3197e1baabd
                    workspaceId: c788be40-91a5-4d2d-abf7-47398a6276a1
                    metadata:
                      key1: value1
                    mediaQuality: standard
                    maxResolution: 1080p
                    sourceResolution: 1080p
                    status: Ready
                    sourceAccess: true
                    playbackIds:
                      - id: cf41c9f7-ece3-4efe-8d31-c6e000dc422b
                        accessPolicy: public
                        accessRestrictions:
                          domains:
                            defaultPolicy: allow
                            allow: []
                            deny: []
                          userAgents:
                            defaultPolicy: allow
                            allow: []
                            deny: []
                    tracks:
                      - id: 344fd5bc-82af-4d11-bc1c-785d9e6f9aef
                        type: video
                        width: 1920
                        height: 1080
                        frameRate: 30/1
                        status: available
                    generatedSubtitles: []
                    isAudioOnly: false
                    subtitleAvailable: false
                    duration: "00:00:10"
                    aspectRatio: "16:9"
                    createdAt: "2024-12-06T03:47:26.489888Z"
                    updatedAt: "2024-12-06T03:47:47.593400Z"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/update-mp4Support:
    patch:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Update the mp4Support of a media by ID
      description: |
        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.

        #### How it works

        1. Send a PATCH request to this endpoint, replacing `{mediaId}` with the media ID.

        2. Provide the desired `mp4Support` value in the request body.

        3. You receive a response confirming the update, including the media’s updated MP4 support status.

        #### MP4 Support Options

        - `none` – MP4 support is disabled for this media.

        - `capped_4k` – Generates MP4 renditions up to 4K resolution.

        - `audioOnly` – Generates an M4A file that contains only the audio track.

        - `audioOnly,capped_4k` – Generates both an audio-only M4A file and MP4 renditions up to 4K resolution.

        #### Webhook events

        - <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediamp4supportready">video.media.mp4Support.ready</a> – Triggered when the MP4 support setting is successfully updated.

        #### Example
        Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting "mp4Support": "capped_4k", the system generates an MP4 rendition of the video up to 4K resolution, making it available for download through the stream URL(`https://stream.fastpix.com/{playbackId}/{capped-4k.mp4 | audio.m4a}`). If you want users to stream only the audio from the media file, you can set "mp4Support": "audioOnly". This provides an audio-only stream URL that allows users to listen to the media without video. By setting "mp4Support": "audioOnly,capped_4k", both options are enabled. Users can download the MP4 video and also stream just the audio version of the media. 


        Related guide: <a href="https://fastpix.com/docs/playback-and-delivery/enable-mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>
      operationId: updated-mp4Support
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: |
            The unique identifier assigned to the media when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - mp4Support
              properties:
                mp4Support:
                  type: string
                  example: capped_4k
                  default: capped_4k
                  enum:
                    - none
                    - capped_4k
                    - audioOnly
                    - audioOnly,capped_4k
                  description: >
                    Determines the type of MP4 support for the media.
                    - **none**: Disables MP4 support.
                    - **capped_4k**: Enables MP4 downloads with resolutions up to 4K.
                    - **audioOnly**: Provides an MP4 stream containing only the audio.
                    - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.
              example:
                mp4Support: capped_4k

      responses:
        "200":
          description: Media details updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    $ref: "#/components/schemas/Media"
                example:
                  success: true
                  data:
                    thumbnail: https://venus-images.fastpix.dev/cf41c9f7-ece3-4efe-8d31-c6e000dc422b/thumbnail.png
                    id: eb56a668-0354-40c2-9233-f3197e1baabd
                    workspaceId: c788be40-91a5-4d2d-abf7-47398a6276a1
                    metadata:
                      key1: value1
                    mediaQuality: standard
                    maxResolution: 1080p
                    sourceResolution: 1080p
                    status: Ready
                    mp4Support: capped_4k
                    sourceAccess: true
                    playbackIds:
                      - id: cf41c9f7-ece3-4efe-8d31-c6e000dc422b
                        accessPolicy: public
                        accessRestrictions:
                          domains:
                            defaultPolicy: allow
                            allow: []
                            deny: []
                          userAgents:
                            defaultPolicy: allow
                            allow: []
                            deny: []
                    tracks:
                      - id: 344fd5bc-82af-4d11-bc1c-785d9e6f9aef
                        type: video
                        width: 1920
                        height: 1080
                        frameRate: 30/1
                        status: available
                    generatedSubtitles: []
                    isAudioOnly: false
                    subtitleAvailable: false
                    duration: "00:00:10"
                    aspectRatio: "16:9"
                    createdAt: "2024-12-06T03:47:26.489888Z"
                    updatedAt: "2024-12-06T03:47:47.593400Z"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/input-info:
    get:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Get info of media inputs
      operationId: retrieveMediaInputInfo
      description: |
        This endpoint lets you retrieve detailed information about the media inputs associated with a specific media item. You can use it to verify the media file’s input URL, track its creation status, and check its container format. You must provide the mediaId (either the uploadId or the id) to fetch this information.


        #### How it works

        Upon making a `GET` request with the mediaId, FastPix returns a response with: 

        * The public storage input `url` of the uploaded media file. 

        * Information about the media’s video and audio tracks, including whether they were successfully created.

        * The container format of the uploaded media file (for example, MP4, MKV).

        This endpoint is particularly useful for ensuring that all necessary tracks (video and audio) have been correctly associated with the media during the upload or media creation process.
      parameters:
        - in: path
          name: mediaId
          description: Pass the list of the input objects used to create the media, along with applied settings.
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        "200":
          description: Get video media input information
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    type: object
                    description: Displays the result of the request.
                    properties:
                      configuration:
                        type: object
                        description: Represents configuration details for the media.
                        properties:
                          url:
                            type: string
                            example: https://static.fastpix.com/fp-sample-video.mp4
                            description: >
                              The URL hosting the media file to be downloaded and processed by FastPix.  
                              Supports formats like MP4, MOV, MKV, TS, MP3, and text tracks (SRT/VTT).  
                              Using standard formats ensures optimal processing speed.
                      file:
                        type: object
                        description: Contains metadata and structural details about the media file.
                        properties:
                          containerFormat:
                            type: string
                            example: mp4
                            description: Specifies the container format that encapsulates audio, video, subtitles, and metadata.
                          tracks:
                            type: array
                            description: A list of all media tracks including video, audio, and subtitles.
                            items:
                              oneOf:
                                - $ref: "#/components/schemas/VideoTrack"
                                - $ref: "#/components/schemas/AudioTrack"
                                - $ref: "#/components/schemas/SubtitleTrack"
                example:
                  success: true
                  data:
                    configuration:
                      url: https://static.fastpix.com/fp-sample-video.mp4
                    file:
                      containerFormat: mp4
                      tracks:
                        - id: 6eb56a83-9a8b-47a5-94b2-cadb4458cf4d
                          type: video
                          width: 1280
                          height: 720
                          frameRate: "30/1"
                          status: available

        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/playback-ids:
    post:
      security:
        - BasicAuth: []
      tags:
        - Playback
      summary: Create a playback ID
      description: |
        You can create a new playback ID for a specific media asset. If you have already retrieved an existing `playbackId` using the <a href="https://fastpix.com/docs/video-on-demand-api/manage-videos/get-media">Get Media by ID</a> endpoint for a media asset, you can use this endpoint to generate a new playback ID with a specified access policy. 



        If you want to create a private playback ID for a media asset that already has a public playback ID, this endpoint also allows you to do so by specifying the desired access policy. 

        #### How it works

        1. Make a `POST` request to this endpoint, replacing `<mediaId>` with the `uploadId` or `id` of the media asset. 

        2. Include the `accessPolicy` in the request body with `private` or `public` as the value. 

        3. You receive a response containing the newly created playback ID with the specified access level.


        #### Example
        A video streaming service generates playback IDs for each media file when users request to view specific content. The video player then uses the playback ID to stream the video.
      operationId: create-media-playback-id
      parameters:
        - in: path
          name: mediaId
          required: true
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
          schema:
            type: string
            format: uuid
            example: dbb8a39a-e4a5-4120-9f22-22f603f1446e
            description: The unique identifier assigned to the media when created. The value must be a valid UUID.
      requestBody:
        required: true
        description: Request body for creating playback id for an media
        content:
          application/json:
            schema:
              type: object
              required:
                - accessPolicy
              properties:
                accessPolicy:
                  $ref: "#/components/schemas/AccessPolicy"
                accessRestrictions:
                  type: object
                  properties:
                    domains:
                      $ref: "#/components/schemas/DomainRestrictions"
                    userAgents:
                      $ref: "#/components/schemas/UserAgentRestrictions"
                drmConfigurationId:
                  type: string
                  format: uuid
                  description: DRM configuration ID (required if accessPolicy is "drm")
                  example: 123e4567-e89b-12d3-a456-426614174000
                resolution:
                  type: string
                  enum:
                    - 480p
                    - 720p
                    - 1080p
                    - 1440p
                    - 2160p
                  description: The maximum resolution for the playback ID.
                  example: 1080p
      responses:
        "201":
          description: Playback ID for a media content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    $ref: "#/components/schemas/CreatePlaybackId"
                example:
                  success: true
                  data:
                    id: b331e0d8-bef4-4ad2-8760-757fdb2818b7
                    accessPolicy: public
                    accessRestrictions:
                      domains:
                        defaultPolicy: allow
                        allow: []
                        deny: []
                      userAgents:
                        defaultPolicy: allow
                        allow: []
                        deny: []
                    resolution: 1080p
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"

    get:
      security:
        - BasicAuth: []
      tags:
        - Playback
      summary: Get all playback IDs details for a media
      description: |
        Retrieves all playback IDs associated with a given media asset, including each playback ID’s access policy and detailed access restrictions such as allowed or denied domains and user agents.
        
        **How it works:**
        1. Send a `GET` request to this endpoint with the target `mediaId`.
        2. The response includes an array of playback ID records with their respective access controls.
        
        **Use case:**
        Useful for validating and managing playback permissions programmatically, reviewing restriction settings, or powering an access control dashboard.

      operationId: list-playback-ids
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 5455b8db-79c7-438e-83b9-c440980214c3
            description: The unique identifier assigned to the media when created. The value must be a valid UUID.
      responses:
        "200":
          description: Successfully retrieved playback IDs and their restrictions
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          example: 54fd5e7e-3aa5-4817-b56d-44932f67f6c3
                          description: Unique identifier of the playback ID.
                        accessPolicy:
                          type: string
                          enum:
                            - public
                            - private
                            - drm
                          example: drm
                          description: The access policy set for the playback ID.
                        accessRestrictions:
                          type: object
                          description: Restrictions applied to this playback ID.
                          properties:
                            domains:
                              type: object
                              properties:
                                defaultPolicy:
                                  type: string
                                  enum:
                                    - allow
                                    - deny
                                  example: allow
                                allow:
                                  type: array
                                  items:
                                    type: string
                                  example: ["example.com", "trustedsite.org"]
                                deny:
                                  type: array
                                  items:
                                    type: string
                                  example: ["malicioussite.com", "abc.net"]
                            userAgents:
                              type: object
                              properties:
                                defaultPolicy:
                                  type: string
                                  enum:
                                    - allow
                                    - deny
                                  example: deny
                                allow:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Mobile Safari/537.36
                                deny:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - PostmanRuntime/7.29.0
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"

    delete:
      security:
        - BasicAuth: []
      tags:
        - Playback
      summary: Delete a playback ID
      description: |
        This endpoint deletes a specific playback ID associated with a media asset. Deleting a `playback ID` revokes access to the media content linked to that ID.


        #### How it works

        1. Make a `DELETE` request to this endpoint, replacing `<mediaId>` with the unique ID of the media asset from which you want to delete the playback ID. 

        2. Include the `playbackId` you want to delete in the request body.

        #### Example

        Your platform offers limited-time access to premium content. When the subscription expires, you can revoke access to the content by deleting the associated playback ID, preventing users from streaming the video further.
      operationId: delete-media-playback-id
      parameters:
        - in: path
          name: mediaId
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
          required: true
          schema:
            type: string
            format: uuid
            example: dbb8a39a-e4a5-4120-9f22-22f603f1446e
            description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        - in: query
          name: playbackId
          description: "Return the universal unique identifier for playbacks  which can contain a maximum of 255 characters. "
          required: true
          schema:
            type: string
            example: dbb8a39a-e4a5-4120-9f22-22f603f1446e
            format: uuid
            description: when creating the plyabackIds, FastPix assigns a universal unique identifier with a maximum of 255 characters.
      responses:
        "200":
          description: Deleted a Playback Id successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                example:
                  success: true
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/upload:
    post:
      security:
        - BasicAuth: []
      tags:
        - Input video
      summary: Upload media from device
      operationId: direct-upload-video-media
      description: |
        This endpoint enables accelerated uploads of large media files directly from your local device to FastPix for processing and storage.

        > **NOTE**
        >
        > This version now supports uploads with no file size limitations and offers faster uploads. The previous endpoint (which had a 500MB size limit) is now deprecated. You can find details in the [changelog](https://fastpix.com/docs/changelog/api-update-direct-upload-media-from-device).

        #### How it works

        1. Send a POST request to this endpoint with optional media settings.  

        2. The response includes an `uploadId` and a signed `url` for direct video file upload.

        3. Upload your video file to the provided url by making a PUT request. The API accepts the media file from your device and uploads it to the FastPix platform. (Refer to <a href="https://fastpix.com/docs/upload-videos/upload-videos-from-device#step-3-initiate-the-upload">Step 3: Initiate the upload</a> for complete instructions.)
        
        
        4. Once uploaded, the media undergoes processing and is assigned a unique ID for tracking. Retain this `uploadId` for any future operations related to this upload. 



        After uploading, you can use the <a href="https://fastpix.com/docs/video-on-demand-api/manage-videos/get-media">Get Media by ID</a> endpoint to check the status of the uploaded media asset and see if it has transitioned to a `Ready` status for playback. 

        To notify your application about the status of this API request check for the webhooks for <a href="https://fastpix.com/docs/webhooks/webhook-event-reference#media-related-events">media related events</a>.  


        #### Example

        A social media platform allows users to upload video content directly from their phones or computers. This endpoint facilitates the upload process. For example, if you are developing a video-sharing app where users can upload short clips from their mobile devices, this endpoint enables them to select a video, upload it to the platform.

        Related guide: <a href="https://fastpix.com/docs/upload-videos/upload-videos-from-device">Upload videos directly</a>
      requestBody:
        required: true
        description: Request body for direct upload
        content:
          application/json:
            schema:
              type: object
              required:
                - corsOrigin
              properties:
                corsOrigin:
                  type: string
                  example: "*"
                  default: "*"
                  description: Upload media directly from a device using the URL name or enter "*" to allow all.
                pushMediaSettings:
                  title: Push Media Settings
                  type: object
                  required:
                    - accessPolicy
                  description: |
                    Configuration settings for uploading and processing media on the FastPix platform.  
                    These settings define how the uploaded video is handled, including access control, resolution, DRM, and optional metadata.  
                    For a complete explanation of how media uploads and processing work, refer to the  
                    <a href="https://fastpix.com/docs/get-started/overview" target="_blank">FastPix Video on Demand Overview</a>.
                  properties:
                    accessPolicy:
                      type: string
                      example: public
                      default: public
                      enum:
                        - public
                        - private
                        - drm
                      description: Determines if access to the streamed content is kept private, drm or available to all.
                    startTime:
                      type: number
                      example: "0"
                      description: Start time indicates where encoding must begin within the video file, in seconds.
                    endTime:
                      type: number
                      example: "60"
                      description: End time indicates where encoding must end within the video file, in seconds.
                    inputs:
                      type: array
                      description: >
                        Add one input object at a time. For example, first add a **WatermarkInput** object.  
                        If you also need a audio, click **Add item** again and select **AudioInput**.  
                        Repeat this process for **SubtitleInput** as needed.
                      items:
                        anyOf:
                          - $ref: "#/components/schemas/VideoInput"
                          - $ref: "#/components/schemas/WatermarkInput"
                          - $ref: "#/components/schemas/AudioInput"
                          - $ref: "#/components/schemas/SubtitleInput"
                    metadata:
                      type: object
                      additionalProperties:
                        type: string
                        maxLength: 255
                      maxProperties: 10
                      example:
                        key1: value1
                      default:
                        key1: value1
                      description: |
                        "Tag a video in "key" : "value" pairs for searchable metadata. Maximum 10 entries, 255 characters each."
                    drmConfigurationId:
                      type: string
                      format: uuid
                      description: UUID of the DRM configuration to be used.
                      example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    title:
                      type: string
                      maxLength: 255
                      example: My Video Title
                      description: Title of the media file.
                    creatorId:
                      type: string
                      maxLength: 255
                      example: 8fa85f64-5717-4562-b3fc-2c963f66afa6
                      description: The unique identifier of the user who created this media.
                    subtitles:
                      type: object
                      description: |
                        Generates subtitle files for audio/video files.
                      properties:
                        languageName:
                          type: string
                          example: english
                          description: Name of the language for the subtitles.
                        metadata:
                          type: object
                          additionalProperties:
                            type: string
                            maxLength: 255
                          maxProperties: 10
                          example:
                            key1: value1
                          description: |
                            "Tag a video in "key" : "value" pairs for searchable metadata. Maximum 10 entries, 255 characters each."
                        languageCode:
                          type: string
                          example: en
                          enum:
                            - en
                            - it
                            - pl
                            - es
                            - fr
                            - ru
                            - nl
                          description: |
                            Language codes (BCP 47 compliant) used for text files.
                    optimizeAudio:
                      type: boolean
                      example: true
                      description: |
                        Enhance the quality and volume of the audio track. This is available for pre-recorded content only.
                    maxResolution:
                      type: string
                      example: 1080p
                      default: 1080p
                      enum:
                        - 2160p
                        - 1440p
                        - 1080p
                        - 720p
                        - 480p
                      description: |
                        Determines the highest quality resolution available.
                    mediaQuality:
                      type: string
                      example: standard
                      default: standard
                      description: The quality tier applied to the media.
                      enum:
                        - standard
                        - pro
                        - premium
                    sourceAccess:
                      type: boolean
                      example: true
                      description: The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it
                    mp4Support:
                      type: string
                      example: capped_4k
                      enum:
                        - capped_4k
                        - audioOnly
                        - audioOnly,capped_4k
                      description: |
                        Generates MP4 video up to 4K ("capped_4k"), m4a audio only ("audioOnly"), or both for offline viewing.
                    summary:
                      type: object
                      properties:
                        generate:
                          type: boolean
                          example: true
                          description: |
                            Enable or disable the summary feature for the media. Set to true to enable summary or false to disable.
                        summaryLength:
                          type: integer
                          example: 100
                          maximum: 250
                          minimum: 30
                          description: |
                            Specifies the desired word count for the generated summary. 
                            - The value must be between **30** and **250** words.
                    chapters:
                      type: boolean
                      example: true
                      description: |
                        Enable or disable the chapters feature for the media. Set to `true` to enable chapters or `false` to disable.
                    namedEntities:
                      type: boolean
                      example: true
                      description: |
                        Enable or disable named entity extraction. Set to `true` to enable or `false` to disable.
                    moderation:
                      type: object
                      properties:
                        type:
                          type: string
                          example: video
                          enum:
                            - video
                            - audio
                            - av
                          description: |
                            Defines the type of input. Possible values include video, audio, av.
                    accessRestrictions:
                      type: object
                      properties:
                        domains:
                          type: object
                          properties:
                            defaultPolicy:
                              type: string
                              enum:
                                - allow
                                - deny
                              description: |
                                Specifies the default access policy for domains. 
                                If set to `allow`, all domains are allowed access unless otherwise specified in the `deny` list. 
                                If set to `deny`, all domains are denied access unless otherwise specified in the `allow` list.
                            allow:
                              type: array
                              items:
                                type: string
                              example:
                                - example.com
                                - trustedsite.org
                              description: |
                                A list of domain names or patterns that are explicitly allowed access. 
                                This list is only effective when the `defaultPolicy` is set to `deny`.
                            deny:
                              type: array
                              items:
                                type: string
                              example:
                                - malicioussite.com
                                - spamdomain.net
                              description: |
                                A list of domain names or patterns that are explicitly denied access. 
                                This list is only effective when the `defaultPolicy` is set to `allow`.
                        userAgents:
                          type: object
                          properties:
                            defaultPolicy:
                              type: string
                              enum:
                                - allow
                                - deny
                              description: |
                                Specifies the default access policy for user agents (browsers, bots, etc.). 
                                If set to `allow`, all user agents are allowed access unless otherwise specified in the `deny` list. 
                                If set to `deny`, all user agents are denied access unless otherwise specified in the `allow` list.
                            allow:
                              type: array
                              items:
                                type: string
                              example:
                                - Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Mobile Safari/537.36
                                - curl/7.68.0
                              description: |
                                A list of user agents (identified by string names or patterns) that are explicitly allowed access. 
                                This list is only effective when the `defaultPolicy` is set to `deny`.
                            deny:
                              type: array
                              items:
                                type: string
                              example:
                                - Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36
                                - PostmanRuntime/7.29.0
                              description: |
                                A list of user agents (identified by string names or patterns) that are explicitly denied access. 
                                This list is only effective when the `defaultPolicy` is set to `allow`.
              example:
                corsOrigin: "*"
                pushMediaSettings:
                  metadata:
                    key1: value1
                  accessPolicy: public
                  maxResolution: 1080p
                  mediaQuality: standard
      responses:
        "201":
          description: Direct upload created successfully
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    $ref: "#/components/schemas/DirectUpload"
                example:
                  success: true
                  data:
                    uploadId: beff5537-de85-42e1-a673-2a405cd94177
                    trial: false
                    status: waiting
                    url: https://storage.googleapis.com/fastpix-uploads-us/8a5ab157-c586-458a-bb2e-caa8a8b76a19/4190bbde-4c34-41e4-b70e-90ba2aa0b79e?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=dev-staging-pub-sub%40fastpix-vms.iam.gserviceaccount.com%2F20250708%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250708T071545Z&X-Goog-Expires=14400&X-Goog-SignedHeaders=host%3Bx-goog-resumable&X-Goog-Signature=7be4a17c181b222f5f70e5156843585dc2a9769d61126d77c7b83413a97256cbb8214aa09a8977ce09c1023148ef0f1f42265ddc436df29e66e00e76fbbed13b01e01bc95d15aa65aef695ef7556a306fad5cdc8bf81049ac17e8e95dd95dc80bac3ca684c584dc7a23494f3b29c2dfe9c039a5152d66dddb603c20409d0fda685981b3dfe0f8e0f34fc983d444fce9bbe0dda750a3eb756d1e2887ffa1aef242f208b157988c5fc5f68aa574dd1ef401162f150bc8d5218156d9655c368b359ad5b12c96d2e69654d4da87f34c4df9f22613cdd88357c448aa1f340e11e482e53156bc18a256e4dcf2b37a0ee875c9c941f978ab660637acfc3ccddb37628e8
                    timeout: 14400
                    corsOrigin: "*"
                    pushMediaSettings:
                      playbackIds:
                        - accessPolicy: public
                          accessRestrictions:
                            domains:
                              defaultPolicy: allow
                              allow: []
                              deny: []
                            userAgents:
                              defaultPolicy: allow
                              allow: []
                              deny: []
                      metadata:
                        key1: value1
                      mediaQuality: standard
                      sourceAccess: false
                      optimizeAudio: false
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/uploads:
    get:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Get all unused upload URLs
      description: |
        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.

        An unused upload URL is a signed URL that gets generated when an user initiates upload but never completed the upload process. This can happen due to reasons like network issues, manual cancellation of upload, browser/app crashes or session timeouts.These URLs remain in the system as "unused" since they were created but never resulted in a successful media file upload.

        #### How it works

         - The endpoint returns metadata for all unused upload URLs in your organization's library.
         - Results are paginated to manage large datasets effectively.
         - Signed URLs expire after 24 hours from creation.
         - Each entry includes full metadata about the unused upload.



        #### Example

        A video management team at a media organization regularly uploads content but often forgets to delete or use unused uploads. These unused uploads have signed URLs that expire after 24 hours and need to be managed efficiently. By using this API, the team can retrieve metadata for all unused uploads, identify expired signed URLs, and decide whether to regenerate URLs, reuse the uploads, or delete them.
      operationId: list-uploads
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 50
            example: 20
          description: Limit specifies the maximum number of items to display per page.
        - in: query
          name: offset
          schema:
            type: integer
            default: 1
            example: 1
          description: Offset determines the starting point for data retrieval within a paginated list.
        - in: query
          name: orderBy
          schema:
            type: string
            example: desc
            default: desc
            $ref: "#/components/schemas/SortOrder"
      responses:
        "200":
          description: List of video media
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    description: Displays the result of the request.
                    type: array
                    items:
                      $ref: "#/components/schemas/UnusedDirectUpload"
                  pagination:
                    $ref: "#/components/schemas/Pagination"
                example:
                  success: true
                  data:
                    - uploadId: 9149264c-6cb9-40d3-9313-95a85c56135e
                      trial: true
                      status: waiting
                      url: https://storage.fastpix.net/uploads/7619ee69-d758-4589-80ee-965f6bfc922c/9149264c-6cb9-40d3-9313-95a85c56135e?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=assets-svc%2F20250109%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250109T084749Z&X-Amz-Expires=14400&X-Amz-SignedHeaders=host&X-Amz-Signature=f0a1e3798792543bff7fed64314cc386f56adc1bc1a65f6d4d9c137c6998b6ce
                      timeout: 14400
                      corsOrigin: "*"
                      pushMediaSettings:
                        playbackIds:
                          - accessPolicy: public
                            accessRestrictions:
                              domains:
                                defaultPolicy: allow
                                allow: []
                                deny: []
                              userAgents:
                                defaultPolicy: allow
                                allow: []
                                deny: []
                        metadata:
                          key1: value1
                        mediaQuality: standard
                  pagination:
                    totalRecords: 100
                    currentOffset: 1
                    offsetCount: 10
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/media-clips:
    get:
      security:
        - BasicAuth: []
      tags:
        - Manage videos
      summary: Get all clips of a media
      description: |
        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: <a href="https://fastpix.com/docs/edit-and-transform-videos/clip-and-trim-videos">Create clips from existing media</a>
      operationId: get-media-clips
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: fc733e3f-2fba-4c3d-9388-2511dc50d15f
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        - in: query
          name: offset
          schema:
            type: integer
            default: 1
            minimum: 1
            example: 5
          description: Offset determines the starting point for data retrieval within a paginated list.
        - in: query
          name: limit
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 50
            example: 20
          description: The number of media clips to retrieve per request.
        - in: query
          name: orderBy
          schema:
            $ref: "#/components/schemas/SortOrder"
          description: The values in the list can be arranged in two ways DESC (Descending) or ASC (Ascending).
      responses:
        "200":
          description: Get media clips
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MediaClipResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/playlists:
    post:
      security:
        - BasicAuth: []
      tags:
        - Playlist
      summary: Create a new playlist
      description: |-
        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. <br> <br>
        ### Playlists can be created in two modes
        - **Manual:** Creates an empty playlist without any initial media items. Use this mode for manual curation, where you add items later in a user-defined sequence.
        - **Smart:** Auto-populates the playlist at creation time based on the filter criteria (for example, a video creation date range) that you provide in the request.
        
        For more details, see <a href="https://fastpix.com/docs/playback-and-delivery/create-and-manage-playlists">Create and manage playlist</a>.

        #### How it works 

         - When you send a `POST` request to this endpoint, FastPix creates a playlist and returns a playlist ID, using which items can be added later in a user-defined sequence.
         - You can create a smart playlist that is auto-populated based on the metadata in the request body.


        #### Example
        An e-learning platform creates a new playlist titled Beginner Python Series through the API. The response returns a unique playlist ID. The platform uses this ID to add a series of video tutorials to the playlist in a defined order. The playlist appears on the frontend as a structured learning path for learners.
      operationId: create-a-playlist
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreatePlaylistRequest"
      responses:
        "201":
          description: Playlist created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/playlistCreatedResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    get:
      security:
        - BasicAuth: []
      tags:
        - Playlist
      summary: Get all playlists
      description: |-
        This endpoint retrieves all playlists in a specified workspace. It allows you to view the collection of manual and smart playlists along with their associated metadata.
        #### How it works

         - When a user sends a GET request to this endpoint, FastPix returns a list of all playlists in the workspace, including details such as playlist IDs, titles, creation mode (manual or smart), and other relevant metadata.
        
        #### Example

          An e-learning platform requests all playlists within a workspace to display an overview of available learning paths. The response includes multiple playlists like "Beginner Python Series" and "Advanced Java Tutorials," enabling the platform to show users a catalog of curated content collections.
      operationId: get-all-playlists
      parameters:
        - name: limit
          in: query
          required: false
          description: The number of playlists to return (default is 10, max is 50).
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 50
            example: 1
        - name: offset
          in: query
          required: false
          description: The page number to retrieve, starting from 1. Use this parameter to paginate the playlist results.
          schema:
            type: integer
            default: 1
            minimum: 1
            example: 1
      responses:
        "200":
          description: Successfully retrieved all playlists
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetAllPlaylistsResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/playlists/{playlistId}:
    get:
      security:
        - BasicAuth: []
      tags:
        - Playlist
      summary: Get a playlist by ID
      description: |-
        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.
        
        
        #### Example
        An e-learning platform requests details for the playlist "Beginner Python Series" by providing its unique `playlistId`. The response includes the playlist"s title, creation mode, and the ordered list of video tutorials contained within, enabling the platform to present the full learning path to users.
      operationId: get-playlist-by-id
      parameters:
        - name: playlistId
          in: path
          required: true
          description: The unique id of the playlist you want to retrieve.
          schema:
            type: string
      responses:
        "200":
          description: Successfully retrieved all playlists
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PlaylistByIdResponse"
              examples:
                manual:
                  summary: Manual playlist (no playOrder)
                  value:
                    success: true
                    data:
                      id: 46d5fce1-683a-457f-86d7-c048bb429505
                      name: My Manual Playlist
                      referenceId: 122q
                      type: manual
                      description: This is a manual playlist.
                      mediaList: []
                      workspaceId: d760b903-86ef-44d6-9b73-334130e0cf2d
                      createdAt: "2025-06-05T09:10:30.655275Z"
                      updatedAt: "2025-06-05T12:23:47.096690Z"
                      mediaCount: 0
                smart:
                  summary: Smart playlist (playOrder required)
                  value:
                    success: true
                    data:
                      id: 46d5fce1-683a-457f-86d7-c048bb429505
                      name: My Smart Playlist
                      referenceId: 122q
                      type: smart
                      description: This Playlist contains videos from December 2024.
                      playOrder: createdDate ASC
                      metadata:
                        createdDate:
                          startDate: "2024-12-11"
                          endDate: "2024-12-12"
                        updatedDate:
                          startDate: "2024-12-11"
                          endDate: "2024-12-12"
                      mediaList: []
                      workspaceId: d760b903-86ef-44d6-9b73-334130e0cf2d
                      createdAt: "2025-06-05T09:10:30.655275Z"
                      updatedAt: "2025-06-05T12:23:47.096690Z"
                      mediaCount: 0
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    put:
      security:
        - BasicAuth: []
      tags:
        - Playlist
      summary: Update a playlist by ID
      description: |-
        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.
        #### How it works

         - When a user sends a PUT request to this endpoint with the `playlistId` and updated name and description in the request body, FastPix updates the playlist metadata accordingly and returns the updated playlist details.

        #### Example
        An e-learning platform updates the playlist titled "Beginner Python Series" to rename it as "Python Basics" and add a more detailed description. The updated metadata is reflected when retrieving the playlist, helping users better understand the playlist content.
      operationId: update-a-playlist
      parameters:
        - name: playlistId
          in: path
          required: true
          description: The unique id of the playlist you want to retrieve.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdatePlaylistRequest"
      responses:
        "200":
          description: Playlist updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/playlistCreatedResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    delete:
      security:
        - BasicAuth: []
      tags:
        - Playlist
      summary: Delete a playlist by ID
      description: |-
        This endpoint allows you to delete an existing playlist from the workspace. After deleted, the playlist and its metadata are permanently removed and cannot be recovered.
        #### How it works
         - When a user sends a DELETE request to this endpoint with the `playlistId`, FastPix removes the specified playlist from the workspace and returns a confirmation of successful deletion.
        
        #### Example
        An e-learning platform deletes an outdated playlist titled "Old Python Tutorials" by providing its unique playlist ID. The platform receives confirmation that the playlist has been removed, ensuring learners no longer see the obsolete content.
      operationId: delete-a-playlist
      parameters:
        - name: playlistId
          in: path
          required: true
          description: The unique id of the playlist you want to delete.
          schema:
            type: string
      responses:
        "200":
          description: Playlist deleted successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PlaylistDeleteResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/playlists/{playlistId}/media:
    patch:
      security:
        - BasicAuth: []
      tags:
        - Playlist
      summary: Add media to a playlist by ID
      description: |-
        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.
        #### How it works

         - When a user sends a PATCH request to this endpoint with the `playlistId` as path parameter and a list of media ID(s) in the request body, FastPix adds the specified media items to the playlist and returns the updated playlist details.
        
        #### Example
        An e-learning platform adds new video tutorials to the "Beginner Python Series" playlist by sending their media IDs in the request. The playlist is updated with the new content, ensuring learners have access to the latest tutorials in sequence.
      operationId: add-media-to-playlist
      parameters:
        - name: playlistId
          in: path
          required: true
          description: The unique id of the playlist you want to perform the operation on.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MediaIdsRequest"
      responses:
        "200":
          description: Added media to playlist successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PlaylistByIdResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    put:
      security:
        - BasicAuth: []
      tags:
        - Playlist
      summary: Change media order in a playlist by ID
      description: |-
        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.
        #### How it works

         - When a user sends a PUT request to this endpoint with the `playlistId` as path parameter and the reordered list of all media IDs in the request body, FastPix updates the playlist to reflect the new media sequence and returns the updated playlist details.
        
        #### Example
        An e-learning platform rearranges the "Beginner Python Series" playlist by submitting a reordered list of media IDs. The playlist now follows the new sequence, providing learners with a better structured learning path.
      operationId: change-media-order-in-playlist
      parameters:
        - name: playlistId
          in: path
          required: true
          description: The unique id of the playlist you want to perform the operation on.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MediaIdsRequest"
      responses:
        "200":
          description: Added media to playlist successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PlaylistByIdResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    delete:
      security:
        - BasicAuth: []
      tags:
        - Playlist
      summary: Delete media in a playlist by ID
      description: |-
        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.
        #### How it works

         - When a user sends a DELETE request to this endpoint with the playlist ID as the path parameter and the media ID(s) to be removed in the request body, FastPix deletes the specified media items from the playlist and returns the updated playlist details.
        
        #### Example
        An e-learning platform removes outdated video tutorials from the "Beginner Python Series" playlist by specifying their media IDs in the request. The playlist is updated to exclude these items, ensuring learners only access relevant content.
      operationId: delete-media-from-playlist
      parameters:
        - name: playlistId
          in: path
          required: true
          description: The unique id of the playlist you want to perform the operation on.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MediaIdsRequest"
      responses:
        "200":
          description: Deleted media from playlist successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PlaylistByIdResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/playback-ids/{playbackId}:
    get:
      security:
        - BasicAuth: []
      tags:
        - Playback
      summary: Get a playback ID
      description: |
        This endpoint retrieves details about a specific playback ID associated with a media asset. Use it to check the access policy for that specific playback ID, such as whether it is public or private.

        **How it works:**
        1. Make a GET request to the endpoint, replacing `{mediaId}` with the media ID and `{playbackId}` with the playback ID.
        2. This request is useful for auditing or validation before granting playback access in your application.

        **Example:**
        A media platform might use this endpoint to verify if a playback ID is public or private before embedding the video in a frontend player or allowing access to a restricted group.
      operationId: get-playback-id
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
            description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        - in: path
          name: playbackId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
            description: The unique identifier assigned to the playback when created. The value must be a valid UUID.
      responses:
        "200":
          description: Successfully retrieved playback ID details
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        example: 54fd5e7e-3aa5-4817-b56d-44932f67f6c3
                        description: Unique identifier of the playback ID.
                      accessPolicy:
                        type: string
                        enum:
                          - public
                          - private
                          - drm
                        example: public
                        description: The access policy set for the playback ID.
                      accessRestrictions:
                        type: object
                        description: Restrictions applied to this playback ID.
                        properties:
                          domains:
                            type: object
                            properties:
                              defaultPolicy:
                                type: string
                                enum:
                                  - allow
                                  - deny
                                example: allow
                              allow:
                                type: array
                                items:
                                  type: string
                                example: ["example.com", "trustedsite.org"]
                              deny:
                                type: array
                                items:
                                  type: string
                                example: ["malicioussite.com", "abc.net"]
                          userAgents:
                            type: object
                            properties:
                              defaultPolicy:
                                type: string
                                enum:
                                  - allow
                                  - deny
                                example: deny
                              allow:
                                type: array
                                items:
                                  type: string
                                example:
                                  - Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Mobile Safari/537.36
                              deny:
                                type: array
                                items:
                                  type: string
                                example:
                                  - PostmanRuntime/7.29.0
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/{mediaId}/playback-ids/{playbackId}/domains:
    patch:
      security:
        - BasicAuth: []
      tags:
        - Playback
      summary: Update domain restrictions for a playback ID
      description: |
        This endpoint updates domain-level restrictions for a specific playback ID associated with a media asset.
        It allows you to restrict playback to specific domains or block known unauthorized domains.
        
        **How it works:**
        1. Make a `PATCH` request to this endpoint with your desired domain access configuration.
        2. Set a default policy (`allow` or `deny`) and specify domain names in the `allow` or `deny` lists.
        3. This is commonly used to restrict video playback to your website or approved client domains.
        
        **Example:**
        A streaming service can allow playback only from `example.com` and deny all others by setting: `"defaultPolicy": "deny"` and `"allow": ["example.com"]`.

      operationId: update-domain-restrictions
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 5ebfa8f7-3ff1-4a35-8b1a-d3a16e22184c
            description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        - in: path
          name: playbackId
          required: true
          schema:
            type: string
            format: uuid
            example: 0199deff-9aef-457e-9461-7a28afdf8773
            description: The unique identifier assigned to the playback when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                defaultPolicy:
                  type: string
                  enum:
                    - allow
                    - deny
                  example: allow
                  default: allow
                  description: Specify the fallback behavior for domains that are not listed in the `allow` or `deny` lists.
                allow:
                  type: array
                  items:
                    type: string
                  example: ["yourdomain.com", "sampledomain.com"]
                  default: ["yourdomain.com"]
                  description: List of domains explicitly allowed to play the media.
                deny:
                  type: array
                  items:
                    type: string
                  example: ["yourworkdomain.com"]
                  default: []
                  description: List of domains explicitly denied from accessing the media.

      responses:
        "200":
          description: Successfully updated domain restrictions
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    type: object
                    properties:
                      defaultPolicy:
                        type: string
                        example: allow
                        description: Specify the fallback behavior for domains that are not listed in the allow or deny lists.
                      allow:
                        type: array
                        items:
                          type: string
                        description: List of domains explicitly allowed to play the media.
                        example: ["yourdomain.com", "yourworkdomain.com"]
                      deny:
                        type: array
                        items:
                          type: string
                        description: List of domains explicitly denied from accessing the media.
                        example: ["sampledomain.com"]
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"

  /on-demand/{mediaId}/playback-ids/{playbackId}/user-agents:
    patch:
      security:
        - BasicAuth: []
      tags:
        - Playback
      summary: Update user-agent restrictions for a playback ID
      description: |
        This endpoint allows updating user-agent restrictions for a specific playback ID associated with a media asset. 
        It can be used to allow or deny specific user-agents during playback request evaluation.
        
        **How it works:**
        1. Make a `PATCH` request to this endpoint with your desired user-agent access configuration.
        2. Specify a default policy (`allow` or `deny`) and provide specific `allow` or `deny` lists.
        3. Use this to restrict access to specific browsers, devices, or bots.
        
        **Example:**
        A developer may configure a playback ID to deny access from known scraping user-agents while allowing all others by default.

      operationId: update-user-agent-restrictions
      parameters:
        - in: path
          name: mediaId
          required: true
          schema:
            type: string
            format: uuid
            example: 5ebfa8f7-3ff1-4a35-8b1a-d3a16e22184c
            description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        - in: path
          name: playbackId
          required: true
          schema:
            type: string
            format: uuid
            example: 0199deff-9aef-457e-9461-7a28afdf8773
            description: The unique identifier assigned to the playback when created. The value must be a valid UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                defaultPolicy:
                  type: string
                  enum:
                    - allow
                    - deny
                  example: allow
                  default: allow
                  description: The default behavior when a user-agent is not listed in `allow` or `deny`.
                allow:
                  type: array
                  items:
                    type: string
                  example:
                    - "Mozilla/55.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36"
                  default:
                    - "Mozilla/55.0 (Macintosh; Intel Mac OS X 10_15_7)"
                  description: List of user-agent substrings explicitly allowed.
                deny:
                  type: array
                  items:
                    type: string
                  example:
                    - "Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/53745.36 (KHTML, like Gecko) Chrome/138.0.0.0 Mobile Safari/537.36"
                  default: []
                  description: List of user-agent substrings explicitly denied.

      responses:
        "200":
          description: Successfully updated user-agent restrictions
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    type: object
                    properties:
                      defaultPolicy:
                        type: string
                        example: allow
                        description: Specifies the default behavior for user agents not listed in the allow or deny lists.
                      allow:
                        type: array
                        items:
                          type: string
                        example: ["Mozilla/55.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36"]
                        description: List of user-agent substrings explicitly allowed.
                      deny:
                        type: array
                        items:
                          type: string
                        example: ["Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/53745.36 (KHTML, like Gecko) Chrome/138.0.0.0 Mobile Safari/537.36"]
                        description: List of user-agent substrings explicitly denied.
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/drm-configurations:
    get:
      tags:
        - DRM configurations
      security:
        - BasicAuth: []
      summary: Get list of DRM configuration IDs
      description: |

        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.

        **How it works:**
        1. Make a GET request to this endpoint.  
        2. Optionally use the `offset` and `limit` query parameters to paginate through the list of DRM configurations.  
        3. The response includes a list of DRM IDs and pagination metadata.

        **Example:**  
        A media service provider may retrieve DRM configuration for a workspace to create DRM content.

        Related guide: <a href="https://fastpix.com/docs/video-security/set-up-drm-encryption">Manage DRM configuration</a>
      operationId: getDrmConfiguration
      parameters:
        - in: query
          name: offset
          schema:
            type: integer
            default: 1
            minimum: 1
            example: 1
          description: Offset determines the starting point for data retrieval within a paginated list.
        - in: query
          name: limit
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 50
            example: 10
          description: Limit specifies the maximum number of items to display per page.
      responses:
        "200":
          description: DRM configuration(s) retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/DrmIdResponse"
                  pagination:
                    $ref: "#/components/schemas/Pagination"
              example:
                success: true
                data:
                  - id: e3dfdf15-16bb-4835-98b9-484c1e4320cc
                pagination:
                  totalRecords: 1
                  currentOffset: 1
                  offsetCount: 1
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /on-demand/drm-configurations/{drmConfigurationId}:
    get:
      tags:
        - DRM configurations
      security:
        - BasicAuth: []
      summary: Get DRM configuration by ID
      description: |

        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.

        **How it works:**
        1. Make a GET request to this endpoint, replacing `{drmConfigurationId}` with the UUID of the DRM configuration.  
        2. The response contains the associated DRM configuration ID.

        Related guide: <a href="https://fastpix.com/docs/video-security/set-up-drm-encryption">Manage DRM configuration</a>
      operationId: getDrmConfigurationById
      parameters:
        - in: path
          name: drmConfigurationId
          required: true
          schema:
            type: string
            format: uuid
            example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier of the DRM configuration.
      responses:
        "200":
          description: DRM configuration retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    $ref: "#/components/schemas/DrmIdResponse"
              example:
                success: true
                data:
                  id: e3dfdf15-16bb-4835-98b9-484c1e4320cc
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /live/streams:
    post:
      security:
        - BasicAuth: []
      tags:
        - Start live stream
      summary: Create a new stream
      description: |-
        Creates a new <a href="https://fastpix.com/docs/get-started/live-overview">RTMPS</a> or <a href="https://fastpix.com/docs/broadcast/live-stream-with-srt">SRT</a> live stream in FastPix. When you create a stream, FastPix generates a unique `streamKey` and `srtSecret` that you can use with broadcasting software such as OBS to connect to FastPix RTMPS or SRT servers. Use SRT for live streaming in unstable network conditions, as it provides error correction and encryption for a more reliable and secure broadcast.
        
        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. 

        <h4>How it works</h4> 

        1. Send a `POST` request to this endpoint. You can configure the stream settings, including `metadata` (such as stream name and description), `reconnectWindow` (in case of disconnection), and privacy options (`public` or `private`). 

        2. FastPix returns the stream details for both RTMPS and SRT configurations. These keys and IDs from the stream details are essential for connecting the broadcasting software to FastPix’s servers and transmitting the live stream to viewers.

        3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://fastpix.com/docs/live-stream-events/live-events#videolive_streamcreated">video.live_stream.created</a>.


        **Example:**


          Imagine a gaming platform that allows users to live stream gameplay directly from their dashboard. The API creates a new stream, provides the necessary stream key, and sets it to "private" so that only specific viewers can access it. 
        
        
        Related guide: <a href="https://fastpix.com/docs/get-started/live-quickstart">How to live stream</a>
      operationId: create-new-stream
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateLiveStreamRequest"
      responses:
        "201":
          description: Stream created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/liveStreamResponseDTO"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    get:
      security:
        - BasicAuth: []
      tags:
        - Manage live stream
      summary: Get all live streams
      description: |-
        Retrieves a list of all live streams associated with the current workspace. It provides an overview of both current and past live streams, including details like `streamId`, `metadata`, `status`, `createdAt` and more.
        
        
        #### How it works

        Use the access token and secret key related to the workspace in the request header. When called, the API provides a paginated response containing all the live streams in that specific workspace. This is helpful for retrieving a large volume of streams and managing content in bulk.
      operationId: get-all-streams
      parameters:
        - name: limit
          in: query
          description: Limit specifies the maximum number of items to display per page.
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 50
            example: 20
        - name: offset
          in: query
          description: Offset determines the starting point for data retrieval within a paginated list.
          schema:
            type: integer
            default: 1
            example: 1
        - name: orderBy
          in: query
          description: The list of value can be order in two ways DESC (Descending) or ASC (Ascending). In case not specified, by default it will be DESC.
          schema:
            type: string
            example: desc
            default: desc
            enum:
              - asc
              - desc
      responses:
        "200":
          description: All streams retrieved sucessfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/getStreamsResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /live/streams/{streamId}/viewer-count:
    get:
      security:
        - BasicAuth: []
      tags:
        - Manage live stream
      summary: Get stream views by ID
      description: |-
        This endpoint retrieves the current number of viewers watching a specific live stream, identified by its unique `streamId`.
        
        The viewer count is an **approximate value**, optimized for performance. It provides a near-real-time estimate of how many clients are actively watching the stream. This approach ensures high efficiency, especially when the stream is being watched at large scale across multiple devices or platforms.
        
        #### Example
        
        Suppose a content creator is hosting a live concert and wants to display the number of live viewers on their dashboard. This endpoint can be queried to show up-to-date viewer statistics.
        
        Related guide: <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>

      operationId: get-live-stream-viewer-count-by-id
      parameters:
        - name: streamId
          in: path
          required: true
          example: 61a264dcc447b63da6fb79ef925cd76d
          description: After creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
      responses:
        "200":
          description: Stream viewer count retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ViewsCountResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /live/streams/{streamId}:
    get:
      security:
        - BasicAuth: []
      tags:
        - Manage live stream
      summary: Get stream by ID
      description: |-
        This endpoint retrieves details 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. 
        #### Example
        
          Suppose a news agency is broadcasting a live event and wants to track the configurations set for the live stream while also checking the stream's status.
        
        
        Related guide: <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
      operationId: get-live-stream-by-id
      parameters:
        - name: streamId
          in: path
          required: true
          example: 61a264dcc447b63da6fb79ef925cd76d
          description: Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
      responses:
        "200":
          description: Stream details retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/livestreamgetResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    delete:
      security:
        - BasicAuth: []
      tags:
        - Manage live stream
      summary: Delete a stream
      description: |-
        Permanently deletes a specified live stream from the workspace. If the stream is active, the encoder is disconnected and ingestion stops immediately. This action is irreversible, and any future playback attempts fail as a result.

          Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. You can further look for <a href="https://fastpix.com/docs/live-stream-events/live-events#videolive_streamdeleted">video.live_stream.deleted</a> webhook to notify your system about the status.

          #### Example
        
          For an online concert platform, a trial stream was mistakenly made public. The event manager deletes the stream before the concert begins to avoid confusion among viewers. 
        
        
          Related guide: <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
      operationId: delete-live-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 8717422d89288ad5958d4a86e9afe2a2
          description: Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
      responses:
        "200":
          description: Stream deleted successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LiveStreamDeleteResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    patch:
      security:
        - BasicAuth: []
      tags:
        - Manage live stream
      summary: Update a stream
      description: |-
        This endpoint allows you to modify the parameters of an existing live stream, such as its `metadata` (title, description) or the `reconnectWindow`. It’s useful for making changes to a stream that has already been created but not yet ended. After 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 returns the updated stream details. After the update, <a href="https://fastpix.com/docs/live-stream-events/live-events#videolive_streamupdated">video.live_stream.updated</a> webhook event notifies your system.

         #### Example
        
         A host realizes they need to extend the reconnect window for their live stream in case they lose connection temporarily during the event. Or suppose during a multi-day online conference, the event organizers need to update the stream title to reflect the next day"s session while keeping the same stream ID for continuity. 
        
        
        
          Related guide: <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
      operationId: update-live-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 91a264dcc447b63da6fb79ef925cd76d
          description: After creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/patchLiveStreamRequest"
      responses:
        "200":
          description: Stream details updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patchResponseDTO"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /live/streams/{streamId}/live-enable:
    put:
      security:
        - BasicAuth: []
      tags:
        - Manage live stream
      summary: Enable a stream
      description: |-
        This endpoint allows you to enable a livestream by transitioning its status from `disabled` to `idle`. After it is enabled, the stream becomes available and ready to accept an incoming broadcast from a streaming tool.
        
        Streams on the trial plan cannot be re-enabled if they are in the `disabled` state.
        
        The `livestreamId` must be provided in the path, and the stream must not already be in an enabled state (`idle`, `preparing`, or `active`).
        
        #### Example
        
        A creator disables a livestream to pause it temporarily. Later, they decide to continue the session. By calling this endpoint with the stream's ID, they can re-enable and restart the same livestream.
        
        Related guide <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
      operationId: enable-live-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 91a264dcc447b63da6fb79ef925cd76d
          description: Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
      responses:
        "200":
          description: Stream details updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LiveStreamDeleteResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /live/streams/{streamId}/live-disable:
    put:
      security:
        - BasicAuth: []
      tags:
        - Manage live stream
      summary: Disable a stream
      description: |-
        This endpoint disables a livestream by setting its status to `disabled`. Use this to stop a livestream when it's no longer needed or must be taken offline intentionally.
        
        A disabled stream can later be re-enabled using the enable endpoint — however, if you're on a trial plan, re-enabling is not allowed once the stream is disabled.
        
        #### Example
        
        A speaker finishes their live session and wants to prevent the stream from being mistakenly started again. By calling this endpoint, the stream is transitioned to a `disabled` state, ensuring it's permanently stopped (unless re-enabled on a paid plan).
        
        Related guide <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
      operationId: disable-live-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 91a264dcc447b63da6fb79ef925cd76d
          description: After creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
      responses:
        "200":
          description: Stream details updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LiveStreamDeleteResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /live/streams/{streamId}/finish:
    put:
      security:
        - BasicAuth: []
      tags:
        - Manage live stream
      summary: Complete a stream
      description: |-
        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.
        
        This operation only works when the stream is in the `active` state.
        
        Completing a stream can help finalize the session and trigger post-processing events like VOD generation.
        
        #### Example
        
        A virtual event ends, and the system or host needs to close the livestream to prevent further streaming. This endpoint ensures the livestream status is changed from `active` to `idle`, indicating it's officially completed.
        
        Related guide <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
      operationId: complete-live-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 91a264dcc447b63da6fb79ef925cd76d
          description: Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
      responses:
        "200":
          description: Stream details updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LiveStreamDeleteResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /live/streams/{streamId}/playback-ids:
    post:
      security:
        - BasicAuth: []
      tags:
        - Live playback
      summary: Create a playbackId
      description: |-
        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. 

          #### Example
        
          A media platform needs to distribute a unique playback ID to users for an exclusive live concert. The platform can also embed the stream on various partner websites.
      operationId: create-playbackId-of-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 8717422d89288ad5958d4a86e9afe2a2
          description: After creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/playbackIdRequest"
      responses:
        "201":
          description: New PlaybackId created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PlaybackIdSuccessResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    delete:
      security:
        - BasicAuth: []
      tags:
        - Live playback
      summary: Delete a playbackId
      description: |-
        Deletes a previously created playback ID for a live stream.This prevents new viewers from accessing the stream using the playback ID, while current viewers can continue watching for a short period before the connection ends. FastPix deletes the ID and ensures the new playback request fails.

        #### Example
        A streaming service wants to prevent new users from joining a live stream that is nearing its end. The host can delete the playback ID to ensure no one can join the stream or replay it once it ends.
      operationId: delete-playbackId-of-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 8717422d89288ad5958d4a86e9afe2a2
          description: Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
        - name: playbackId
          in: query
          required: true
          example: 88b7ac0f-2504-4dd5-b7b4-d84ab4fee1bd
          description: Unique identifier for the playbackId
          schema:
            type: string
      responses:
        "200":
          description: Stream's playbackId deleted successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LiveStreamDeleteResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /live/streams/{streamId}/playback-ids/{playbackId}:
    get:
      security:
        - BasicAuth: []
      tags:
        - Live playback
      summary: Get playbackId details
      description: |-
        Retrieves details for an existing playback ID. When you provide the playbackId returned from a previous stream or playback creation request, FastPix returns the associated playback information, including the access policy.

        #### Example
        A developer needs to confirm the access policy of the playback ID to ensure whether the stream is public or private for viewers.
      operationId: get-live-stream-playback-id
      parameters:
        - name: streamId
          in: path
          required: true
          example: 61a264dcc447b63da6fb79ef925cd76d
          description: After creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
        - name: playbackId
          in: path
          required: true
          example: 61a264dcc447b63da6fb79ef925cd76d
          description: After creating a new playbackId, FastPix assigns a unique identifier to the playback.
          schema:
            type: string
      responses:
        "200":
          description: Stream details retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PlaybackIdSuccessResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /live/streams/{streamId}/simulcast:
    post:
      security:
        - BasicAuth: []
      tags:
        - Simulcast stream
      summary: Create a simulcast
      description: |-
        Creates a simulcast for a parent live stream. Simulcasting allows you to broadcast a live stream to multiple social platforms simultaneously (for example, YouTube, Facebook, or Twitch). This helps expand your audience reach across platforms. A simulcast can only be created when the parent live stream is in the idle state (not currently live or disabled). Only one simulcast target can be created per API call. 
        #### How it works

        1. Change to: When you call this endpoint, provide the parent `streamId` along with the simulcast target details (such as platform and credentials). The API returns a unique `simulcastId`, which you can use to manage the simulcast later.  

        2. To notify your application about the status of simulcast related events check for the <a href="https://fastpix.com/docs/webhooks/webhook-event-reference#simulcast-target-events">webhooks for simulcast</a> target events. 

        #### Example
        An event manager sets up a live stream for a virtual conference and wants to simulcast the stream on YouTube and Facebook Live. They first create the primary live stream in FastPix, ensuring it's in the idle state. Then, they use the API to create a simulcast target for YouTube. 

        Related guide: <a href="https://fastpix.com/docs/edit-and-transform-live-stream/simulcast-to-multiple-platforms">Simulcast to 3rd party platforms</a>
      operationId: create-simulcast-of-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 8717422d89288ad5958d4a86e9afe2a2
          description: After creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulcastRequest"
      responses:
        "201":
          description: New Simulcast created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/simulcastResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /live/streams/{streamId}/simulcast/{simulcastId}:
    delete:
      security:
        - BasicAuth: []
      tags:
        - Simulcast stream
      summary: Delete a simulcast
      description: |-
        Deletes a simulcast using its unique simulcastId, which you received during the simulcast creation process. Deleting a simulcast stops the broadcast to the associated platform, while the parent stream continues if it’s live. This action can’t be undone, and you must create a new simulcast to resume streaming to the same platform.

        Webhook event: <a href="https://fastpix.com/docs/live-stream-events/live-events#videolive_streamsimulcast_targetdeleted">video.live_stream.simulcast_target.deleted</a>


        #### Example
        A broadcaster may need to stop simulcasting to one platform while keeping the stream active on others. For example, a tech company is simulcasting a product launch across multiple platforms. Midway through the event, they decide to stop the simulcast on Facebook due to performance issues but continue streaming on YouTube. They use this API to delete the Facebook simulcast target. 

      operationId: delete-simulcast-of-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 8717422d89288ad5958d4a86e9afe2a2
          description: After creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
        - name: simulcastId
          in: path
          required: true
          example: 9217422d89288ad5958d4a86e9afe2a1
          description: When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
          schema:
            type: string
      responses:
        "200":
          description: Stream's simulcast deleted successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/simulcastdeleteResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    get:
      security:
        - BasicAuth: []
      tags:
        - Simulcast stream
      summary: Get a specific simulcast
      description: |-
        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, and metadata. 

        #### Example
        This endpoint can be used to verify the status of the simulcast on external platforms before the live stream begins. For example, before starting a live gaming event, the organizer wants to ensure that the simulcast to Twitch is set up correctly. They retrieve the simulcast information to confirm that everything is properly configured.
      operationId: get-specific-simulcast-of-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 8717422d89288ad5958d4a86e9afe2a2
          description: After creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
        - name: simulcastId
          in: path
          required: true
          example: 8717422d89288ad5958d4a86e9afe2a2
          description: When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
          schema:
            type: string
      responses:
        "200":
          description: Stream's simulcast details fetched successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/simulcastResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    put:
      security:
        - BasicAuth: []
      tags:
        - Simulcast stream
      summary: Update a simulcast
      description: |-
        Updates the status of a specific simulcast linked to a parent live stream. You can enable or disable the simulcast at any time while the parent stream is active or idle. After the live stream is disabled, the simulcast can no longer be modified.

        Webhook event: <a href="https://fastpix.com/docs/live-stream-events/live-events#videolive_streamsimulcast_targetupdated">video.live_stream.simulcast_target.updated</a>

        #### Example
        When a `PATCH` request is made to this endpoint, the API updates the status of the simulcast. This can be useful for pausing or resuming a simulcast on a particular platform without stopping the parent live stream.
      operationId: update-specific-simulcast-of-stream
      parameters:
        - name: streamId
          in: path
          required: true
          example: 9714422d89287ad5758d4a86e9afe1a2
          description: Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
          schema:
            type: string
        - name: simulcastId
          in: path
          required: true
          example: 8717422d89288ad5958d4a86e9afe2a2
          description: When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulcastUpdateRequest"
      responses:
        "200":
          description: Stream's simulcast details fetched successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/simulcastUpdateResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /iam/signing-keys:
    post:
      tags:
        - Signing keys
      summary: Create a signing key
      operationId: create_signing_key
      description: |-
        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 is returned in the response, encoded in Base64 format. You also receive a unique key ID to reference the key in future operations. FastPix securely stores the public key to validate signed tokens. 


        <h4>Instructions</h4> 
        
        
        **Private key handling:** The privateKey you receive is encoded in Base64. To use it, decode the value using Base64 decoding. Make sure to store this private key securely, as it is required for signing tokens. 
        
        
        **Key-ID:** The ID is used to reference this specific key pair in future API requests or configurations.
        
        
        After the key pair is generated, the developer must securely store the private key because FastPix does not save it. The public key is used by FastPix to verify signed tokens and ensure that the client interacting with the system is legitimate.
        
        
        
        
        
        <h4>Use case scenario</h4> 
        
        
        
        **Use case:** A developer building a video subscription service wants to ensure that only authorized users can access premium content. By generating a signing key, the developer can issue signed JSON Web Tokens (JWTs) to authenticate and authorize users. These tokens can be validated by FastPix using the stored public key. 
        
        
        **Detailed example:**  You are building a video-on-demand platform that restricts access based on user subscriptions. To ensure only subscribed users can stream content, you generate a signing key using this API. Each time a user logs in, you create a JWT signed with the private key. When the user attempts to play a video, FastPix uses the public key to verify the token and confirms that the user is authorized.<br/>
        Related guide: <a href="https://fastpix.com/docs/video-security/secure-media-access-with-jwts">Create and use signing keys</a>
      security:
        - BasicAuth: []
      responses:
        "201":
          description: created a signing key successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateResponse"
              example:
                success: true
                data:
                  id: fc9d9368-6ee5-4b16-ae50-880a2374bdc4
                  privateKey: LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUV2Z0lCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktnd2dnU2tBZ0VBQW9JQkFRREtaN1JKT1IrbXZGeVQxSWFIL0hVUkYwQnRncDJzK0srdUd4TUZ4N1JiaGNudVBMYU14WjM1b0lNWndhdHJrdDFDM3JxVFZsQzBsSnExeENFTyt3Zi9JNHQ0bktmUFB2WG83NGFCQi82YmR0MXpaSHp0OGFIenBnL3YrdEtCWVc5SEdWQ0tYc2JpNjczbHgwcFhHdXVnem8wdnZMR2lKWDBiL0Z4WEI5U1R3RkV5Q1dQOFJhczZ3VWVuSUdVM2UwMmJiV3Z4UnNoMWNER2xSRk03RWw2RVQ2MUQrS0tLTndnUGNYR1pvY0YwZTFxRU5iVGdPZUdBMFNDU0xIT3NtQ0NBQTNtSndJS1VaY0Z2MmpGRUx4Uk5MTnhoMjM5UEdUT3BuWmdvTFp5Skt4b2REN1FpV1N1eDVZY1Z0MFgrSk9rZXNBOEpjM1ZtM0tGc0IwL3RYck9QQWdNQkFBRUNnZ0VBUHhNWUxLVmZocTgyVGw4eFdWbEVCZ0p2OG5COHdIVnpFZGVnRXZJTDgyVjY2d0lDaFZYa0IvR01TVStBSXZMT2Z0TTM0MGhIdUM2REU5ZTkwWlJMQnFoR0ExMFdNbEJWZzdSNC91YkY0aDZsbmhzWGozTDRYQnhJNVNrTnhvSGRrcE9COU16YVA4YmxFNkVLT3FES0F2KzdJY0EwdnVuZDFnWExwTmRzMkduTW5nZW1qOUhJZWh1eTNLY0taNHlheFo1YkRKVEpLZlFrTlFDQzhOR0hIdWovQmRWUnU1RHRrZVdNMFFpN2FKeW5lSXRxOGhtbXdxcVNMTnpTOTZtcHpBdzF3RzFXTHVML1A3TGxJekVWa2ZJUFc0SW1zRXhsSG5FUG0ySld1RUNMQ1pRL25NODdhQXVXekROektCYW51LzZhdXhnSDB2Wnc5YWowTmxNNFFRS0JnUURPM3Y0YlN4bWluZGJpVEdSaXdFVXVyODh4TVA3M2U5RSt2SHlzb3JZMWZycFpkdXJHOVlFb09MUFN1YnQ5WkhZNFhGOFhxRWZ4bE94d294eDVzcU9PcGNMTnFnOWhTSWxPaXEyYmVnN2V2RGpOMml6b3JKRFl3VEhGQ0Era25FbmFpL0J2TU16N3AyVVkrUEEzUnJ4Z25BK3RkQlErZWlSZ1c0WmhnMkhWcndLQmdRRDZlVEpwRTRxZVFYdmpnMy9FS081UkllRklZOHphTGMvMVVHODBqNmVvbStNK3UyTmdUVDJqVmNyMkdQbjZTbHRNRlJNem5qOVJHYmQ1MCt5a2k0Y1NYU1JPdE44alV2M0FseHJtZzEwVTVtSWIrUXFIZ3g2QldyeXkvakxHYXVvMUJnVFg1dDZ0VXVEUUZuVDJSM2xoNGRNZ044T3V4VlR3OCtadGloSllJUUtCZ1FERE00ZHpHWnBHNThrc0lBbFpaVFBpcWVKSCtJT2Q0eWUrbXZ6SnFYOWxXdjljQytuZGN5czhXTVRWd293MzllUFhxdEhQOE9weCtxUmdaSWtxREhabzArRE5UL3JUUVM3Ty9leHpHT21QSXV3MjBmZ3VWU2NZWUxRbHgwVjdmajN5Q3JvRk1YYzZ2dW1XZHMrMFdQckg3bnFjb1R1NCtHZjZ4R0k1QVUvLzRRS0JnUUR6TFcvdjdIVU1xTzhyT0tSM1FuWCtkekpPSWZibGJNMFdrdjBrdnNROFF2MGlEclN3N3MwRkkycGwvR0hXeXhKUWo3V1F5L2NWT2k2VUxWajNlQyt2ZUphamc1K1FvQ2FWTVIrQTVkRWRWWCt6UU5za0xmMFVBWkJyQjdrc1F1a1lpYnR5RWtmblp5dTFXOWc2czdINWdsS0VXUiszTXdjQTJRdkRGZVl4Z1FLQmdDWVdlKzQ4bVVaUEl5ZnR4NVFaQllnYTE2blpndzYxZmxtdEdpQlVGWGVMR3BTaU1XNXc5R3RYVDZPbFh1Zy91TkNKbHR4TDE4c0NEeDNVaU9DNWFTMEN4OTc5TlFrSm1YRWw1UDNtMFNGaVU4VlZ0SFp1dHd3SWFKTFZockZ1T3NJV1BtRFN4aHhMaFpPNmJ5aWRwbHlXLzl1eGpwMlZrQ0Y3OGd5QXRRSWsKLS0tLS1FTkQgUFJJVkFURSBLRVktLS0tLQo=
                  createdAt: "2024-01-11T10:00:06.618993Z"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    get:
      tags:
        - Signing keys
      summary: Get list of signing key
      operationId: list_signing_keys
      description: |-
        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. 




        <h4>How it works</h4> 
        
        
        The API returns the list in a paginated format, allowing you to audit and track all keys used for your application. Regularly reviewing this list is essential for ensuring that old or compromised keys are promptly revoked and that new keys are properly integrated into workflows. 
        
        
        
        
        <h4>Use case scenario</h4> 
        
        
        
        **Use case:** A security-conscious development team wants to ensure they follow a key rotation policy, rotating signing keys every few months. By retrieving the list of signing keys, they can identify which keys are still in use and which ones need to be rotated. 
        
        
        **Detailed example:**  You manage a multi-region video platform where teams in different regions use their own signing keys. To comply with your organization’s security policies, you regularly review the list of signing keys to verify which ones are still active. You notice that some keys haven’t been used for several months. Based on their creation dates, you decide to rotate those keys.
      security:
        - BasicAuth: []
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 10
            example: 25
          description: Limit specifies the maximum number of items to display per page.
        - in: query
          name: offset
          schema:
            type: integer
            minimum: 1
            default: 1
            example: 1
          description: "It is used for pagination, indicating the starting point for fetching data.  "
      responses:
        "200":
          description: successfully fetched all signing keys
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetAllSigningKeysResponse"

        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /iam/signing-keys/{signingKeyId}:
    delete:
      tags:
        - Signing keys
      summary: Delete a signing key
      operationId: delete_signing_key
      description: |-
        This endpoint allows you to delete an existing signing key, and the action is permanent. After a key is deleted, any signatures or tokens generated with that key become invalid immediately. This means you can no longer use the key to sign JSON Web Tokens (JWTs) or authenticate API requests. 
        <h4>Usage</h4> 
        To delete a signing key, provide the unique key ID that you obtained when creating the key. This key id serves as the identifier for the specific signing key you want to remove from your account. 
        
        
        
        <h4>How it works</h4> 

        When you specify the keyId, the API removes the signing key from the system. After the key is deleted, any API requests or tokens that rely on it fail. This action is useful when a key is compromised or when rotating keys as part of security policies. 
        
        
        
        <h4>Use case scenario</h4> 
        
        
        **Use case:** A key used by an outdated application version has been compromised, or a developer accidentally leaked it. To prevent unauthorized access, the developer deletes the signing key, revoking its ability to sign requests immediately. 
        
        
        **Detailed example:**  Suppose you have a signing key used for a specific version of your mobile app, and you discover that the key has been compromised due to a security breach. To mitigate the issue, you delete the key to invalidate any tokens generated using it. As soon as the key is deleted, users on the compromised version of the app can no longer make valid requests, thus preventing further exploitation.
      security:
        - BasicAuth: []
      parameters:
        - name: signingKeyId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: 3ta85f64-5717-4562-b3fc-2c963f66afa6
          description: When creating the signing key, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
      responses:
        "200":
          description: successfully fetched all signing keys
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteSigningKeyResponse"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
    get:
      tags:
        - Signing keys
      summary: Get signing key by ID
      operationId: get-signing_key_by_id
      description: |-
        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 can view the key’s creation date, status, and other associated metadata. This endpoint also returns the workspaceId and publicKey in the response. 


        <h4>Usage: Generating a JWT token</h4> 

        In the response, the API returns the workspaceId and publicKey associated with the signing key. With the publicKey and the privateKey obtained from the "Create a Signing Key" endpoint, you can generate a JSON Web Token (JWT) using the RS256 algorithm. This token can be utilized for accessing private media assets, GIFs, thumbnails, and spritesheets. 
        
        
        
        <h4>Payload:</h4> 
        
        
        ```
        { 
          "kid": "359302ee-2446-4afe-9348-8b4656b9ddb1", 
          "aud": "media:6cee6f85-9334-4a51-9ce3-e0241d94ceef", 
          "iss": "fastpix.com", 
          "sub": "", 
          "iat": 1706703204, 
          "exp": 1735626783 

        } 
        ```
        
        
        
        * **kid:** The key ID of the signing key. 
        * **aud:** The audience for which the token is intended, enter the playbackId here.
        * **iss:**  The issuer of the token (for example, "fastpix.com "). 
        * **sub:** The subject of the token, typically representing the user or entity the token is issued for. In this case, use the workspaceId fetched from the "Get Signing Key by ID" endpoint. 
        * **groups:** An array of groups the subject belongs to (for example, ["user"]).
        * **iat:** The issued-at timestamp, indicating when the token was created. 
        * **exp:** The expiration timestamp, indicating when the token will no longer be valid. 
        
        
        
        
        
        <h4>Use case scenario</h4> 
        
        
        
        **Use case:** A developer is unsure about the status of a signing key they created months ago and wants to verify whether it's still in use or has expired. 
        
        
        
        **Detailed example:**  You’re working on a streaming platform and realize you haven’t checked the status of a signing key that was used for playback access several months ago. By fetching the key details using its ID, you can confirm whether it’s still active, when it was created, and if it’s nearing expiration. This allows you to plan a rotation or deactivation if needed.
      security:
        - BasicAuth: []
      parameters:
        - name: signingKeyId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: 5ta85f64-5717-4562-b3fc-2c963f66afa6
          description: "When creating the signing key, FastPix assigns a universally unique identifier with a maximum length of 255 characters. "
      responses:
        "200":
          description: successfully fetched signing key
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/getPublicPemUsingSigningKeyIdResponseDTO"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /data/viewlist:
    get:
      security:
        - BasicAuth: []
      tags:
        - Views
      summary: List video views
      operationId: list_video_views
      description: |-
        Retrieves a list of video views that fall within the specified filters and have been completed within a defined timespan. It lets you to analyse viewer interactions with your video content effectively. 


        #### How it works

          1. Send a `GET` request to this endpoint with the desired query parameters. 

          2. Specify the timespan for which you want to retrieve the video views using the `timespan[]` parameter. 

          3. Filter the views based on dimensions such as browser, device, video title, viewer ID, etc., using the `filterby[]` parameter. Get the dimensions by calling <a href="https://fastpix.com/docs/video-data-api/dimensions/list-dimensions">list the dimensions</a> endpoint. 

          4. Paginate the results using the `limit` and `offset` parameters. 

          5. You can also filter by `viewerId`, `errorCode`, `orderBy` a specific field, and `sortOrder` in ascending or descending order. 

          6. You receive a response containing the list of video views matching the specified criteria.

        Each view in the response includes a unique `viewId`. You can use this `viewId` with the  <a href="https://fastpix.com/docs/video-data-api/views/get-video-view-details">Get Video View Details</a> endpoint to retrieve more detailed information about that specific view.


        #### Example

        If you manage a video streaming service and want to analyze content performance across devices and browsers. By calling the List Video Views endpoint with filters such as `browser_name` and `device_type`, you can identify which platforms are most popular with your audience. This information helps optimize content for widely used platforms and troubleshoot playback issues on less common devices.


          Related guide: <a href="https://fastpix.com/docs/concepts/audience-metrics">Audience metrics</a>, <a href="https://fastpix.com/docs/working-with-video-data/explore-the-dashboard#1-views-dashboard">Views dashboard</a>
      parameters:
        - in: query
          name: timespan[]
          description: |
            This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
            
            **Accepted formats are:**

            array of epoch timestamps for example  
            `timespan[]=1498867200&timespan[]=1498953600`
            
            duration string for example  
            `timespan[]=24:hours` or `timespan[]=7:days`

          style: form
          explode: true
          schema:
            type: string
            example: 24:hours
            enum:
              - 60:minutes
              - 6:hours
              - 24:hours
              - 3:days
              - 7:days
              - 30:days
        - in: query
          name: filterby[]
          description: |
            Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint.
            Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]
          style: form
          explode: true
          schema:
            type: string
            example: browser_name:Chrome
        - in: query
          name: limit
          description: |
            Pass the limit to display only the rows specified by the value.
          schema:
            type: integer
            example: 10
            default: 10
        - in: query
          name: offset
          description: |
            Pass the offset value to indicate the page number.
          schema:
            type: integer
            example: 1
            default: 1
        - in: query
          name: viewerId
          description: |
            Pass the viewer_id to filter the list of views. This value can be manually set during integration or generated by FastPix. When set manually it can be a string of aplha numeric values of any length.
          schema:
            type: string
            example: 09a78f7d-02ee-44f5-aa39-1b268ed2c270
        - in: query
          name: errorCode
          description: |
            Pass the error code to filter the list of views. The possible values of error code can be fetched from list of errors end point.
          schema:
            type: string
            nullable: true
            example: 1002
        - in: query
          name: orderBy
          description: |
            Pass this value to sort the view list by.
          schema:
            type: string
            example: view_end
            default: view_end
        - in: query
          name: sortOrder
          description: |
            The order direction to sort the view list by.
          schema:
            type: string
            example: asc
            default: asc
      responses:
        "200":
          description: Get the list of Views
          content:
            application/json:
              schema:
                example:
                  success: true
                  data:
                    - viewId: 92752c49-1bce-4cf8-bea4-5c2c2ac7575d
                      operatingSystem: MacOS
                      application: Chrome
                      viewStartTime: "2024-04-15T04:43:44"
                      viewEndTime: "2024-04-15T04:44:05"
                      videoTitle: "Champion Engagement Model: Best practices for identifying and engaging your champion"
                      errorCode: null
                      errorMessage: null
                      errorId: null
                      country: IN
                      viewWatchTime: 10016
                      QoeScore: 0.955924359113425
                    - viewId: aa3f20e4-6065-4c7c-aed5-c7f8d127bcba
                      operatingSystem: MacOS
                      application: Chrome
                      viewStartTime: "2024-04-15T11:31:48"
                      viewEndTime: "2024-04-15T11:32:30"
                      videoTitle: How to reduce time-to-value for your customers
                      errorCode: null
                      errorMessage: null
                      errorId: null
                      country: IN
                      viewWatchTime: 31926
                      QoeScore: 0.958520302068513
                    - viewId: d7e6929a-9b7f-4f88-a8eb-033fb9e6dc6d
                      operatingSystem: MacOS
                      application: Chrome
                      viewStartTime: "2024-04-15T20:34:42"
                      viewEndTime: "2024-04-15T20:35:00"
                      videoTitle: Implementing projects the ISRO way
                      errorCode: null
                      errorMessage: null
                      errorId: null
                      country: IN
                      viewWatchTime: 17562
                      QoeScore: 0.958648125844009
                    - viewId: eca6400a-73e9-4250-8d0a-cb1cda15fed4
                      operatingSystem: MacOS
                      application: Chrome
                      viewStartTime: "2024-04-15T20:38:48"
                      viewEndTime: "2024-04-15T20:39:23"
                      videoTitle: Designing your onboarding and adoption journey
                      errorCode: null
                      errorMessage: null
                      errorId: null
                      country: IN
                      viewWatchTime: 34823
                      QoeScore: 0.956301364903515
                    - viewId: 687b3a54-6646-4343-bfbe-459742042f54
                      operatingSystem: MacOS
                      application: Chrome
                      viewStartTime: "2024-04-16T09:20:34"
                      viewEndTime: "2024-04-16T09:21:24"
                      videoTitle: How to Approach an Irate Customer With Mimecast"s Alice Jeffery
                      errorCode: null
                      errorMessage: null
                      errorId: null
                      country: IN
                      viewWatchTime: 13493
                      QoeScore: 0.472563044953793
                    - viewId: c1464fdb-f3f8-4ccd-8914-94e1851e8459
                      operatingSystem: MacOS
                      application: Chrome
                      viewStartTime: "2024-04-16T09:22:42"
                      viewEndTime: "2024-04-16T09:22:45"
                      videoTitle: How to Approach an Irate Customer With Mimecast"s Alice Jeffery
                      errorCode: null
                      errorMessage: null
                      errorId: null
                      country: IN
                      viewWatchTime: 1
                      QoeScore: 0.5
                  pagination:
                    totalRecords: 27
                    currentOffset: 1
                    offsetCount: 3
                  timespan:
                    - 1712910924
                    - 1713515724
                type: object
                properties:
                  success:
                    type: boolean
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    type: array
                    description: Displays the result of the request.
                    items:
                      $ref: "#/components/schemas/ViewsList"
                  pagination:
                    $ref: "#/components/schemas/DataPagination"
                  timespan:
                    $ref: "#/components/schemas/TimeSpan"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /data/viewlist/{viewId}:
    get:
      security:
        - BasicAuth: []
      tags:
        - Views
      summary: Get details of video view
      operationId: get_video_view_details
      description: |-
        Retrieves detailed information about a specific video view using its unique `viewId`. This provides insights into individual viewer interactions with your video content, helping you enhance user experience and improve engagement with your videos. 

        To use this endpoint, send `GET` request with the `viewId`. The response includes detailed metrics and attributes related to the specified video view. 


        #### Example

        If a developer receives a report of a poor viewing experience for a specific user. By using this endpoint with the users `viewId`, the developer can retrieve metrics like buffering duration, playback errors, and session length. This data allows the developer to pinpoint issues (such as poor connectivity or a browser-specific problem) and take steps to improve the user experience.


        Related guide: <a href="https://fastpix.com/docs/concepts/what-video-data-do-we-capture#/">What Video Data do we capture?</a>
      parameters:
        - in: path
          name: viewId
          description: Pass View Id
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Get a video view by id
          content:
            application/json:
              schema:
                example:
                  success: true
                  data:
                    asnId: 55836
                    asnName: AS55836 Reliance Jio Infocomm Limited
                    averageBitrate: 1512855.0
                    avgDownscaling: 0.0
                    avgRequestLatency: 0.0
                    avgRequestThroughput: 1.2588331E7
                    avgUpscaling: 0.0
                    beaconDomain: metrix.ws
                    browserEngine: null
                    browserName: Chrome
                    browserVersion: Chrome 5.8.3
                    bufferCount: 0
                    bufferFill: 0
                    bufferFrequency: 0.0
                    bufferRatio: 0.0
                    cdn: null
                    city: Gaddi Annaram
                    connectionType: cellular
                    continent: AS
                    country: India
                    countryCode: IN
                    custom:
                      Custom:
                        - dimensionName: custom_1
                          displayName: displayName-1
                          value: ShortVideo
                    deviceManufacturer: vivo
                    deviceModel: V2130
                    deviceName: V2130
                    deviceType: Mobile
                    drmType: null
                    droppedFrameCount: 0
                    errorCode: null
                    errorContext: null
                    errorId: null
                    errorMessage: null
                    exitBeforeVideoStart: false
                    experimentName: null
                    fpApiVersion: 1.0
                    fpEmbed: false
                    fpEmbedVersion: 1.0.0
                    fpLiveStreamId: null
                    fpPlaybackId: null
                    fpSdk: media3_fastpix
                    fpSdkVersion: 1.0.0
                    fpViewerId: 36c707a3-7f9a-48ab-9ba4-416617d20889
                    insertTimestamp: 2025-09-24T07:33:53.39Z
                    ipAddress: 192.168.136.251
                    jumpLatency: 72.0
                    latitude: 17.366900
                    liveStreamLatency: null
                    longitude: 78.524200
                    maxDownscaling: 0.0
                    maxRequestLatency: 0.0
                    maxUpscaling: 0.0
                    mediaId: null
                    osName: Android
                    osVersion: Android 14
                    pageContext: null
                    pageLoadTime: 0
                    playbackScore: 1.0
                    playerAutoplayOn: false
                    playerHeight: 383
                    playerInitializationTime: 0
                    playerInstanceId: 859e3520-acb7-44fc-b856-69aa364de566
                    playerLanguage: null
                    playerName: null
                    playerPoster: null
                    playerPreloadOn: false
                    playerRemotePlayed: false
                    playerResolution: 393x383
                    playerSoftwareName: media3-generic
                    playerSoftwareVersion: 1.6.1
                    playerSourceDomain: null
                    playerSourceHeight: 720
                    playerSourceWidth: 1280
                    playerVersion: null
                    playerViewCount: 0
                    playerWidth: 393
                    propertyId: null
                    qualityOfExperienceScore: 0.9697980416156672
                    region: Telangana
                    renderQualityScore: 1.0
                    sessionId: 8c7859bf-6d0c-4de8-a1d7-a3d8bdecc977
                    sign: 1
                    stabilityScore: 1.0
                    startupScore: 0.8901746967842439
                    subPropertyId: null
                    totalStartupTime: 987
                    updatedTimestamp: 2025-09-24T07:33:55.074Z
                    usedFullScreen: false
                    userAgent: Dalvik/2.1.0 (Linux; U; Android 14; V2130 Build/UP1A.231005.007)
                    videoContentType: null
                    videoDuration: null
                    videoEncodingVariant: null
                    videoId: 68d3780f38aec4265abe453a
                    videoLanguage: null
                    videoProducer: null
                    videoResolution: 720X1280
                    videoSeries: null
                    videoSourceDomain: null
                    videoSourceDuration: 30120
                    videoSourceHostname: unknown
                    videoSourceStreamType: null
                    videoSourceType: null
                    videoSourceUrl: null
                    videoStartupFailed: false
                    videoStartupTime: 987
                    videoTitle: Best practices for identifying and engaging your champion
                    videoVariantId: null
                    videoVariantName: null
                    viewEnd: 2025-09-24T07:33:55.074Z
                    viewHasAd: false
                    viewHasError: false
                    viewId: 202b8e4f-c078-4b98-88c8-6f7c23ba7272
                    viewMaxPlayheadPosition: 0
                    viewPageUrl: null
                    viewPlayingTime: 0
                    viewSeekedCount: 1
                    viewSeekedDuration: 72
                    viewSessionId: 059c5bc2-12fc-45f1-b893-db9f1d0bf7d1
                    viewStart: 2025-09-24T07:33:53.39Z
                    viewTotalContentPlaybackTime: 0
                    viewerId: null
                    watchTime: 987
                    workspaceId: fdae281f-b582-4ea0-8694-15fccd1cbd98
                    events:
                      - pt: 0
                        e: playerReady
                        vt: 1713156224677
                      - pt: 0
                        e: viewBegin
                        vt: 1713156224677
                      - pt: 0
                        e: play
                        vt: 1713156224677
                      - pt: 0
                        e: waiting
                        vt: 1713156224677
                      - pt: 0
                        e: loadstart
                        vt: 1713156224677
                      - pt: 0
                        e: playing
                        vt: 1713156224677
                      - pt: 0
                        e: variantChanged
                        vt: 1713156224677
                      - pt: 0
                        e: seeking
                        vt: 1713156224677
                      - pt: 0
                        e: pause
                        vt: 1713156224677
                      - pt: 0
                        e: ended
                        vt: 1713156224677
                      - pt: 0
                        e: viewCompleted
                        vt: 1713156224677
                type: object
                properties:
                  success:
                    description: Shows the request status. Returns true for success and false for failure.
                    type: boolean
                  data:
                    $ref: "#/components/schemas/Views"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /data/viewlist/top-content:
    get:
      security:
        - BasicAuth: []
      tags:
        - Views
      summary: List by top content
      operationId: list_by_top_content
      description: |
        Retrieves a list of the top video views that fall within the specified filters and have been completed within a defined timespan. It lets you to identify the most popular content based on viewer interactions. 

        #### How it works

          1. Send a `GET` request to this endpoint with the desired query parameters. 

          2. Specify the timespan for which you want to retrieve the top content using the `timespan[]` parameter. 

          3. Filter the views based on dimensions such as browser, device, video title, etc., using the `filterby[]` parameter. 

          4. You can use `Limit` to control number of top views returned. 

          5. You receive a response containing the list of top video views matching the specified criteria.


          Related guide: <a href="https://fastpix.com/docs/working-with-video-data/identify-top-performing-content">Get top-performing content</a>
      parameters:
        - in: query
          name: timespan[]
          description: |
            This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
            
            **Accepted formats are:**

            array of epoch timestamps for example  
            `timespan[]=1498867200&timespan[]=1498953600`
            
            duration string for example  
            `timespan[]=24:hours` or `timespan[]=7:days`
          style: form
          explode: true
          schema:
            type: string
            example: 24:hours
            enum:
              - 60:minutes
              - 6:hours
              - 24:hours
              - 3:days
              - 7:days
              - 30:days
        - in: query
          name: filterby[]
          description: |
            Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint.
            Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]
          style: form
          explode: true
          schema:
            type: string
            example: browser_name:Chrome
        - in: query
          name: limit
          description: |
            Pass the limit to display only the rows specified by the value.
          schema:
            type: integer
            example: 10
            default: 10
      responses:
        "200":
          description: Get the list of Views
          content:
            application/json:
              schema:
                example:
                  success: true
                  data:
                    - videoTitle: Cycle
                      views: 44
                      uniqueViews: 40
                  timespan:
                    - 1712910924
                    - 1713515724
                type: object
                properties:
                  success:
                    type: boolean
                    description: Shows the request status. Returns true for success and false for failure.
                  data:
                    type: array
                    description: Displays the result of the request.
                    items:
                      $ref: "#/components/schemas/ViewsByTopContentDetails"
                  timespan:
                    $ref: "#/components/schemas/TimeSpan"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /data/dimensions:
    get:
      security:
        - BasicAuth: []
      tags:
        - Dimensions
      summary: List the dimensions
      description: |
        Retrieves a list of dimensions that can be used 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 <a href="https://fastpix.com/docs/video-data-api/views/list-video-views">list video views</a> and <a href="https://fastpix.com/docs/video-data-api/views/list-by-top-content">list by top content</a> endpoints to filter results based on specific criteria. For example, you can filter views by `browser_name`, `os_name`, `device_type`, and more.

        Related guides: <a href="https://fastpix.com/docs/concepts/what-video-data-do-we-capture#/">What Video Data do we capture?</a> ,   <a href="https://fastpix.com/docs/working-with-video-data/pass-custom-metadata-to-metrics">Use passable dimensions</a>
      operationId: list_dimensions
      responses:
        "200":
          description: Get the list of Views
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    description: Shows the request status. Returns true for success and false for failure.
                    type: boolean
                    example: true
                  data:
                    $ref: "#/components/schemas/Dimensions"
                    description: Displays the result of the request.
                    example:
                      - browser_name
                      - browser_version
                      - os_name
                      - os_version
                      - device_name
                      - device_model
                      - device_type
                      - device_manufacturer
                      - player_remote_played
                      - player_name
                      - player_version
                      - player_software_name
                      - player_software_version
                      - player_resolution
                      - fp_sdk
                      - fp_sdk_version
                      - player_autoplay_on
                      - player_preload_on
                      - video_title
                      - video_id
                      - video_series
                      - fp_playback_id
                      - fp_live_stream_id
                      - media_id
                      - video_source_stream_type
                      - video_source_type
                      - video_encoding_variant
                      - experiment_name
                      - sub_property_id
                      - drm_type
                      - asn_name
                      - cdn
                      - video_source_hostname
                      - connection_type
                      - view_session_id
                      - continent
                      - country
                      - region
                      - viewer_id
                      - error_code
                      - exit_before_video_start
                      - view_has_ad
                      - video_startup_failed
                      - video_content_type
                      - page_context
                      - playback_failed
                      - custom_1
                      - custom_2
                      - custom_3
                      - custom_4
                      - custom_5
                      - custom_6
                      - custom_7
                      - custom_8
                      - custom_9
                      - custom_10
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /data/dimensions/{dimensionsId}:
    get:
      security:
        - BasicAuth: []
      tags:
        - Dimensions
      summary: List the filter values for a dimension
      description: |
        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_name` (dimension) and show how many views occurred for all available browsers like Chrome, Safari (filter values). 


        In order to use the <a href="https://fastpix.com/docs/working-with-video-data/use-custom-dimensions">Custom Dimensions</a>, you must enable them in the dashboard under settings option based on the plan you have opted for.

        #### Example

        A developer wants to know how their video content performs across different browsers. By calling this endpoint for the `device_type` dimension, they can retrieve a breakdown of video views by each device (for example, Desktop, Mobile, Tablet). This data helps the developer understand where optimizations or troubleshooting is necessary.


        Related guide: <a href="https://fastpix.com/docs/working-with-video-data/explore-the-dashboard#filters-and-timeframes">Filters and timespan</a>
      operationId: list_filter_values_for_dimension
      parameters:
        - in: path
          name: dimensionsId
          description: |
            Pass Dimensions Id
          required: true
          schema:
            type: string
            example: browser_name
            enum:
              - browser_name
              - browser_version
              - os_name
              - os_version
              - device_name
              - device_model
              - device_type
              - device_manufacturer
              - player_remote_played
              - player_name
              - player_version
              - player_software_name
              - player_software_version
              - player_resolution
              - fp_sdk
              - fp_sdk_version
              - player_autoplay_on
              - player_preload_on
              - video_title
              - video_id
              - video_series
              - fp_playback_id
              - fp_live_stream_id
              - media_id
              - video_source_stream_type
              - video_source_type
              - video_encoding_variant
              - experiment_name
              - sub_property_id
              - drm_type
              - asn_name
              - cdn
              - video_source_hostname
              - connection_type
              - view_session_id
              - continent
              - country
              - region
              - viewer_id
              - error_code
              - exit_before_video_start
              - view_has_ad
              - video_startup_failed
              - video_content_type
              - page_context
              - playback_failed
              - custom_1
              - custom_2
              - custom_3
              - custom_4
              - custom_5
              - custom_6
              - custom_7
              - custom_8
              - custom_9
              - custom_10
        - in: query
          name: timespan[]
          description: |
            This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
            
            **Accepted formats are:**

            array of epoch timestamps for example 
            `timespan[]=1498867200&timespan[]=1498953600`
            
            duration string for example  
            `timespan[]=24:hours` or `timespan[]=7:days`
          style: form
          explode: true
          schema:
            type: string
            example: 24:hours
            enum:
              - 60:minutes
              - 6:hours
              - 24:hours
              - 3:days
              - 7:days
              - 30:days
        - in: query
          name: filterby[]
          description: |
            Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint.
            Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]
          style: form
          explode: true
          schema:
            type: string
            example: browser_name:Chrome
      responses:
        "200":
          description: Get filter / dimension value details by dimension name.
          content:
            application/json:
              schema:
                example:
                  success: true
                  data:
                    - value: Chrome
                      uniqueCount: 20
                      count: 44
                  timespan:
                    - 1610025789
                    - 1610025947
                type: object
                properties:
                  success:
                    description: Shows the request status. Returns true for success and false for failure.
                    type: boolean
                  data:
                    $ref: "#/components/schemas/Dimensiondetails"
                  timespan:
                    $ref: "#/components/schemas/TimeSpan"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /data/metrics/{metricId}/breakdown:
    get:
      security:
        - BasicAuth: []
      tags:
        - Metrics
      summary: List breakdown values
      operationId: list_breakdown_values
      description: |
        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. 

        #### How it works

          1. Before using this endpoint, you can call the <a href="https://fastpix.com/docs/video-data-api/dimensions/list-dimensions">List Dimensions</a> endpoint to retrieve all available dimensions that can be used in your query. 

          2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters. 

          3. You receive a response containing the breakdown values for the specified metric, grouped and filtered according to your parameters. 

          4. Upon successful retrieval, the response includes the breakdown values based on the specified parameters. Note that the time values ( `totalWatchTime` and `totalPlayingTime` ) are in milliseconds 


        #### Example


        A developer wants to analyze how watch time varies across different device types. By calling this endpoint for the `playing_time` metric and filtering by `device_type`, they can understand how engagement differs between mobile, desktop, and tablet users. This data guides optimization efforts for different platforms.
        
        #### Key fields in response


          * **views:** The count of views based based on the applied filters.
        
          * **value:** The specific metric value calculated based on the applied filters. 
          * **totalWatchTime:** Total time watched across all views, represented in milliseconds. 
        
          * **totalPlayTime:** Total time spent playing the video, represented in milliseconds. 
          * **field:** The grouping field value based on the groupBy parameter. 


        Related guide: <a href="https://fastpix.com/docs/concepts/what-video-data-do-we-capture">Understand data definitions</a>
      parameters:
        - in: path
          name: metricId
          required: true
          description: |
            Pass metric Id
          schema:
            type: string
            example: quality_of_experience_score
            enum:
              - views
              - unique_viewers
              - playing_time
              - quality_of_experience_score
              - playback_score
              - playback_failure_percentage
              - exit_before_video_start
              - video_startup_failure_percentage
              - startup_score
              - video_startup_time
              - player_startup_time
              - page_load_time
              - total_startup_time
              - live_stream_latency
              - average_bitrate
              - buffer_count
              - render_quality_score
              - avg_upscaling
              - avg_downscaling
              - max_upscaling
              - max_downscaling
              - jump_latency
              - stability_score
              - buffer_ratio
              - buffer_frequency
              - buffer_fill
        - in: query
          name: timespan[]
          description: |
            This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
            
            **Accepted formats are:**

            array of epoch timestamps for example 
            `timespan[]=1498867200&timespan[]=1498953600`
            
            duration string for example  
            `timespan[]=24:hours` or `timespan[]=7:days`
          style: form
          explode: true
          schema:
            type: string
            example: 24:hours
            enum:
              - 60:minutes
              - 6:hours
              - 24:hours
              - 3:days
              - 7:days
              - 30:days
        - in: query
          name: filterby[]
          description: |
            Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint.
            Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]
          style: form
          explode: true
          schema:
            type: string
            example: browser_name:Chrome
        - in: query
          name: limit
          description: |
            Pass the limit to display only the rows specified by the value.
          schema:
            type: integer
            example: 10
            default: 10
        - in: query
          name: offset
          description: |
            Pass the offset value to indicate the page number.
          schema:
            type: integer
            example: 1
            default: 1
        - in: query
          name: groupBy
          description: |
            Pass this value to group the metrics list by.
            Possible Values : ["browser_name", "browser_version", "os_name","os_version" , "device_name", "device_model", "device_type", "device_manufacturer", "player_remote_played",player_name", "player_version", "player_software_name", "player_software_version", "player_resolution", "fp_sdk","fp_sdk_version", "player_autoplay_on", "player_preload_on","video_title",  "video_id", "video_series" ,  "fp_playback_id","fp_live_stream_id", "media_id","video_source_stream_type", "video_source_type", "video_encoding_variant", "experiment_name", "sub_property_id", "drm_type","asn_name", "cdn", "video_source_hostname", "connection_type", "view_session_id","continent","country", "region","viewer_id", "error_code", "exit_before_video_start", "view_has_ad", "video_startup_failed" , "page_context", "playback_failed".]
          schema:
            type: string
            example: browser_name
        - in: query
          name: orderBy
          description: |
            Pass this value to order the metrics list by.
          schema:
            type: string
            example: views
            default: views
        - in: query
          name: sortOrder
          description: |
            The order direction to sort the metrics list by.
          schema:
            type: string
            example: asc
            default: asc
            enum:
              - asc
              - desc
        - in: query
          name: measurement
          description: |
            The measurement for the given metrics.
            Possible Values : [95th, median, avg, count or sum]
          schema:
            type: string
            example: avg
            default: avg
      responses:
        "200":
          description: Get filter/ dimension value details by dimension name.
          content:
            application/json:
              schema:
                example:
                  success: true
                  metadata:
                    aggregation: view_end
                  data:
                    - views: 3
                      value: 30
                      totalWatchTime: 83208
                      totalPlayingTime: 57165
                      field: PostmanRuntime
                    - views: 24
                      value: 28
                      totalWatchTime: 913048
                      totalPlayingTime: 2624467
                      field: Chrome
                  pagination:
                    totalRecords: 2
                    currentOffset: 1
                    offsetCount: 1
                  timespan:
                    - 1712915263
                    - 1713520063
                type: object
                properties:
                  success:
                    description: Shows the request status. Returns true for success and false for failure.
                    type: boolean
                  metadata:
                    $ref: "#/components/schemas/MetricsmetadataDetails"
                  data:
                    $ref: "#/components/schemas/MetricsBreakdownDetails"
                  pagination:
                    $ref: "#/components/schemas/DataPagination"
                  timespan:
                    $ref: "#/components/schemas/TimeSpan"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /data/metrics/{metricId}/overall:
    get:
      security:
        - BasicAuth: []
      tags:
        - Metrics
      summary: List overall values
      operationId: list_overall_values
      description: |
        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`. 

        #### How it works

          1. Before using this endpoint, you can call the <a href="https://fastpix.com/docs/video-data-api/dimensions/list-dimensions">list dimensions</a> endpoint to retrieve all available dimensions that can be used in your query. 

          2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters. 

          3. You receive a response containing the overall values for the specified metric, which may vary based on the applied filters. 






        #### Key fields in response


          * **value:** The specific metric value calculated based on the applied filters. 
          * **totalWatchTime:** Total time watched across all views, represented in milliseconds. 
          * **uniqueViews:** The count of unique viewers who interacted with the content. 
          * **totalViews:** The total number of views recorded. 
          * **totalPlayTime:** Total time spent playing the video, represented in milliseconds. 
          * **globalValue:** A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan. This value is not affected by specific filters. 


          Related guide: <a href="https://fastpix.com/docs/concepts/what-video-data-do-we-capture">Understand data definitions</a>
      parameters:
        - in: path
          name: metricId
          required: true
          description: |
            Pass metric Id
          schema:
            type: string
            example: quality_of_experience_score
            enum:
              - views
              - unique_viewers
              - playing_time
              - quality_of_experience_score
              - playback_score
              - playback_failure_percentage
              - exit_before_video_start
              - video_startup_failure_percentage
              - startup_score
              - video_startup_time
              - player_startup_time
              - page_load_time
              - total_startup_time
              - live_stream_latency
              - average_bitrate
              - buffer_count
              - render_quality_score
              - avg_upscaling
              - avg_downscaling
              - max_upscaling
              - max_downscaling
              - jump_latency
              - stability_score
              - buffer_ratio
              - buffer_frequency
              - buffer_fill
        - in: query
          name: measurement
          description: |
            The measurement for the given metrics.
            Possible Values : [95th, median, avg, count or sum]
          schema:
            type: string
            example: avg
            default: avg
        - in: query
          name: timespan[]
          description: |
            This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
            
            **Accepted formats are:**

            array of epoch timestamps for example 
            `timespan[]=1498867200&timespan[]=1498953600`
            
            duration string for example  
            `timespan[]=24:hours` or `timespan[]=7:days`
          style: form
          explode: true
          schema:
            type: string
            example: 24:hours
            enum:
              - 60:minutes
              - 6:hours
              - 24:hours
              - 3:days
              - 7:days
              - 30:days
        - in: query
          name: filterby[]
          description: |
            Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint.
            Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]
          style: form
          explode: true
          schema:
            type: string
            example: browser_name:Chrome
      responses:
        "200":
          description: Get filter/ dimension value details by dimension name.
          content:
            application/json:
              schema:
                example:
                  success: true
                  metadata:
                    aggregation: view_end
                  data:
                    value: 0.740365072855583
                    totalWatchTime: 59534302
                    uniqueViews: 44
                    totalViews: 195
                    totalPlayTime: 24729470
                    globalValue: 0.740365072855583
                  timespan:
                    - 1610025789
                    - 1610025947
                type: object
                properties:
                  success:
                    description: Shows the request status. Returns true for success and false for failure.
                    type: boolean
                  metadata:
                    $ref: "#/components/schemas/MetricsOverallmetadataDetails"
                  data:
                    $ref: "#/components/schemas/MetricsOverallDataDetails"
                  timespan:
                    $ref: "#/components/schemas/TimeSpan"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /data/metrics/{metricId}/timeseries:
    get:
      security:
        - BasicAuth: []
      tags:
        - Metrics
      summary: Get timeseries data
      operationId: get_timeseries_data
      description: |
        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 metrics value at specific intervals. 

        #### Key fields in response

        * **intervalTime:** The timestamp for the data point indicating when the metric value was recorded. 
        * **metricValue:** The value of the specified metric at the given interval, reflecting the performance or engagement level during that time. 
        * **numberOfViews:** The total number of views recorded during that interval, providing context for the metric value.
      parameters:
        - in: path
          name: metricId
          required: true
          description: |
            Pass metric Id
          schema:
            type: string
            example: quality_of_experience_score
            enum:
              - views
              - unique_viewers
              - playing_time
              - quality_of_experience_score
              - playback_score
              - playback_failure_percentage
              - exit_before_video_start
              - video_startup_failure_percentage
              - startup_score
              - video_startup_time
              - player_startup_time
              - page_load_time
              - total_startup_time
              - live_stream_latency
              - average_bitrate
              - buffer_count
              - render_quality_score
              - avg_upscaling
              - avg_downscaling
              - max_upscaling
              - max_downscaling
              - jump_latency
              - stability_score
              - buffer_ratio
              - buffer_frequency
              - buffer_fill
        - in: query
          name: groupBy
          description: |
            Pass this value to group the metrics list by.
          schema:
            type: string
            example: minute
            default: minute
            enum:
              - minute
              - ten_minutes
              - hour
              - day
        - in: query
          name: sortOrder
          description: |
            The order direction to sort the metrics list by.
          schema:
            type: string
            example: asc
            default: asc
            enum:
              - asc
              - desc
        - in: query
          name: measurement
          description: |
            The measurement for the given metrics.
            Possible Values : [95th, median, avg, count or sum]
          schema:
            type: string
            example: avg
            default: avg
        - in: query
          name: timespan[]
          description: |
            This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
            
            **Accepted formats are:**

            array of epoch timestamps for example 
            `timespan[]=1498867200&timespan[]=1498953600`
            
            duration string for example  
            `timespan[]=24:hours` or `timespan[]=7:days`
          style: form
          explode: true
          schema:
            type: string
            example: 24:hours
            enum:
              - 60:minutes
              - 6:hours
              - 24:hours
              - 3:days
              - 7:days
              - 30:days
        - in: query
          name: filterby[]
          description: |
            Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint.
            Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]
          style: form
          explode: true
          schema:
            type: string
            example: browser_name:Chrome
      responses:
        "200":
          description: Get filter/ dimension value details by dimension name.
          content:
            application/json:
              schema:
                example:
                  success: true
                  metadata:
                    granularity: day
                    aggregation: view_end
                  data:
                    - intervalTime: "2023-12-04T14:00:00Z"
                      metricValue: 0.793110142151515
                      numberOfViews: 143244
                  timespan:
                    - 1610025789
                    - 1610025947
                type: object
                properties:
                  success:
                    description: Shows the request status. Returns true for success and false for failure.
                    type: boolean
                  metadata:
                    $ref: "#/components/schemas/MetricsTimeseriesmetadataDetails"
                  data:
                    description: Displays the result of the request.
                    type: array
                    items:
                      $ref: "#/components/schemas/MetricsTimeseriesDataDetails"
                  timespan:
                    $ref: "#/components/schemas/TimeSpan"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /data/metrics/comparison:
    get:
      security:
        - BasicAuth: [ ]
      tags:
        - Metrics
      summary: List comparison values
      operationId: list_comparison_values
      description: |
        This endpoint lets you to compare multiple metrics across specified dimensions. You can specify the metrics you want to compare in the query parameters, and the response includes the relevant metrics for the specified dimensions.
        
        #### Key fields in response 

        * **value:** The specific metric value calculated based on the applied filters.
        * **type:** The data unit or format type (for example, "number", "milliseconds", "percentage").
        * **name:** The display name of the metric (for example, "Views", "Overall Score").
        * **metric:** The metric field represents the name of the Key Performance Indicator (KPI) being tracked or analyzed. It identifies a specific measurable aspect of the video playback experience, such as buffering time, video start failure rate, or playback quality.
        * **items:** Nested breakdown of related metrics for more detailed analysis.
        * **measurement:** Defines the aggregation type (for example, "avg", "sum", "median", "95th").
        
        #### How it works 
        
          1. Before making a request to this endpoint, call the <a href="https://fastpix.com/docs/video-data-api/dimensions/list-dimensions">list dimensions</a> endpoint to obtain all available dimensions that can be used for comparison. 
        
          2. Send a `GET` request to this endpoint with the desired metrics specified in the query parameters. 
        
          3. You Receive a response containing the comparison values for the specified metrics across the selected dimensions. 
        
        
          Related guide: <a href="https://fastpix.com/docs/working-with-video-data/explore-the-dashboard#compare-metrics">Compare metrics in dashboard</a>
      parameters:
        - in: query
          name: timespan[]
          description: |
            This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
            
            **Accepted formats are:**
            
            array of epoch timestamps for example 
            `timespan[]=1498867200&timespan[]=1498953600`
            
            duration string for example 
            `timespan[]=24:hours` or `timespan[]=7:days`
          style: form
          explode: true
          schema:
            type: string
            example: 24:hours
            enum:
              - 60:minutes
              - 6:hours
              - 24:hours
              - 3:days
              - 7:days
              - 30:days
        - in: query
          name: filterby[]
          description: |
            Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint.
            Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]
          style: form
          explode: true
          schema:
            type: string
            example: browser_name:Chrome
        - in: query
          name: dimension
          description: |
            The dimension id in which the views are watched.
          schema:
            type: string
            example: browser_name
            enum:
              - browser_name
              - browser_version
              - os_name
              - os_version
              - device_name
              - device_model
              - device_type
              - device_manufacturer
              - player_remote_played
              - player_name
              - player_version
              - player_software_name
              - player_software_version
              - player_resolution
              - fp_sdk
              - fp_sdk_version
              - player_autoplay_on
              - player_preload_on
              - video_title
              - video_id
              - video_series
              - fp_playback_id
              - fp_live_stream_id
              - media_id
              - video_source_stream_type
              - video_source_type
              - video_encoding_variant
              - experiment_name
              - sub_property_id
              - drm_type
              - asn_name
              - cdn
              - video_source_hostname
              - connection_type
              - view_session_id
              - continent
              - country
              - region
              - viewer_id
              - error_code
              - exit_before_video_start
              - view_has_ad
              - video_startup_failed
              - page_context
              - video_content_type
              - playback_failed
              - custom_1
              - custom_2
              - custom_3
              - custom_4
              - custom_5
              - custom_6
              - custom_7
              - custom_8
              - custom_9
              - custom_10
        - in: query
          name: value
          description: |
            The value for the selected dimension. 
            For example:
             If `dimension` is `browser_name`, the value could be  `Chrome` `,` `Firefox` `etc` .
             If `dimension` is `os_name`, the value could be `macOS` `,` `Windows` `etc` .
          schema:
            type: string
            example: Chrome
      responses:
        "200":
          description: Get filter/ dimension value details by dimension name.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    description: Shows the request status. Returns true for success and false for failure.
                    type: boolean
                  data:
                    type: array
                    description: |
                      Displays the result of the request.
                    items:
                      $ref: "#/components/schemas/MetricsComparisonDetails"
                  timespan:
                    $ref: "#/components/schemas/TimeSpan"
                example:
                  success: true
                  data:
                    - value: 6
                      type: number
                      name: Views
                      metric: views
                      measurement: count
                      items:
                        - value: 6
                          type: number
                          name: Unique Viewers
                          metric: uniqueViewers
                          measurement: count
                          items: null
                        - value: 503934
                          type: milliseconds
                          name: Playing Time
                          metric: playingTime
                          measurement: sum
                          items: null

                  timespan:
                    - 1610025789
                    - 1610025947

        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
  /data/errors:
    get:
      security:
        - BasicAuth: []
      tags:
        - Errors
      summary: List errors
      operationId: list_errors
      description: |
        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. 


        #### Key fields in response

        * **percentage:** The percentage of views affected by the specific error. 
        * **uniqueViewersEffectedPercentage:** The percentage of unique viewers affected by the specific error (available only in the topErrors section). 
        * **notes:** Additional notes or information about the specific error. 
        * **message:** The error message or description. 
        * **lastSeen:** The timestamp of when the error was last observed. 
        * **id:** The unique identifier for the specific error. 
        * **description:** A description of the specific error. 
        * **count:** The number of occurrences of the specific error. 
        * **code:** The error code associated with the specific error. 


        Related guide: <a href="https://fastpix.com/docs/working-with-video-data/troubleshoot-playback-errors">Troubleshoot errors</a>
      parameters:
        - in: query
          name: timespan[]
          description: |
            This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
            
            **Accepted formats are:**

            array of epoch timestamps for example  
            `timespan[]=1498867200&timespan[]=1498953600`
            
            duration string for example  
            `timespan[]=24:hours` or `timespan[]=7:days`
          style: form
          explode: true
          schema:
            type: string
            example: 24:hours
            enum:
              - 60:minutes
              - 6:hours
              - 24:hours
              - 3:days
              - 7:days
              - 30:days
        - in: query
          name: filterby[]
          description: |
            Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint.
            Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]
          style: form
          explode: true
          schema:
            type: string
            example: browser_name:Chrome
        - in: query
          name: limit
          description: |
            Pass the limit to display only the rows specified by the value for top errors.
          schema:
            type: integer
            example: 1
            default: 1
      responses:
        "200":
          description: Get filter/ dimension value details by dimension name.
          content:
            application/json:
              schema:
                example:
                  success: true
                  data:
                    errors:
                      - percentage: 0.0222222222222222
                        notes: An informative note on specific error
                        message: "com.fastpix.stats.sdk.h71.a - android.media.mediadrm$mediadrmstateexception: failed to handle key response: drm vendor-defined error: -2998"
                        lastSeen: "2023-12-01T11:31:07Z"
                        id: 9pa85f64-5717-4562-b3fc-2c963f66afa6
                        description: a description for the specific error
                        count: 4
                        code: 1003
                    topErrors:
                      - percentage: 0.0222222222222222
                        uniqueViewersEffectedPercentage: 0.0122222222222222
                        notes: An informative note for a specific error
                        message: "com.fastpix.stats.sdk.h71.a - android.media.mediadrm$mediadrmstateexception: failed to handle key response: drm vendor-defined error: -2998"
                        lastSeen: "2023-12-01T11:31:07Z"
                        count: 4
                        code: 1003
                  timespan:
                    - 1610025789
                    - 1610025947
                type: object
                properties:
                  success:
                    description: Shows the request status. Returns true for success and false for failure.
                    type: boolean
                  data:
                    description: Displays the result of the request.
                    type: object
                    properties:
                      errors:
                        $ref: "#/components/schemas/ErrorDetails"
                      topErrors:
                        $ref: "#/components/schemas/TopErrorDetails"
                  timespan:
                    $ref: "#/components/schemas/TimeSpan"
        "default":
          description: See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Default-Error"
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: |
        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.
        - <b>Username:</b> Access Token ID  
        - <b>Password:</b> Secret Key  
        
        Activate your FastPix account to generate your API credentials. <a href="https://fastpix.com/docs/getting-started/activate-your-account" target="_blank">See the guide here</a>

  schemas:
    # Common enums
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      default: desc
      example: desc
      description: "The values in the list can be arranged in two ways: DESC (Descending) or ASC (Ascending)."

    PlaylistOrder:
      type: string
      enum:
        - createdDate ASC
        - createdDate DESC
      description: Determines the insertion order of media into playlist.

    DateRange:
      type: object
      properties:
        startDate:
          type: string
          example: "2024-11-11"
        endDate:
          type: string
          example: "2024-11-11"
      description: Date range with start and end dates.

    MediaType:
      type: string
      default: audio
      enum:
        - video
        - audio
        - av
      description: Type of media content

    AccessPolicy:
      type: string
      enum:
        - public
        - private
        - drm
      description: Access policy for media content

    BasicAccessPolicy:
      type: string
      enum:
        - public
        - private
      default: public
      description: Basic access policy for media content

    PolicyAction:
      type: string
      enum:
        - allow
        - deny
      description: Policy action type

    # Reusable access restriction schemas
    DomainRestrictions:
      type: object
      description: Restrictions based on the originating domain of a request
      properties:
        defaultPolicy:
          $ref: "#/components/schemas/PolicyAction"
        allow:
          type: array
          items:
            type: string
          description: A list of domain names or patterns that are explicitly allowed access
        deny:
          type: array
          items:
            type: string
          description: A list of domain names or patterns that are explicitly denied access

    UserAgentRestrictions:
      type: object
      description: Restrictions based on the user agent
      properties:
        defaultPolicy:
          $ref: "#/components/schemas/PolicyAction"
        allow:
          type: array
          items:
            type: string
          description: A list of user agents that are explicitly allowed access
        deny:
          type: array
          items:
            type: string
          description: A list of user agents that are explicitly denied access

    SrtPlaybackResponse:
      type: object
      description: This object contains the livestream playback response details for SRT Protocol
      properties:
        srtPlaybackStreamId:
          type: string
          description: A unique identifier for the SRT playback stream. This ID is used to distinguish between different playback streams
        srtPlaybackSecret:
          type: string
          description: A playback secret used for securing the SRT playback stream. This ensures that only authorized users can access the playback

    LanguageCode:
      type: string
      example: en-US
      default: en-US
      enum:
        - ar-SA
        - bn-BD
        - bn-IN
        - ca-ES
        - cs-CZ
        - da-DK
        - de-AT
        - de-CH
        - de-DE
        - el-GR
        - en-AU
        - en-CA
        - en-GB
        - en-IE
        - en-IN
        - en-NZ
        - en-US
        - en-ZA
        - es-AR
        - es-CL
        - es-CO
        - es-ES
        - es-MX
        - es-US
        - fi-FI
        - fr-BE
        - fr-CA
        - fr-CH
        - fr-FR
        - he-IL
        - hi-IN
        - hr-HR
        - hu-HU
        - id-ID
        - it-CH
        - it-IT
        - ja-JP
        - ko-KR
        - ms-MY
        - nb-NO
        - nl-BE
        - nl-NL
        - no-NO
        - pl-PL
        - pt-BR
        - pt-PT
        - ro-RO
        - ru-RU
        - sk-SK
        - sv-SE
        - ta-IN
        - ta-LK
        - te-IN
        - th-TH
        - tr-TR
        - uk-UA
        - vi-VN
        - bg-BG
        - zh-CN
        - zh-HK
        - zh-TW
      description: Language code for content localization

    # Response schemas
    CreateMediaSuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          $ref: "#/components/schemas/CreateMediaResponse"
    MediaClipResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                example: b62427ec-07fd-4a89-b3c0-94909aaaa1da
                description: The unique identifier assigned to the media by FastPix.
              duration:
                type: string
                example: "00:00:13"
                description: Duration of the media in HH:MM:SS format.
              status:
                type: string
                example: Ready
                enum:
                  - Created
                  - Downloading
                  - Downloaded
                  - Validating
                  - In Queue
                  - Processing
                  - Ready
                  - Failed
                description: The current processing status of the media.
              thumbnail:
                type: string
                format: uri
                example: https://images.fastpix.app/66dc7b0b-9dfb-4721-a738-837f89ccbd0a/thumbnail.png
                description: A video thumbnail that acts as a preview image for the video.
              createdAt:
                type: string
                format: date-time
                example: "2025-03-12T06:17:26.403017Z"
                description: Timestamp of when the media was created.
              playbackIds:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      example: 66dc7b0b-9dfb-4721-a738-837f89ccbd0a
                      description: The unique identifier for playback.
                    accessPolicy:
                      type: string
                      example: public
                      description: The access policy of the playback.
        pagination:
          type: object
          properties:
            totalRecords:
              type: integer
              example: 4
              description: Total number of records available.
            currentOffset:
              type: integer
              example: 1
              description: The starting offset of the current result set.
            offsetCount:
              type: integer
              example: 4
              description: The number of items returned in the current response.
    GetAllMediaResponse:
      type: object
      properties:
        thumbnail:
          type: string
          nullable: true
          example: https://images.fastpix.com/6b13fdaf-f9ac-4970-a13b-01ea417e8783/thumbnail.png
          description: A video thumbnail is a still image that acts as the preview image for your video.
        id:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        sourceMediaId:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The source media ID if this media was created from another media (for example, as a clip).
        workspaceId:
          type: string
          format: uuid
          example: 5ta85f64-5717-4562-b3fc-2c963f66afa6
          description: A unique identifier is generated by FastPix for the workspace.
        streamId:
          type: string
          example: 98f28be5ac9bd7a4205634691a1a096b
          description: The ID of the livestream for which the clips were created.
        metadata:
          type: object
          nullable: true
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          example:
            key1: value1
          description: |
            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.
        mediaQuality:
          type: string
          example: standard
          description: The quality tier applied to the media.
          enum:
            - standard
            - pro
            - premium
        creatorId:
          type: string
          maxLength: 255
          example: 8fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier of the user who created this media.
        title:
          type: string
          maxLength: 255
          nullable: true
          example: My Video Title
          description: Title of the media file.
        maxResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - 1440p
            - 1080p
            - 720p
            - 480p
          description: The maximum resolution specified by the user for the media.
        sourceResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - "2160"
            - 1440p
            - "1440"
            - 1080p
            - "1080"
            - 720p
            - "720"
            - 480p
            - "480"
          description: The actual resolution of the uploaded media. This represents the native quality of the source media.
        status:
          type: string
          example: Processing
          enum:
            - Created
            - Downloading
            - Downloaded
            - Validating
            - In Queue
            - Processing
            - Ready
            - Failed
          description: Determines the media's status, which can be one of the possible values.
        mp4Support:
          type: string
          example: capped_4k
          enum:
            - none
            - capped_4k
            - audioOnly
            - audioOnly,capped_4k
          description: |
            Determines the type of MP4 support for the media.
            - **none**: Disables MP4 support.
            - **capped_4k**: Enables MP4 downloads with resolutions up to 4K.
            - **audioOnly**: Provides an MP4 stream containing only the audio.
            - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.
        sourceAccess:
          type: boolean
          nullable: true
          example: true
          description: The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.
        playbackIds:
          type: array
          items:
            $ref: "#/components/schemas/PlaybackId"
          description: A collection of Playback ID objects utilized for crafting HLS playback URLs.
        tracks:
          type: array
          items:
            oneOf:
              - $ref: "#/components/schemas/VideoTrackForGetAll"
              - $ref: "#/components/schemas/AudioTrack"
              - $ref: "#/components/schemas/SubtitleTrack"
          description: A media consists of different media tracks, like video, audio, and subtitle, all combined.
        generatedSubtitles:
          type: array
          nullable: true
          description: List of generated subtitle tracks associated with the media.
          items:
            $ref: "#/components/schemas/TracksSubtitles"
        summary:
          $ref: "#/components/schemas/AiSummaryRecord"
          description: AI-generated summary of the media content, if available.
        chapters:
          $ref: "#/components/schemas/AiResponseRecord"
          description: AI-generated chapters for the media, if available.
        namedEntities:
          $ref: "#/components/schemas/AiResponseRecord"
          description: AI-extracted named entities from the media, if available.
        moderation:
          $ref: "#/components/schemas/AiResponseRecord"
          description: Moderation results for the media, if available.
        isAudioOnly:
          type: boolean
          nullable: true
          example: false
          description: Indicates whether the media contains only audio (no video track).
        subtitleAvailable:
          type: boolean
          nullable: true
          example: true
          description: Indicates whether subtitles are available for the media.
        duration:
          type: string
          example: "00:00:10"
          description: The length of the media in seconds, with a maximum allowed duration of 12 hours per individual media.
        frameRate:
          type: string
          example: "30/1"
          description: Frame rate quantifies the speed at which frames are displayed per second. It represents the range of frames available for a specific track. The indeterminable frame rate of the input file is indicated by a value of -1.
        aspectRatio:
          type: string
          nullable: true
          example: "16:9"
          description: The aspect ratio of a video is a value that describes the relative shape of a video based on its width and height.
        createdAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was created, defined as a localDateTime (UTC Time).
        updatedAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was updated, defined as a localDateTime (UTC Time).
    GetMediaResponse:
      type: object
      properties:
        thumbnail:
          type: string
          nullable: true
          example: https://images.fastpix.com/6b13fdaf-f9ac-4970-a13b-01ea417e8783/thumbnail.png
          description: A video thumbnail is a still image that acts as the preview image for your video.
        id:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        sourceMediaId:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The source media ID if this media was created from another media (for example, as a clip).
        workspaceId:
          type: string
          format: uuid
          example: 5ta85f64-5717-4562-b3fc-2c963f66afa6
          description: A unique identifier is generated by FastPix for the workspace.
        streamId:
          type: string
          example: 98f28be5ac9bd7a4205634691a1a096b
          description: The ID of the livestream for which the clips were created.
        metadata:
          type: object
          nullable: true
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          example:
            key1: value1
          description: |
            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.
        mediaQuality:
          type: string
          example: standard
          description: The quality tier applied to the media.
          enum:
            - standard
            - pro
            - premium
        creatorId:
          type: string
          maxLength: 255
          example: 8fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier of the user who created this media.
        title:
          type: string
          maxLength: 255
          nullable: true
          example: My Video Title
          description: Title of the media file.
        maxResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - 1440p
            - 1080p
            - 720p
            - 480p
          description: The maximum resolution specified by the user for the media.
        sourceResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - "2160"
            - 1440p
            - "1440"
            - 1080p
            - "1080"
            - 720p
            - "720"
            - 480p
            - "480"
          description: The actual resolution of the uploaded media. This represents the native quality of the source media.
        status:
          type: string
          example: Processing
          enum:
            - Created
            - Downloading
            - Downloaded
            - Validating
            - In Queue
            - Processing
            - Ready
            - Failed
          description: Determines the media's status, which can be one of the possible values.
        mp4Support:
          type: string
          example: capped_4k
          enum:
            - none
            - capped_4k
            - audioOnly
            - audioOnly,capped_4k
          description: |
            Determines the type of MP4 support for the media.
            - **none**: Disables MP4 support.
            - **capped_4k**: Enables MP4 downloads with resolutions up to 4K.
            - **audioOnly**: Provides an MP4 stream containing only the audio.
            - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.
        sourceAccess:
          type: boolean
          nullable: true
          example: true
          description: The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.
        playbackIds:
          type: array
          items:
            $ref: "#/components/schemas/PlaybackId"
          description: A collection of Playback ID objects utilized for crafting HLS playback URLs.
        tracks:
          type: array
          items:
            oneOf:
              - $ref: "#/components/schemas/VideoTrack"
              - $ref: "#/components/schemas/AudioTrack"
              - $ref: "#/components/schemas/SubtitleTrack"
          description: A media consists of different media tracks, like video, audio, and subtitle, all combined.
        generatedSubtitles:
          type: array
          nullable: true
          description: List of generated subtitle tracks associated with the media.
          items:
            $ref: "#/components/schemas/TracksSubtitles"
        summary:
          $ref: "#/components/schemas/AiSummaryRecord"
          description: AI-generated summary of the media content, if available.
        chapters:
          $ref: "#/components/schemas/AiResponseRecord"
          description: AI-generated chapters for the media, if available.
        namedEntities:
          $ref: "#/components/schemas/AiResponseRecord"
          description: AI-extracted named entities from the media, if available.
        moderation:
          $ref: "#/components/schemas/AiResponseRecord"
          description: Moderation results for the media, if available.
        isAudioOnly:
          type: boolean
          nullable: true
          example: false
          description: Indicates whether the media contains only audio (no video track).
        subtitleAvailable:
          type: boolean
          nullable: true
          example: true
          description: Indicates whether subtitles are available for the media.
        duration:
          type: string
          example: "00:00:10"
          description: The length of the media in seconds, with a maximum allowed duration of 12 hours per individual media.
        frameRate:
          type: string
          example: "30/1"
          description: Frame rate quantifies the speed at which frames are displayed per second. It represents the range of frames available for a specific track. The indeterminable frame rate of the input file is indicated by a value of -1.
        aspectRatio:
          type: string
          nullable: true
          example: "16:9"
          description: The aspect ratio of a video is a value that describes the relative shape of a video based on its width and height.
        createdAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was created, defined as a localDateTime (UTC Time).
        updatedAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was updated, defined as a localDateTime (UTC Time).

    Live-Media-Clips:
      type: object
      properties:
        thumbnail:
          type: string
          nullable: true
          example: https://images.fastpix.com/6b13fdaf-f9ac-4970-a13b-01ea417e8783/thumbnail.png
          description: A video thumbnail is a still image that acts as the preview image for your video.
        id:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        workspaceId:
          type: string
          format: uuid
          example: 5ta85f64-5717-4562-b3fc-2c963f66afa6
          description: A unique identifier is generated by FastPix for the workspace.
        streamId:
          type: string
          example: 98f28be5ac9bd7a4205634691a1a096b
          description: The ID of the livestream for which the clips were created.
        creatorId:
          type: string
          maxLength: 255
          example: 8fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier of the user who created this media.
        title:
          type: string
          maxLength: 255
          nullable: true
          example: My Video Title
          description: Title of the media file.
        maxResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - 1440p
            - 1080p
            - 720p
            - 480p
          description: The maximum resolution specified by the user for the media.
        sourceResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - "2160"
            - 1440p
            - "1440"
            - 1080p
            - "1080"
            - 720p
            - "720"
            - 480p
            - "480"
          description: The actual resolution of the uploaded media. This represents the native quality of the source media.
        status:
          type: string
          example: Processing
          enum:
            - Created
            - Downloading
            - Downloaded
            - Validating
            - In Queue
            - Processing
            - Ready
            - Failed
          description: Determines the media's status, which can be one of the possible values.
        sourceAccess:
          type: boolean
          example: false
          description: The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.
        playbackIds:
          type: array
          items:
            $ref: "#/components/schemas/PlaybackId"
          description: A collection of Playback ID objects utilized for crafting HLS playback URLs.
        tracks:
          type: array
          items:
            oneOf:
              - $ref: "#/components/schemas/VideoTrack"
              - $ref: "#/components/schemas/AudioTrack"
              - $ref: "#/components/schemas/SubtitleTrack"
          description: A media consists of different media tracks, like video, audio, and subtitle, all combined.
        mp4Support:
          type: string
          example: capped_4k
          enum:
            - none
            - capped_4k
            - audioOnly
            - audioOnly,capped_4k
          description: |
            Determines the type of MP4 support for the media.
            - **none**: Disables MP4 support.
            - **capped_4k**: Enables MP4 downloads with resolutions up to 4K.
            - **audioOnly**: Provides an MP4 stream containing only the audio.
            - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.
        generatedSubtitles:
          type: array
          nullable: true
          description: List of generated subtitle tracks associated with the media.
          items:
            $ref: "#/components/schemas/TracksSubtitles"
        isAudioOnly:
          type: boolean
          nullable: true
          example: false
          description: Indicates whether the media contains only audio (no video track).
        subtitleAvailable:
          type: boolean
          nullable: true
          example: true
          description: Indicates whether subtitles are available for the media.
        duration:
          type: string
          example: "00:00:10"
          description: The length of the media in seconds, with a maximum allowed duration of 12 hours per individual media.
        aspectRatio:
          type: string
          nullable: true
          example: "16:9"
          description: The aspect ratio of a video is a value that describes the relative shape of a video based on its width and height.
        createdAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was created, defined as a localDateTime (UTC Time).
        updatedAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was updated, defined as a localDateTime (UTC Time).

    Media:
      type: object
      properties:
        thumbnail:
          type: string
          nullable: true
          example: https://images.fastpix.com/6b13fdaf-f9ac-4970-a13b-01ea417e8783/thumbnail.png
          description: A video thumbnail is a still image that acts as the preview image for your video.
        id:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        workspaceId:
          type: string
          format: uuid
          example: 5ta85f64-5717-4562-b3fc-2c963f66afa6
          description: A unique identifier is generated by FastPix for the workspace.
        metadata:
          type: object
          nullable: true
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          example:
            key1: value1
          description: |
            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.
        mediaQuality:
          type: string
          example: standard
          description: The quality tier applied to the media.
          enum:
            - standard
            - pro
            - premium
        creatorId:
          type: string
          maxLength: 255
          example: 8fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier of the user who created this media.
        title:
          type: string
          maxLength: 255
          nullable: true
          example: My Video Title
          description: Title of the media file.
        maxResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - 1440p
            - 1080p
            - 720p
            - 480p
          description: The maximum resolution specified by the user for the media.
        sourceResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - "2160"
            - 1440p
            - "1440"
            - 1080p
            - "1080"
            - 720p
            - "720"
            - 480p
            - "480"
          description: The actual resolution of the uploaded media. This represents the native quality of the source media.
        status:
          type: string
          example: Processing
          enum:
            - Created
            - Downloading
            - Downloaded
            - Validating
            - In Queue
            - Processing
            - Ready
            - Failed
          description: Determines the media’s status, which can be one of the possible values.
        mp4Support:
          type: string
          example: capped_4k
          enum:
            - none
            - capped_4k
            - audioOnly
            - audioOnly,capped_4k
          description: |
            Determines the type of MP4 support for the media.
            - **none**: Disables MP4 support.
            - **capped_4k**: Enables MP4 downloads with resolutions up to 4K.
            - **audioOnly**: Provides an MP4 stream containing only the audio.
            - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.
        sourceAccess:
          type: boolean
          nullable: true
          example: true
          description: The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.
        playbackIds:
          type: array
          items:
            $ref: "#/components/schemas/PlaybackId"
          description: A collection of Playback ID objects utilized for crafting HLS playback URLs.
        tracks:
          type: array
          items:
            oneOf:
              - $ref: "#/components/schemas/VideoTrack"
              - $ref: "#/components/schemas/AudioTrack"
              - $ref: "#/components/schemas/SubtitleTrack"
          description: A media consists of different media tracks, like video, audio, and subtitle, all combined.
        generatedSubtitles:
          type: array
          nullable: true
          description: List of generated subtitle tracks associated with the media.
          items:
            $ref: "#/components/schemas/TracksSubtitles"
        summary:
          $ref: "#/components/schemas/AiSummaryRecord"
          nullable: true
          description: AI-generated summary of the media content, if available.
        chapters:
          $ref: "#/components/schemas/AiResponseRecord"
          nullable: true
          description: AI-generated chapters for the media, if available.
        namedEntities:
          $ref: "#/components/schemas/AiResponseRecord"
          nullable: true
          description: AI-extracted named entities from the media, if available.
        moderation:
          $ref: "#/components/schemas/AiResponseRecord"
          nullable: true
          description: Moderation results for the media, if available.
        isAudioOnly:
          type: boolean
          nullable: true
          example: false
          description: Indicates whether the media contains only audio (no video track).
        subtitleAvailable:
          type: boolean
          nullable: true
          example: true
          description: Indicates whether subtitles are available for the media.
        duration:
          type: string
          example: "00:00:10"
          description: The length of the media in seconds, with a maximum allowed duration of 12 hours per individual media.
        aspectRatio:
          type: string
          nullable: true
          example: "16:9"
          description: The aspect ratio of a video is a value that describes the relative shape of a video based on its width and height.
        createdAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was created, defined as a localDateTime (UTC Time).
        updatedAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was updated, defined as a localDateTime (UTC Time).
    sourceAccessMedia:
      type: object
      properties:
        thumbnail:
          type: string
          nullable: true
          example: https://images.fastpix.com/6b13fdaf-f9ac-4970-a13b-01ea417e8783/thumbnail.png
          description: A video thumbnail is a still image that acts as the preview image for your video.
        id:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        workspaceId:
          type: string
          format: uuid
          example: 5ta85f64-5717-4562-b3fc-2c963f66afa6
          description: A unique identifier is generated by FastPix for the workspace.
        metadata:
          type: object
          nullable: true
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          example:
            key1: value1
          description: |
            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.
        mediaQuality:
          type: string
          example: standard
          description: The quality tier applied to the media.
          enum:
            - standard
            - pro
            - premium
        creatorId:
          type: string
          maxLength: 255
          example: 8fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier of the user who created this media.
        title:
          type: string
          maxLength: 255
          nullable: true
          example: My Video Title
          description: Title of the media file.
        maxResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - 1440p
            - 1080p
            - 720p
            - 480p
          description: The maximum resolution specified by the user for the media.
        sourceResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - "2160"
            - 1440p
            - "1440"
            - 1080p
            - "1080"
            - 720p
            - "720"
            - 480p
            - "480"
          description: The actual resolution of the uploaded media. This represents the native quality of the source media.
        status:
          type: string
          example: Processing
          enum:
            - Created
            - Downloading
            - Downloaded
            - Validating
            - In Queue
            - Processing
            - Ready
            - Failed
          description: Determines the media's status, which can be one of the possible values.
        mp4Support:
          type: string
          example: capped_4k
          enum:
            - none
            - capped_4k
            - audioOnly
            - audioOnly,capped_4k
          description: |
            Determines the type of MP4 support for the media.
            - **none**: Disables MP4 support.
            - **capped_4k**: Enables MP4 downloads with resolutions up to 4K.
            - **audioOnly**: Provides an MP4 stream containing only the audio.
            - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.
        sourceAccess:
          type: boolean
          nullable: true
          example: true
          description: The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.
        playbackIds:
          type: array
          items:
            $ref: "#/components/schemas/PlaybackId"
          description: A collection of Playback ID objects utilized for crafting HLS playback URLs.
        tracks:
          type: array
          items:
            oneOf:
              - $ref: "#/components/schemas/VideoTrack"
              - $ref: "#/components/schemas/AudioTrack"
              - $ref: "#/components/schemas/SubtitleTrack"
          description: A media consists of different media tracks, like video, audio, and subtitle, all combined.
        generatedSubtitles:
          type: array
          nullable: true
          description: List of generated subtitle tracks associated with the media.
          items:
            $ref: "#/components/schemas/TracksSubtitles"
        summary:
          $ref: "#/components/schemas/AiSummaryRecord"
          nullable: true
          description: AI-generated summary of the media content, if available.
        chapters:
          $ref: "#/components/schemas/AiResponseRecord"
          nullable: true
          description: AI-generated chapters for the media, if available.
        namedEntities:
          $ref: "#/components/schemas/AiResponseRecord"
          nullable: true
          description: AI-extracted named entities from the media, if available.
        moderation:
          $ref: "#/components/schemas/AiResponseRecord"
          nullable: true
          description: Moderation results for the media, if available.
        isAudioOnly:
          type: boolean
          nullable: true
          example: false
          description: Indicates whether the media contains only audio (no video track).
        subtitleAvailable:
          type: boolean
          nullable: true
          example: true
          description: Indicates whether subtitles are available for the media.
        duration:
          type: string
          example: "00:00:10"
          description: The length of the media in seconds, with a maximum allowed duration of 12 hours per individual media.
        aspectRatio:
          type: string
          nullable: true
          example: "16:9"
          description: The aspect ratio of a video describes its shape based on the relationship between its width and height.
        createdAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was created, defined as a localDateTime (UTC Time).
        updatedAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was updated, defined as a localDateTime (UTC Time).
    Update-Media:
      type: object
      properties:
        thumbnail:
          type: string
          example: https://images.fastpix.com/6b13fdaf-f9ac-4970-a13b-01ea417e8783/thumbnail.png
          description: A video thumbnail is a still image that acts as the preview image for your video.
        id:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        workspaceId:
          type: string
          format: uuid
          example: 5ta85f64-5717-4562-b3fc-2c963f66afa6
          description: A unique identifier is generated by FastPix for the workspace.
        metadata:
          type: object
          nullable: true
          additionalProperties:
            type: string
          example:
            key1: value1
          description: '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.'
        mediaQuality:
          type: string
          example: standard
          description: The quality tier applied to the media.
          enum:
            - standard
            - pro
            - premium
        creatorId:
          type: string
          maxLength: 255
          example: 8fa85f64-5717-4562-b3fc-2c963f66afa6
          default: 8fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier of the user who created this media.
        title:
          type: string
          maxLength: 255
          example: My Video Title
          default: My Video Title
          description: Title of the media file.
        maxResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - 1440p
            - 1080p
            - 720p
            - 480p
            - 360p
          description: The maximum resolution specified by the user for the media.
        sourceResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - "2160"
            - 1440p
            - "1440"
            - 1080p
            - "1080"
            - 720p
            - "720"
            - 480p
            - "480"
            - 360p
            - "360"
          description: The actual resolution of the uploaded media. This represents the native quality of the source media.
        status:
          type: string
          example: preparing
          enum:
            - Created
            - Downloading
            - Downloaded
            - Validating
            - In Queue
            - Processing
            - Ready
            - Failed
          description: Determines the media's status, which can be one of the possible values.
        mp4Support:
          type: string
          example: capped_4k
          enum:
            - none
            - capped_4k
            - audioOnly
            - audioOnly,capped_4k
          description: |
            Determines the type of MP4 support for the media.
            - **none**: Disables MP4 support.
            - **capped_4k**: Enables MP4 downloads with resolutions up to 4K.
            - **audioOnly**: Provides an MP4 stream containing only the audio.
            - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.
        sourceAccess:
          type: boolean
          example: true
          description: The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it
        playbackIds:
          type: array
          items:
            $ref: '#/components/schemas/PlaybackId'
          description: A collection of Playback ID objects utilized for crafting HLS playback URLs.
        tracks:
          type: array
          items:
            oneOf:
              - $ref: "#/components/schemas/VideoTrack"
              - $ref: "#/components/schemas/AudioTrack"
              - $ref: "#/components/schemas/SubtitleTrack"
          description: A media consists of different media tracks, like video, audio, and subtitle, all combined.
        generatedSubtitles:
          type: array
          nullable: true
          description: List of generated subtitle tracks associated with the media.
          items:
            $ref: "#/components/schemas/TracksSubtitles"
        summary:
          $ref: "#/components/schemas/AiSummaryRecord"
          nullable: true
          description: AI-generated summary of the media content, if available.
        chapters:
          $ref: "#/components/schemas/AiResponseRecord"
          nullable: true
          description: AI-generated chapters for the media, if available.
        namedEntities:
          $ref: "#/components/schemas/AiResponseRecord"
          nullable: true
          description: AI-extracted named entities from the media, if available.
        moderation:
          $ref: "#/components/schemas/AiResponseRecord"
          nullable: true
          description: Moderation results for the media, if available.
        isAudioOnly:
          type: boolean
          nullable: true
          example: false
          description: Indicates whether the media contains only audio (no video track).
        subtitleAvailable:
          type: boolean
          description: Specifies whether subtitle tracks are available for the media.
          example: false
        duration:
          type: string
          example: '00:00:10'
          description: The length of the media in seconds, with a maximum allowed duration of 12 hours per individual media.
        aspectRatio:
          type: string
          example: '16:9'
          description: The aspect ratio of a video is a value that describes the relative shape of a video based on its width and height.
        createdAt:
          type: string
          format: date-time
          example: '2023-10-20T10:50:34.594302Z'
          description: Time the media was created, defined as a localDateTime (UTC Time).
        updatedAt:
          type: string
          format: date-time
          example: '2023-10-20T10:50:34.594302Z'
          description: Time the media was updated, defined as a localDateTime (UTC Time).
    TracksSubtitles:
      type: object
      properties:
        status:
          type: string
          example: preparing
          description: Current status of the generated subtitle track.
        url:
          type: string
          nullable: true
          format: uri
          example: https://stream.fastpix.com/subtitles/abc123.vtt
          description: URL of the generated subtitle file (VTT). Null while preparing.
    AiResponseRecord:
      type: object
      properties:
        status:
          type: string
          nullable: true
          example: ready
          description: The status of the AI processing (for example, "available", "preparing", "failed").
        data:
          type: object
          nullable: true
          description: The AI-generated content data. Can be a Map, List, or other structured data depending on the AI feature type.
          additionalProperties: true
      description: Represents an AI response record containing status and data for AI-generated features like summary, chapters, named entities, or moderation.
    AiSummaryRecord:
      type: object
      properties:
        status:
          type: string
          nullable: true
          example: ready
          description: The status of the AI processing (for example, "available", "preparing", "failed").
        data:
          type: string
          nullable: true
          description: The AI-generated summary of the media content. This field contains the processed textual output produced by the AI once summarization is complete.
          additionalProperties: true
      description: Represents an AI response record containing status and data for AI-generated features like summary, chapters, named entities, or moderation.
    VideoTrack:
      type: object
      description: A media consists of different media tracks, like video, audio, and subtitle, all combined.
      properties:
        id:
          type: string
          format: uuid
          example: 9oa85f64-5717-4562-b3fc-2c963f66afa6
          description: FastPix generates a unique identifier for each track.
        type:
          type: string
          enum:
            - video
          example: video
          description: Defines the type of input. This option is mandatory.
        width:
          type: number
          example: 1920
          description: Track width denotes the range of widths applicable to a specific track. Currently, this setting can be modified only for video tracks
        height:
          type: number
          example: 1080
          description: Track height denotes the range of height applicable to a specific track. Currently, this setting can be modified only for video tracks.
        frameRate:
          type: string
          example: 30/1
          description: Frame rate quantifies the speed at which frames are displayed per second. It represents the range of frames available for a specific track. The indeterminable frame rate of the input file is indicated by a value of -1.
        status:
          type: string
          example: available
          description: Indicates the current state of the track. 'available' means the track has been processed successfully and is ready to be used or played.
      example:
        tracks:
          - id: 9oa85f64-5717-4562-b3fc-2c963f66afa6
            type: video
            width: 1920
            height: 1080
            frameRate: 30/1
            status: available
    VideoTrackForGetAll:
      type: object
      description: A media consists of different media tracks, like video, audio, and subtitle, all combined.
      properties:
        id:
          type: string
          format: uuid
          example: 9oa85f64-5717-4562-b3fc-2c963f66afa6
          description: FastPix generates a unique identifier for each track.
        type:
          type: string
          enum:
            - video
          example: video
          description: Defines the type of input. This option is mandatory.
        width:
          type: number
          example: 1920
          description: Track width denotes the range of widths applicable to a specific track. Currently, this setting can be modified only for video tracks
        height:
          type: number
          example: 1080
          description: Track height denotes the range of height applicable to a specific track. Currently, this setting can be modified only for video tracks.
        frameRate:
          type: string
          example: 30/1
          description: Frame rate quantifies the speed at which frames are displayed per second. It represents the range of frames available for a specific track. The indeterminable frame rate of the input file is indicated by a value of -1.
        status:
          type: string
          example: available
          description: Indicates the current state of the track. 'available' means the track has been processed successfully and is ready to be used or played.
      example:
        tracks:
          - id: 9oa85f64-5717-4562-b3fc-2c963f66afa6
            type: video
            width: 1920
            height: 1080
            frameRate: 30/1
            status: available
    SubtitleTrack:
      type: object
      description: A media consists of different media tracks, like video, audio, and subtitle, all combined.
      properties:
        id:
          type: string
          format: uuid
          example: 9oa85f64-5717-4562-b3fc-2c963f66afa6
          description: FastPix generates a unique identifier for each track.
        type:
          type: string
          enum: [subtitle]
          example: subtitle
          description: Defines the type of input track.
        status:
          type: string
          example: available
          description: Indicates the current state of the track. 'available' means the track has been processed successfully and is ready to be used or played.
        languageName:
          type: string
          example: english
          description: |
            Name of the language in which the subtitles will be generated.
        languageCode:
          type: string
          example: en
          description: |
            Language codes are concise, standardized symbols that denote languages, utilizing either two or three characters for identification. The language code must be compliant with the BCP 47 standard to ensure compatibility. (for text only).
    AudioTrack:
      type: object
      description: A media consists of different media tracks, like video, audio, and subtitle, all combined.
      properties:
        id:
          type: string
          format: uuid
          example: 9oa85f64-5717-4562-b3fc-2c963f66afa6
          description: FastPix generates a unique identifier for each track.
        type:
          type: string
          enum: [audio]
          example: audio
          description: Defines the type of input track.
        status:
          type: string
          example: available
          description: Indicates the current state of the track. 'available' means the track has been processed successfully and is ready to be used or played.
        languageName:
          type: string
          example: english
          description: |
            Name of the language in which the subtitles will be generated.
        languageCode:
          type: string
          example: en
          description: |
            Language codes are concise, standardized symbols that denote languages, utilizing either two or three characters for identification. The language code must be compliant with the BCP 47 standard to ensure compatibility. (for text only).
    PlaybackId:
      type: object
      description: A collection of Playback ID objects utilized for crafting HLS playback urls.
      properties:
        id:
          type: string
          format: uuid
          nullable: true
          example: 6ta85f64-5717-4562-b3fc-2c963f66afa6
          description: A unique identifier is generated by FastPix for the playbacks.
        accessPolicy:
          $ref: "#/components/schemas/AccessPolicy"
        accessRestrictions:
          type: object
          description: Controls access based on domains and user agents. Defines a default policy (either "allow" or "deny") and provides lists for explicitly allowed or denied domains and user agents.
          properties:
            domains:
              type: object
              description: Restrictions based on the originating domain of a request (for example, whether requests from certain websites must be allowed or blocked).
              properties:
                defaultPolicy:
                  $ref: "#/components/schemas/PolicyAction"
                allow:
                  type: array
                  items:
                    type: string
                  description: A list of domains that are explicitly allowed access.
                deny:
                  type: array
                  items:
                    type: string
                  description: A list of domains that are explicitly blocked from accessing the resource.
            userAgents:
              type: object
              description: Restrictions based on the user agent (which is typically a string sent by browsers or bots identifying themselves).
              properties:
                defaultPolicy:
                  $ref: "#/components/schemas/PolicyAction"
                allow:
                  type: array
                  items:
                    type: string
                  description: A list of specific user agents that are allowed to access the resource.
                deny:
                  type: array
                  items:
                    type: string
                  description: A list of specific user agents that are blocked.
    CreatePlaybackId:
      type: object
      description: A collection of Playback ID objects utilized for crafting HLS playback urls.
      properties:
        id:
          type: string
          format: uuid
          example: 6ta85f64-5717-4562-b3fc-2c963f66afa6
          description: A unique identifier is generated by FastPix for the playbacks.
        accessPolicy:
          $ref: "#/components/schemas/AccessPolicy"
        accessRestrictions:
          type: object
          description: Controls access based on domains and user agents. Defines a default policy (either "allow" or "deny") and provides lists for explicitly allowed or denied domains and user agents.
          properties:
            domains:
              type: object
              description: Restrictions based on the originating domain of a request (for example, whether requests from certain websites should be allowed or blocked).
              properties:
                defaultPolicy:
                  $ref: "#/components/schemas/PolicyAction"
                allow:
                  type: array
                  items:
                    type: string
                  description: A list of domains that are explicitly allowed access.
                deny:
                  type: array
                  items:
                    type: string
                  description: A list of domains that are explicitly blocked from accessing the resource.
            userAgents:
              type: object
              description: Restrictions based on the user agent (which is typically a string sent by browsers or bots identifying themselves).
              properties:
                defaultPolicy:
                  $ref: "#/components/schemas/PolicyAction"
                allow:
                  type: array
                  items:
                    type: string
                  description: A list of specific user agents that are allowed to access the resource.
                deny:
                  type: array
                  items:
                    type: string
                  description: A list of specific user agents that are blocked.
        resolution:
          type: string
          nullable: true
          enum:
            - 480p
            - 720p
            - 1080p
            - 1440p
            - 2160p
          description: The maximum resolution for the playback ID. May be null when no maximum resolution is set.
          example: 1080p

    Unused-uploads-playbackId:
      type: object
      description: A collection of Playback ID objects utilized for crafting HLS playback urls.
      properties:
        accessPolicy:
          $ref: "#/components/schemas/AccessPolicy"
        accessRestrictions:
          type: object
          description: Controls access based on domains and user agents. Defines a default policy (either "allow" or "deny") and provides lists for explicitly allowed or denied domains and user agents.
          properties:
            domains:
              type: object
              description: Restrictions based on the originating domain of a request (for example, whether requests from certain websites must be allowed or blocked).
              properties:
                defaultPolicy:
                  $ref: "#/components/schemas/PolicyAction"
                allow:
                  type: array
                  items:
                    type: string
                  description: A list of domains that are explicitly allowed access.
                deny:
                  type: array
                  items:
                    type: string
                  description: A list of domains that are explicitly blocked from accessing the resource.
            userAgents:
              type: object
              description: Restrictions based on the user agent (which is typically a string sent by browsers or bots identifying themselves).
              properties:
                defaultPolicy:
                  $ref: "#/components/schemas/PolicyAction"
                allow:
                  type: array
                  items:
                    type: string
                  description: A list of specific user agents that are allowed to access the resource.
                deny:
                  type: array
                  items:
                    type: string
                  description: A list of specific user agents that are blocked.

    SummaryResponse:
      properties:
        mediaId:
          type: string
          format: uuid
          example: c695988b-ff84-42ae-bb21-10f284fedb0e
        isSummaryEnabled:
          type: boolean
          example: true
    ChaptersResponse:
      properties:
        mediaId:
          type: string
          format: uuid
          example: c695988b-ff84-42ae-bb21-10f284fedb0e
        isChaptersEnabled:
          type: boolean
          example: true
    NamedEntitiesResponse:
      properties:
        mediaId:
          type: string
          format: uuid
          example: c695988b-ff84-42ae-bb21-10f284fedb0e
        isNamedEntitiesEnabled:
          type: boolean
          example: true
    ModerationResponse:
      properties:
        mediaId:
          type: string
          format: uuid
          example: c695988b-ff84-42ae-bb21-10f284fedb0e
        isModerationEnabled:
          type: boolean
          example: true
    CreateMediaRequest:
      required:
        - accessPolicy
        - inputs
      properties:
        inputs:
          type: array
          description: >
            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  
                    <a href="https://fastpix.com/docs/get-started/overview" target="_blank">FastPix Video on Demand Overview</a>.
          items:
            anyOf:
              - $ref: "#/components/schemas/PullVideoInput"
              - $ref: "#/components/schemas/WatermarkInput"
              - $ref: "#/components/schemas/AudioInput"
              - $ref: "#/components/schemas/SubtitleInput"
          default:
            - type: video
              url: https://static.fastpix.com/fp-sample-video.mp4
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          default:
            key1: value1
          example:
            key1: value1
          description: |
            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.
        drmConfigurationId:
          type: string
          format: uuid
          description: UUID of the DRM configuration to be used
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        title:
          type: string
          maxLength: 255
          example: My Video Title
          description: Title of the media file.
        creatorId:
          type: string
          maxLength: 255
          example: 8fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier of the user who created this media.
        subtitles:
          type: object
          description: |
            Generates subtitle files for audio/video files.
          properties:
            languageName:
              type: string
              example: english
              description: |
                Name of the language in which the subtitles will be generated.
            metadata:
              type: object
              additionalProperties:
                type: string
                maxLength: 255
              maxProperties: 10
              example:
                key1: value1
              description: |
                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.
            languageCode:
              type: string
              example: en
              enum:
                - en
                - it
                - pl
                - es
                - fr
                - ru
                - nl
              description: |
                Language codes are concise, standardized symbols that denote languages, utilizing either two or three characters for identification. The language code must be compliant with the BCP 47 standard to ensure compatibility. (for text only).
        accessPolicy:
          type: string
          example: public
          default: public
          enum:
            - public
            - private
            - drm
          description: |
            Determines whether access to the streamed content is kept private or available to all.
        mp4Support:
          type: string
          example: capped_4k
          enum:
            - capped_4k
            - audioOnly
            - audioOnly,capped_4k
          description: |
            "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
        sourceAccess:
          type: boolean
          example: true
          description: The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it
        optimizeAudio:
          type: boolean
          example: true
          description: |
            normalize volume of the audio track. This is available for pre-recorded content only.
        maxResolution:
          type: string
          example: 1080p
          default: 1080p
          enum:
            - 2160p
            - 1440p
            - 1080p
            - 720p
            - 480p
          description: |
            The maximum resolution tier defines the highest quality at which your media is available.
        mediaQuality:
          type: string
          example: standard
          default: standard
          description: The quality tier applied to the media.
          enum:
            - standard
            - pro
            - premium
        summary:
          type: object
          properties:
            generate:
              type: boolean
              description: |
                Enable or disable the summary feature for the media. 
                Set to true to enable summary or false to disable.
            summaryLength:
              type: integer
              maximum: 250
              minimum: 30
              description: |
                Specifies the desired word count for the generated summary.
                - The value must be between **30** and **250** words.
        chapters:
          type: boolean
          example: true
          description: |
            Enable or disable the chapters feature for the media. Set to `true` to enable chapters or `false` to disable.
        namedEntities:
          type: boolean
          example: true
          description: |
            Enable or disable named entity extraction. Set to `true` to enable or `false` to disable.
        moderation:
          type: object
          properties:
            type:
              type: string
              enum: [video, audio, av]
              description: |
                Defines the type of input. Possible values include video, audio, or av.
        accessRestrictions:
          type: object
          properties:
            domains:
              type: object
              properties:
                defaultPolicy:
                  type: string
                  enum:
                    - allow
                    - deny
                  description: |
                    Specifies the default access policy for domains. 
                    If set to `allow`, all domains are allowed access unless otherwise specified in the `deny` lists. 
                    If set to `deny`, all domains are denied access unless otherwise specified in the `allow` lists.
                allow:
                  type: array
                  items:
                    type: string
                  description: |
                    A list of domain names or patterns that are explicitly allowed access. 
                    This list is only effective when the `defaultPolicy` is set to `deny`.
                deny:
                  type: array
                  items:
                    type: string
                  description: |
                    A list of domain names or patterns that are explicitly denied access. 
                    This list is only effective when the `defaultPolicy` is set to `allow`.
            userAgents:
              type: object
              properties:
                defaultPolicy:
                  type: string
                  enum:
                    - allow
                    - deny
                  description: |
                    Specifies the default access policy for user agents (browsers, bots, etc.).
                    If set to `allow`, all user agents are allowed access unless otherwise specified in the `deny` lists. 
                    If set to `deny`, all user agents are denied access unless otherwise specified in the `allow` lists.
                allow:
                  type: array
                  items:
                    type: string
                  description: |
                    A list of user agents (identified by string names or patterns) that are explicitly allowed access. 
                    This list is only effective when the `defaultPolicy` is set to `deny`.
                deny:
                  type: array
                  items:
                    type: string
                  description: |
                    A list of user agents (identified by string names or patterns) that are explicitly denied access. 
                    This list is only effective when the `defaultPolicy` is set to `allow`.
      example:
        inputs:
          - type: video
            url: https://static.fastpix.com/gtv-videos-bucket/sample/ForBiggerJoyrides.mp4
        metadata:
          key1: value1
        accessPolicy: public
        maxResolution: 1080p
        mediaQuality: standard
    VideoInput:
      required:
        - type
      properties:
        type:
          type: string
          example: video
          description: |
            Defines the type of input.
        introUrl:
          type: string
          example: https://static.fastpix.com/sample.mp4
          description: |
            The url of the intro video which is to be added at the start of the video.
        outroUrl:
          type: string
          example: https://static.fastpix.com/sample.mp4
          description: |
            The url of the outro video which is to be added at the end of the video.
        expungeSegments:
          type: array
          description: |
            The list of the startTime-endTime of the segments to be removed from the actual video.
          items:
            type: string
            example: 4-6
          example:
            - 4-6
            - 15-19
        segments:
          type: array
          description: 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 should be added at the end (`insertAtEnd`).
          items:
            type: object
            oneOf:
              - type: object
                required:
                  - url
                  - insertAt
                properties:
                  url:
                    type: string
                    format: uri
                    description: URL of the segment to be added.
                    example: https://storage.googleapis.com/gtv-videos-mp4
                  insertAt:
                    type: integer
                    description: The timestamp at which the segment should be inserted.
                    example: 2
              - type: object
                required:
                  - url
                  - insertAtEnd
                properties:
                  url:
                    type: string
                    format: uri
                    description: URL of the segment to be added.
                    example: https://storage.googleapis.com/gtv-videos-mp4
                  insertAtEnd:
                    type: boolean
                    description: Flag indicating the segment should be inserted at the end.
                    example: true
    PullVideoInput:
      required:
        - url
        - type
      properties:
        type:
          type: string
          example: video
          default: video
          description: |
            Defines the type of input.
        url:
          type: string
          example: https://static.fastpix.com/fp-sample-video.mp4
          default: https://static.fastpix.com/fp-sample-video.mp4
          description: |
            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.
        startTime:
          type: integer
          example: "0"
          description: |
            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.
        endTime:
          type: integer
          example: "60"
          description: |
            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.
        introUrl:
          type: string
          example: https://static.fastpix.com/fp-sample-video.mp4
          description: |
            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.

        outroUrl:
          type: string
          example: https://static.fastpix.com/fp-sample-video.mp4
          description: |
            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:
          type: array
          description: |
            The list of start and end times (in seconds) of the segments to be removed from the actual video.
          items:
            type: string
            example: 4-6
          example:
            - 4-6
            - 15-19
        segments:
          type: array
          description: 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`).
          items:
            type: object
            oneOf:
              - type: object
                required:
                  - url
                  - insertAt
                properties:
                  url:
                    type: string
                    format: uri
                    example: https://storage.googleapis.com/gtv-videos-mp4/sample-segment.mp4
                    description: |
                      The URL of the **video segment** to be added.  
                      The URL must be **valid, publicly accessible, and downloadable** so that FastPix can retrieve and process the segment successfully.  
                      Supported video formats include **MP4, MOV, MKV, and TS** for best compatibility and performance.

                  insertAt:
                    type: integer
                    description: The timestamp(in seconds) at which the segment must be inserted.
                    example: 2
              - type: object
                required:
                  - url
                  - insertAtEnd
                properties:
                  url:
                    type: string
                    format: uri
                    description: |
                      The URL of the **video segment** to be added.  
                      The URL must be **valid, publicly accessible, and downloadable** so that FastPix can retrieve and process the segment successfully.  
                      Supported video formats include **MP4, MOV, MKV, and TS** for best compatibility and performance.
                    example: https://storage.googleapis.com/gtv-videos-mp4
                  insertAtEnd:
                    type: boolean
                    description: Flag indicating the segment should be inserted at the end.
                    example: true
    WatermarkInput:
      description: |
        Contains configuration details for applying a watermark overlay to a video.  
        The watermark is placed over the media content during processing.  
        For detailed setup steps and customization options, refer to the 
        <a href="https://fastpix.com/docs/edit-and-transform-videos/add-a-watermark-to-a-video" target="_blank">FastPix Watermark Guide</a>.
      required:
        - url
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - watermark
          description: Type of overlay (currently only supports "watermark").
          example: watermark
        url:
          type: string
          format: uri
          description: URL of the watermark image.
          example: https://static.fastpix.com/watermark-4k.png
        placement:
          type: object
          properties:
            xAlign:
              type: string
              enum:
                - left
                - center
                - right
              description: Horizontal alignment of the watermark.
              example: left
            xMargin:
              type: string
              description: Horizontal margin from the edge of the video.
              example: 10%
            yAlign:
              type: string
              enum:
                - top
                - middle
                - bottom
              description: Vertical alignment of the watermark.
              example: top
            yMargin:
              type: string
              description: Vertical margin from the edge of the video.
              example: 10%
        width:
          type: string
          description: Width of the watermark in percentage or pixels.
          example: 25%
        height:
          type: string
          description: Height of the watermark in percentage or pixels.
          example: 25%
        opacity:
          type: string
          description: Opacity of the watermark in percentage.
          example: 80%
    AudioInput:
      required:
        - swapTrackUrl
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - audio
          description: Type of overlay (currently only supports "audio").
          example: audio
        swapTrackUrl:
          type: string
          format: uri
          description: URL of the audio track to replace the existing audio in the video.
          example: https://file-examples.com/storage/fe0e9b723466913cf9611b7/2017/11/file_example_MP3_700KB.mp3
        imposeTracks:
          required:
            - url
          type: array
          description: List of additional audio tracks to overlay on the video.
          items:
            type: object
            properties:
              url:
                type: string
                format: uri
                description: URL of the audio track to impose on the video.
                example: http://commondatastorage.googleapis.com/codeskulptor-demos/riceracer_assets/fx/engine-2.ogg
              startTime:
                type: integer
                description: Start time (in seconds) of the imposed audio in the video.
                example: 0
              endTime:
                type: integer
                description: End time (in seconds) of the imposed audio in the video.
                example: 5
              fadeInLevel:
                type: integer
                description: Level of fade-in effect (in seconds) at the start of the imposed audio.
                example: 1
              fadeOutLevel:
                type: integer
                description: Level of fade-out effect (in seconds) at the end of the imposed audio.
                example: 4
    CreateMediaResponse:
      properties:
        id:
          type: string
          example: a1d1acdd-8f4e-4add-b498-6b398cf349d9
          description: The Media is assigned a universal unique identifier, which can contain a maximum of 255 characters.
        trial:
          type: boolean
          default: true
          example: true
          description: |
            FastPix allows for a free trial. Create as many media files as you like during the trial period. Remember, each clip can only be 10 seconds long and will be deleted after 24 hours. Also, all trial content will have the FastPix logo watermark.
        status:
          type: string
          example: Created
          enum:
            - Created
            - Downloading
            - Downloaded
            - Validating
            - In Queue
            - Processing
            - Ready
            - Failed
          description: Determines the media's status, which can be one of the possible values.
        createdAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was created, defined as a localDateTime (UTC Time).
        updatedAt:
          type: string
          format: date-time
          example: "2023-10-20T10:50:34.594302Z"
          description: Time the media was updated, defined as a localDateTime (UTC Time).
        playbackIds:
          type: array
          items:
            $ref: "#/components/schemas/PlaybackId"
          description: A collection of Playback ID objects utilized for crafting HLS playback URLs.
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          example:
            key1: value1
          description: |
            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.
        mediaQuality:
          type: string
          example: standard
          description: The quality tier applied to the media.
          enum:
            - standard
            - pro
            - premium
        sourceAccess:
          type: boolean
          example: false
          description: |
            The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.
        maxResolution:
          type: string
          example: 1080p
          enum:
            - 2160p
            - 1440p
            - 1080p
            - 720p
            - 480p
          description: The maximum resolution tier defines the highest quality at which your media is available.
        inputs:
          type: array
          description: A list of media input sources to be processed.
          items:
            type: object
            properties:
              type:
                type: string
                description: The type of input media. Commonly set to `video`.
                example: video
              url:
                type: string
                format: uri
                description: The publicly accessible URL of the input video file.
                example: https://static.fastpix.com/fp-sample-video.mp4
        optimizeAudio:
          type: boolean
          example: false
          description: |
            Enhance the quality and volume of the audio track. This is available for pre-recorded content only.
    TrackSubtitlesGenerateRequest:
      required:
        - languageName
        - languageCode
      type: object
      description: Contains details for generating subtitle tracks for a media file.
      properties:
        languageName:
          type: string
          description: The full name of the language used to generate the subtitles.
          example: English
          default: English
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          example:
            key1: value1
          default:
            key1: value1
          description: |
            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.
        languageCode:
          $ref: "#/components/schemas/LanguageCode"
    GenerateTrackResponse:
      type: object
      description: Represents the response for a successfully generated subtitle track.
      properties:
        id:
          type: string
          format: uuid
          description: A unique identifier for the generated track.
          example: ace60fc7-e876-4fc6-b9d9-c33fa242f84b
        type:
          type: string
          description: The type of track generated ("subtitle").
          enum:
            - subtitle
          example: subtitle
        languageCode:
          type: string
          description: |
            The BCP 47 language code representing the language of the generated track.
          example: en-US
          enum:
            - ar-SA
            - bn-BD
            - bn-IN
            - ca-ES
            - cs-CZ
            - da-DK
            - de-AT
            - de-CH
            - de-DE
            - el-GR
            - en-AU
            - en-CA
            - en-GB
            - en-IE
            - en-IN
            - en-NZ
            - en-US
            - en-ZA
            - es-AR
            - es-CL
            - es-CO
            - es-ES
            - es-MX
            - es-US
            - fi-FI
            - fr-BE
            - fr-CA
            - fr-CH
            - fr-FR
            - he-IL
            - hi-IN
            - hr-HR
            - hu-HU
            - id-ID
            - it-CH
            - it-IT
            - ja-JP
            - ko-KR
            - nl-BE
            - nl-NL
            - no-NO
            - pl-PL
            - pt-BR
            - pt-PT
            - ro-RO
            - ru-RU
            - sk-SK
            - sv-SE
            - ta-IN
            - ta-LK
            - th-TH
            - tr-TR
            - uk-UA
            - bg-BG
            - zh-CN
            - zh-HK
            - zh-TW
        languageName:
          type: string
          description: The full name of the language for the generated track.
          example: English
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          example:
            key1: value1
          description: |
            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.
    SubtitleInput:
      required:
        - type
        - url
        - languageName
        - languageCode
      type: object
      description: Generates subtitle files for audio/video files.
      properties:
        type:
          type: string
          example: subtitle
          description: |
            Defines the type of input.
        url:
          type: string
          format: uri
          description: The direct URL of the subtitle file.
          example: http://commondatastorage.googleapis.com/codeskulptor-assets/sounddogs/thrust.vtt
        languageName:
          type: string
          example: english
          description: Name of the language in which the subtitles will be generated.
        languageCode:
          $ref: "#/components/schemas/LanguageCode"
    AddTrackRequest:
      type: object
      description: Contains details about the track being added to the media file.
      required:
        - url
        - type
        - languageCode
        - languageName
      properties:
        url:
          type: string
          format: uri
          description: The direct URL of the track file. It must point to a valid audio or subtitle file.
          example: https://static.fastpix.com/music-1.mp3
          default: https://static.fastpix.com/music-1.mp3
        type:
          type: string
          enum:
            - audio
            - subtitle
          description: Specifies the type of track being added. It can be either `audio` or `subtitle`.
          example: audio
          default: audio
        languageCode:
          type: string
          description: The BCP 47 language code representing the track’s language.
          example: it
          default: it
        languageName:
          type: string
          description: The full name of the language corresponding to the `languageCode`.
          example: Italian
          default: Italian

    AddTrackResponse:
      type: object
      description: Contains details about the track that was added or updated.
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the track.
          example: ace60fc7-e876-4fc6-b9d9-c33fa242f84b
        type:
          type: string
          enum:
            - audio
            - subtitle
          description: Specifies the type of track (audio or subtitle).
          example: audio
        url:
          type: string
          format: uri
          description: The direct URL of the track file.
          example: https://static.fastpix.com/music-1.mp3
        languageCode:
          type: string
          description: The BCP 47 language code representing the track's language.
          example: it
        languageName:
          type: string
          description: The full name of the language corresponding to the `languageCode`.
          example: Italian
    UpdateTrackResponse:
      type: object
      description: Contains details about the track that was added or updated.
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the track.
          example: a5833611-e92c-4ba9-89f0-a42f8e9aef5e
        type:
          type: string
          enum:
            - audio
            - subtitle
          description: Specifies the type of track (audio or subtitle).
          example: subtitle
        url:
          type: string
          format: uri
          description: The direct URL of the track file.
          example: http://commondatastorage.googleapis.com/codeskulptor-assets/sounddogs/thrust.vtt
        languageCode:
          type: string
          description: The BCP 47 language code representing the track's language.
          example: fr
        languageName:
          type: string
          description: The full name of the language corresponding to the `languageCode`.
          example: french
    UpdateTrackRequest:
      type: object
      description: Contains details about the track being added to the media file.
      required:
        - url
        - languageCode
        - languageName
      properties:
        url:
          type: string
          format: uri
          description: The direct URL of the track file. It must point to a valid audio or subtitle file.
          example: http://commondatastorage.googleapis.com/codeskulptor-assets/sounddogs/thrust.vtt
          default: http://commondatastorage.googleapis.com/codeskulptor-assets/sounddogs/thrust.vtt
        languageCode:
          type: string
          description: The BCP 47 language code representing the track’s language.
          example: fr
          default: fr
        languageName:
          type: string
          description: The full name of the language corresponding to the `languageCode`.
          example: French
          default: French

    DirectUpload:
      type: object
      description: Displays the result of the request.
      properties:
        uploadId:
          type: string
          example: 7ya85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        trial:
          type: boolean
          example: false
          description: Indicates if the upload was a trial.
        status:
          type: string
          example: waiting
          enum:
            - waiting
          description: Determines the media's status, which can be one of the possible values.
        url:
          type: string
          example:
            url: https://storage.fastpix.net/uploads/08256f2c-efca-4c4f-8f21-75e40d49f225/80911756-1ce3-485a-a3b4-6653ff0937a1?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=media-svc%2F20240111%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240111T123116Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=419ab443cdc1d4a22cf1b0f8875855590b346058e6d3859f7c1c9da3bb061f91
          description: The url hosts the media file for FastPix, which needs to be download to use further.  It supports formats like MP3, MP4, MOV, MKV, or TS, and includes text tracks for subtitles/CC (SRT file/VTT file). While FastPix can handle various audio and video formats and codecs, using standard inputs can help with optimal processing speed.
        timeout:
          type: number
          example: 14400
          default: 14400
          description: |
            The duration set for the validity of the upload URL. If the upload isn't completed within this timespan, it's marked as timed out.
        corsOrigin:
          type: string
          example: "*"
          description: Upload media directly from a device using the url name or enter "*" to allow all.
        pushMediaSettings:
          $ref: "#/components/schemas/DirectUploadResponse"
    DirectUploadResponse:
      properties:
        playbackIds:
          type: array
          items:
            $ref: "#/components/schemas/PlaybackId"
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          example:
            key1: value1
          description: |
            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.
        mediaQuality:
          type: string
          example: standard
          description: The quality tier applied to the media.
          enum:
            - standard
            - pro
            - premium
        sourceAccess:
          type: boolean
          example: false
          description: |
            The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.
        optimizeAudio:
          type: boolean
          example: false
          description: |
            Enhance the quality and volume of the audio track. This is available for pre-recorded content only.

    UnusedDirectUpload:
      type: object
      description: Displays the result of the request.
      properties:
        uploadId:
          type: string
          example: 7ya85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier assigned to the media when created. The value must be a valid UUID.
        trial:
          type: boolean
          example: false
          description: Indicates if the upload was a trial.
        status:
          type: string
          example: waiting
          enum:
            - waiting
          description: Determines the media's status, which can be one of the possible values.
        url:
          type: string
          example:
            url: https://storage.fastpix.net/uploads/08256f2c-efca-4c4f-8f21-75e40d49f225/80911756-1ce3-485a-a3b4-6653ff0937a1?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=media-svc%2F20240111%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240111T123116Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=419ab443cdc1d4a22cf1b0f8875855590b346058e6d3859f7c1c9da3bb061f91
          description: The url hosts the media file for FastPix, which needs to be download to use further.  It supports formats like MP3, MP4, MOV, MKV, or TS, and includes text tracks for subtitles/CC (SRT file/VTT file). While FastPix can handle various audio and video formats and codecs, using standard inputs can help with optimal processing speed.
        timeout:
          type: number
          example: 14400
          default: 14400
          description: |
            The duration set for the validity of the upload URL. If the upload isn’t completed within this timespan, it is marked as timed out.
        corsOrigin:
          type: string
          example: "*"
          description: Upload media directly from a device using the url name or enter "*" to allow all.
        pushMediaSettings:
          $ref: "#/components/schemas/UnusedDirectUploadResponse"
    UnusedDirectUploadResponse:
      properties:
        playbackIds:
          type: array
          items:
            $ref: "#/components/schemas/Unused-uploads-playbackId"
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          example:
            key1: value1
          description: |
            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.
        mediaQuality:
          type: string
          example: standard
          description: The quality tier applied to the media.
          enum:
            - standard
            - pro
            - premium
        sourceAccess:
          type: boolean
          example: false
          description: |
            The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.
        optimizeAudio:
          type: boolean
          example: false
          description: |
            Enhance the quality and volume of the audio track. This is available for pre-recorded content only.

    Default-Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
          description: Shows if the request was completed successfully. Returns `true` for success and `false` for failure.
        error:
          type: object
          description: Contains details about the error if the request failed.
          properties:
            code:
              type: integer
              example: HTTP status code
              description: The HTTP status code that explains the type of error (for example, 400 for a bad request, 404 for not found).
            message:
              type: string
              example: Message describing the error
              description: A short message describing what went wrong.
            description:
              type: string
              example: Detailed explanation of why the request failed
              description: |
                A detailed explanation of the error and what caused it. May also include links to documentation or tips for fixing the issue.  

    Pagination:
      type: object
      description: Pagination organizes content into pages for better readability and navigation.
      properties:
        totalRecords:
          type: integer
          example: 100
          description: It gives the total number of media assets that are accessible overall.
        currentOffset:
          type: integer
          example: 1
          description: "Offset determines the current point for data retrieval within a paginated list. "
        offsetCount:
          type: integer
          example: 10
          description: The offset count is expressed as total records by limit
    SigningKeysPagination:
      type: object
      description: Pagination organizes content into pages for better readability and navigation.
      properties:
        totalRecords:
          type: integer
          example: 1
          description: It gives the total number of Signing keys that are created by a user.
        currentOffset:
          type: integer
          example: 1
          description: Offset determines the current point for data retrieval within a paginated list.
        offsetCount:
          type: integer
          example: 10
          description: The offset count is expressed as total records by limit
    CreatePlaylistRequest:
      oneOf:
        - $ref: "#/components/schemas/CreatePlaylistRequestManual"
        - $ref: "#/components/schemas/CreatePlaylistRequestSmart"
      discriminator:
        propertyName: type
        mapping:
          manual: "#/components/schemas/CreatePlaylistRequestManual"
          smart: "#/components/schemas/CreatePlaylistRequestSmart"

    CreatePlaylistRequestManual:
      type: object
      additionalProperties: false
      required:
        - name
        - referenceId
        - type
      properties:
        name:
          type: string
          description: Name of the playlist.
          example: "Playlist name"
        referenceId:
          type: string
          description: Unique string value assigned by user to the playlist.
          example: "a1"
        type:
          type: string
          enum:
            - manual
          example: "manual"
          description: Manual playlist type (no `playOrder`).
        description:
          type: string
          example: "This is a playlist"
          description: Description for a playlist (Optional).
        limit:
          type: integer
          default: 1000
          description: Optional parameter to limit no. of media in a playlist.

    CreatePlaylistRequestSmart:
      type: object
      additionalProperties: false
      required:
        - name
        - referenceId
        - type
        - playOrder
        - metadata
      properties:
        name:
          type: string
          description: Name of the playlist.
          example: "Playlist name"
        referenceId:
          type: string
          description: Unique string value assigned by user to the playlist.
          example: "a1"
        type:
          type: string
          enum:
            - smart
          example: "smart"
          description: For a smart playlist metadata is required.
        description:
          type: string
          example: "This is a playlist"
          description: Description for a playlist (Optional).
        playOrder:
          $ref: "#/components/schemas/PlaylistOrder"
        limit:
          type: integer
          default: 1000
          description: Optional parameter to limit no. of media in a playlist.
        metadata:
          type: object
          properties:
            createdDate:
              $ref: "#/components/schemas/DateRange"
            updatedDate:
              $ref: "#/components/schemas/DateRange"
          description: Required when the playlist type is `smart`. Media created between `startDate` and `endDate` of `createdDate` is added. Optionally, you can include media based on `updatedDate`.
      example:
        name: playlist name
        referenceId: a1
        type: smart
        description: This is a playlist
        playOrder: createdDate ASC
        limit: 20
        metadata:
          createdDate:
            startDate: "2024-11-11"
            endDate: "2024-12-12"
          updatedDate:
            startDate: "2024-11-11"
            endDate: "2024-12-12"
    UpdatePlaylistRequest:
      type: object
      required:
        - name
        - description
      properties:
        name:
          type: string
          description: New name to the playlist.
          example: updated name
        description:
          type: string
          description: Updated description to the playlist.
          example: updated description
      example:
        name: updated name
        description: updated description
    playlistCreatedResponse:
      type: object
      description: Displays the result of the request.
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          $ref: "#/components/schemas/playlistCreatedSchema"
      example:
        success: true
        data:
          id: e3dfdf15-16bb-4835-98b9-484c1e4320cc
          name: playist
          referenceId: a1
          type: smart
          description: This is a playlist
          playOrder: createdDate ASC
          metadata:
            createdDate:
              startDate: "2024-11-11"
              endDate: "2024-12-12"
            updatedDate:
              startDate: "2024-11-11"
              endDate: "2024-12-12"
          mediaList:
            - createdAt: "2024-11-12T05:58:38.000708Z"
              creatorId: "FastPix@14612"
              duration: "00:00:10"
              id: 942e0ced-146b-487e-988f-6de578de1000
              sourceResolution: 1080p
              status: Ready
              thumbnail: https://venus-images.fastpix.dev/ff31b32e-4979-4d2b-ad2a-685af43c9902/thumbnail.png
              title: "Media 1"
            - createdAt: "2024-12-05T07:23:18.000108Z"
              creatorId: "FastPix@14612"
              duration: "00:00:10"
              id: 6d12262b-0686-4131-9de2-bb515f7c0f38
              sourceResolution: 1080p
              status: Ready
              thumbnail: https://mercury-images.fastpix.dev/e49a0d7b-6f2c-4743-84d1-45522cc20ded/thumbnail.png
              title: "Media 2"
            - createdAt: "2024-12-05T07:21:15.000508Z"
              creatorId: "FastPix@14612"
              duration: "00:00:10"
              id: a1cd180e-f9b5-4e99-9d44-b9c9baabad89
              sourceResolution: 1080p
              status: Ready
              thumbnail: https://mercury-images.fastpix.dev/e49a0d7b-6f2c-4743-84d1-45522cc20ded/thumbnail.png
              title: "Media 3"
          workspaceId: d760b903-86ef-44d6-9b73-334130e0cf2d
          createdAt: "2025-06-04T13:29:39.409886Z"
          updatedAt: "2025-06-04T13:29:39.409886Z"
          mediaCount: 3
    PlaylistItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: db6e860f-cb57-43dd-8acf-39c9effd5608
          description: The unique id of the playlist
        name:
          type: string
          example: playlist1
          description: The name of the playlist set by the user
        type:
          type: string
          enum:
            - manual
            - smart
          example: smart
          description: type of the playlist, when it was created
        referenceId:
          type: string
          example: a111dfdfdafsdfe
          description: Unique string value assigned by user to the playlist.
        createdAt:
          type: string
          format: date-time
          example: "2025-05-12T12:55:24.368182Z"
          description: Timestamp of playlist creation.
        mediaCount:
          type: integer
          example: 9
          description: No. of media present in the playlist
    GetAllPlaylistsResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          type: array
          items:
            $ref: "#/components/schemas/PlaylistItem"
        pagination:
          $ref: "#/components/schemas/Pagination"
      example:
        success: true
        data:
          - id: db6e860f-cb57-43dd-8acf-39c9effd5608
            name: playist1
            type: smart
            referenceId: playlists101
            createdAt: "2025-06-04T13:29:04.253244Z"
            mediaCount: 0
          - id: 5c18559f-c1b1-4697-9282-77211d4396bb
            name: playist2
            type: smart
            referenceId: playlists102
            createdAt: "2025-06-04T13:01:05.073809Z"
            mediaCount: 0
          - id: a4735902-b5e6-431f-8875-7a1a2cbc7a7b
            name: Onboarding
            type: manual
            referenceId: playlists103
            createdAt: "2025-06-04T12:17:38.917664Z"
            mediaCount: 0
          - id: 1ffce718-7072-4b61-9b27-e7d18198094d
            name: December playlist
            type: manual
            referenceId: playlists104
            createdAt: "2025-05-15T11:06:51.545280Z"
            mediaCount: 0
          - id: 2455174e-64d9-4324-86bd-80cb1af5b20a
            name: March Highlights
            type: smart
            referenceId: playlists105
            createdAt: "2025-05-12T12:55:24.368182Z"
            mediaCount: 9
          - id: d55c4e51-e426-498f-b760-6f9357e2349e
            name: playlist1
            type: smart
            referenceId: playlists106
            createdAt: "2025-05-07T10:49:29.226943Z"
            mediaCount: 9
          - id: 63d73b6e-50dd-4653-990b-8a8df85ad09f
            name: playlist1
            type: smart
            referenceId: playlists107
            createdAt: "2025-05-07T10:48:09.179324Z"
            mediaCount: 9
          - id: 5a93de86-0848-4ab4-befe-8dba4b8433e5
            name: playlist1
            type: smart
            referenceId: playlists108
            createdAt: "2025-05-07T10:47:06.339271Z"
            mediaCount: 9
          - id: d315b847-38c4-431f-b1b6-32dc5013700a
            name: playlist1
            type: smart
            referenceId: playlists109
            createdAt: "2025-05-07T10:03:21.487649Z"
            mediaCount: 9
          - id: 86348042-6367-4dfc-b018-b3ee9934f45b
            name: playlist1
            type: manual
            referenceId: playlists201
            createdAt: "2025-05-05T12:48:44.177451Z"
            mediaCount: 2
        pagination:
          totalRecords: 46
          currentOffset: 1
          offsetCount: 5
    PlaylistByIdResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          $ref: "#/components/schemas/PlaylistByIdResponseData"
      example:
        success: true
        data:
          id: 46d5fce1-683a-457f-86d7-c048bb429505
          name: My Playlist
          referenceId: 122q
          type: smart
          description: This Playlist contains videos from December 2024.
          playOrder: createdDate ASC
          metadata:
            createdDate:
              endDate: 2024-12-12
              startDate: 2024-12-11
            updatedDate:
              endDate: 2024-12-12
              startDate: 2024-12-11
          mediaList:
            - createdAt: "2025-05-27T09:37:52.445936Z"
              creatorId: "FastPix@14612"
              duration: "00:00:10"
              id: a1cd180e-f9b5-4e99-9d44-b9c9baabad89
              sourceResolution: 1080p
              status: Ready
              thumbnail: https://venus-images.fastpix.dev/bed25609-1887-4c49-91a5-5c6b1edeb1a2/thumbnail.png
              title: "Media 1"
            - createdAt: "2025-04-04T13:26:23.507284Z"
              creatorId: "FastPix@14612"
              duration: "00:00:10"
              id: 245800c3-7b73-47d9-a201-e961260dcb30
              sourceResolution: 1080p
              status: Ready
              thumbnail: https://mercury-images.fastpix.dev/3c6ceeea-d24b-487f-9dd0-5a16148b5d46/thumbnail.png
              title: "Media 2"
            - createdAt: "2025-04-04T13:26:12.552840Z"
              creatorId: "FastPix@14612"
              duration: "00:00:10"
              id: 41316aac-5396-4278-8f44-08d5f2495b12
              sourceResolution: 1080p
              status: Ready
              thumbnail: https://mercury-images.fastpix.dev/8989d0d3-5c5b-41b2-89d5-df6094e6093f/thumbnail.png
              title: "Media 3"
          workspaceId: d760b903-86ef-44d6-9b73-334130e0cf2d
          createdAt: "2025-06-05T09:10:30.655275Z"
          updatedAt: "2025-06-05T12:23:47.096690Z"
          mediaCount: 3
    PlaylistByIdResponseMediaListItem:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          example: "2025-03-21T05:58:38.000708Z"
          description: Timestamp of media creation in the workspace.
        creatorId:
          type: string
          nullable: true
          example: FastPix@14612
          description: Creator ID of the media.
        duration:
          type: string
          example: "00:00:10"
          description: Duration of the media in hh:mm:ss format.
        id:
          type: string
          format: uuid
          example: 942e0ced-146b-487e-988f-6de578de1000
          description: unique id of the particular media.
        sourceResolution:
          type: string
          example: 1080p
          description: source resolution of the media.
        status:
          type: string
          example: Ready
          description: status of the media, only media with ready status is added to playlist.
        thumbnail:
          type: string
          format: uri
          example: https://venus-images.fastpix.dev/ff31b32e-4979-4d2b-ad2a-685af43c9902/thumbnail.png
          description: thumbnail for the particular media.
        title:
          type: string
          nullable: true
          example: Media 1
          description: Title of the media.
    PlaylistByIdResponseMetadata:
      type: object
      properties:
        createdDate:
          $ref: "#/components/schemas/DateRange"
        updatedDate:
          $ref: "#/components/schemas/DateRange"
      description: Required when the playlist type is `smart`. Media created between `startDate` and `endDate` of `createdDate` is added. Optionally, you can include media based on `updatedDate`.
    PlaylistByIdResponseDataManual:
      type: object
      additionalProperties: false
      required:
        - type
      properties:
        id:
          type: string
          format: uuid
          example: 2455174e-64d9-4324-86bd-80cb1af5b20a
          description: The unique id of the playlist
        name:
          type: string
          example: playlist1
          description: The name of the playlist set by the user
        referenceId:
          type: string
          example: playlists301
          description: Unique string value assigned by user to the playlist.
        type:
          type: string
          enum:
            - manual
          example: manual
          description: type of the playlist, when it was created
        description:
          type: string
          example: This is a manual playlist
          description: Description of the playlist set by the user.
        mediaList:
          type: array
          items:
            $ref: "#/components/schemas/PlaylistByIdResponseMediaListItem"
        workspaceId:
          type: string
          format: uuid
          example: d760b903-86ef-44d6-9b73-334130e0cf2d
          description: The unique id of the workspace in which the playlist is present.
        createdAt:
          type: string
          format: date-time
          example: "2025-05-12T12:55:24.368182Z"
          description: Timestamp of playlist creation.
        updatedAt:
          type: string
          format: date-time
          example: "2025-05-27T09:51:03.166094Z"
          description: Playlist's most recent update timestamp.
        mediaCount:
          type: integer
          example: 3
          description: No. of media present in the playlist
    PlaylistByIdResponseDataSmart:
      type: object
      additionalProperties: false
      required:
        - type
        - playOrder
        - metadata
      properties:
        id:
          type: string
          format: uuid
          example: 2455174e-64d9-4324-86bd-80cb1af5b20a
          description: The unique id of the playlist
        name:
          type: string
          example: playlist1
          description: The name of the playlist set by the user
        referenceId:
          type: string
          example: playlists301
          description: Unique string value assigned by user to the playlist.
        type:
          type: string
          enum:
            - smart
          example: smart
          description: type of the playlist, when it was created
        description:
          type: string
          example: This is a smart playlist
          description: Description of the playlist set by the user.
        playOrder:
          $ref: "#/components/schemas/PlaylistOrder"
        metadata:
          $ref: "#/components/schemas/PlaylistByIdResponseMetadata"
        mediaList:
          type: array
          items:
            $ref: "#/components/schemas/PlaylistByIdResponseMediaListItem"
        workspaceId:
          type: string
          format: uuid
          example: d760b903-86ef-44d6-9b73-334130e0cf2d
          description: The unique id of the workspace in which the playlist is present.
        createdAt:
          type: string
          format: date-time
          example: "2025-05-12T12:55:24.368182Z"
          description: Timestamp of playlist creation.
        updatedAt:
          type: string
          format: date-time
          example: "2025-05-27T09:51:03.166094Z"
          description: Playlist's most recent update timestamp.
        mediaCount:
          type: integer
          example: 3
          description: No. of media present in the playlist
    PlaylistByIdResponseData:
      oneOf:
        - $ref: "#/components/schemas/PlaylistByIdResponseDataManual"
        - $ref: "#/components/schemas/PlaylistByIdResponseDataSmart"
      discriminator:
        propertyName: type
        mapping:
          manual: "#/components/schemas/PlaylistByIdResponseDataManual"
          smart: "#/components/schemas/PlaylistByIdResponseDataSmart"
    PlaylistDeleteResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
    MediaIdsRequest:
      type: object
      properties:
        mediaIds:
          type: array
          items:
            type: string
            format: uuid
            description: The unique identifier of the media.
          example:
            - a1cd180e-f9b5-4e99-9d44-b9c9baabad89
            - 245800c3-7b73-47d9-a201-e961260dcb30
            - 41316aac-5396-4278-8f44-08d5f2495b12
          default:
            - 41316aac-5396-4278-8f44-08d5f2495b12
      required:
        - mediaIds
      description: The list of mediaId(s) you want to perform the operation on.

    MediaCancelResponse:
      type: object
      description: Response returned when an upload is cancelled.
      properties:
        uploadId:
          type: string
          format: uuid
          example: beff5537-de85-42e1-a673-2a405cd94177
          description: The unique identifier of the cancelled upload.
        trial:
          type: boolean
          example: false
          description: Indicates if the upload was a trial.
        status:
          type: string
          example: cancelled
          description: The status of the upload after cancellation.
        url:
          type: string
          example: https://storage.googleapis.com/fastpix-uploads-us/8a5ab157-c586-458a-bb2e-caa8a8b76a19/4190bbde-4c34-41e4-b70e-90ba2aa0b79e
          description: The upload URL (if available) after cancellation.
        timeout:
          type: integer
          nullable: true
          example: 14400
          description: The timeout value for the upload.
        corsOrigin:
          type: string
          example: "*"
          description: CORS origin allowed for the upload.
        maxResolution:
          type: string
          example: 1080p
          description: The maximum resolution allowed for the upload.
        accessPolicy:
          type: string
          example: public
          description: The access policy for the upload.
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          example:
            key1: value1
          description: |
            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.
        title:
          type: string
          nullable: true
          maxLength: 255
          example: My Video Title
          description: Title of the media file.
        creatorId:
          type: string
          nullable: true
          maxLength: 255
          example: 8fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The unique identifier of the user who created this media.
    DrmIdResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the DRM configuration.
          example: e3dfdf15-16bb-4835-98b9-484c1e4320cc
    playlistCreatedSchema:
      oneOf:
        - $ref: "#/components/schemas/PlaylistByIdResponseDataManual"
        - $ref: "#/components/schemas/PlaylistByIdResponseDataSmart"
      discriminator:
        propertyName: type
        mapping:
          manual: "#/components/schemas/PlaylistByIdResponseDataManual"
          smart: "#/components/schemas/PlaylistByIdResponseDataSmart"
    patchLiveStreamRequest:
      type: object
      properties:
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          description: You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s 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.
          example:
            livestream_name: Gaming_stream
        reconnectWindow:
          type: integer
          example: 60
          maximum: 1800
          minimum: 60
          default: 60
          description: In case the software streaming the live, gets disrupted for any reason and gets disconnected from FastPix, the reconnect window defines the duration FastPix waits before automatically terminating the stream. Before starting the stream, you can set the reconnect window time which is up to 1800 seconds.
      example:
        metadata:
          livestream_name: Gaming_stream
        reconnectWindow: 100
    ViewsCountResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          type: object
          description: Contains the view count details.
          properties:
            views:
              type: integer
              example: 20
              description: Number of views for the stream or resource.
      example:
        success: true
        data:
          views: 20
    CreateLiveStreamRequest:
      type: object
      required:
        - playbackSettings
        - inputMediaSettings
      properties:
        playbackSettings:
          $ref: "#/components/schemas/playbackSettings"
        inputMediaSettings:
          type: object
          description: Contains configuration details for input media settings.
          properties:
            maxResolution:
              type: string
              default: 1080p
              enum:
                - 1080p
                - 720p
                - 480p
              description: |
                Defines the maximum resolution for encoding, storage, and playback of the live stream.
            reconnectWindow:
              type: integer
              example: 60
              maximum: 1800
              minimum: 60
              default: 60
              description: |
                Time period (in seconds) FastPix waits to reconnect before ending the stream when disconnected.
            mediaPolicy:
              $ref: "#/components/schemas/BasicAccessPolicy"
            metadata:
              type: object
              additionalProperties:
                type: string
                maxLength: 255
              maxProperties: 10
              description: |
                Custom key–value pairs for tagging livestreams.  
                Allows up to 10 entries with a maximum of 255 characters each.
              example:
                livestream_name: fastpix_livestream
            enableDvrMode:
              type: boolean
              description: |
                Enables DVR (Digital Video Recorder) functionality, allowing viewers to pause, rewind, and resume live playback.
      default:
        playbackSettings:
          accessPolicy: public
        inputMediaSettings:
          maxResolution: 1080p
          reconnectWindow: 60
          mediaPolicy: public
          metadata:
            livestream_name: fastpix_livestream

    playbackSettings:
      type: object
      description: Displays the result of the playback settings.
      properties:
        accessPolicy:
          $ref: "#/components/schemas/BasicAccessPolicy"
    liveStreamResponseDTO:
      type: object
      description: Displays the result of the request.
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          $ref: "#/components/schemas/CreateLiveStreamResponseDTO"
      example:
        success: true
        data:
          streamId: fa7f8c0950ea48ebcc5ef9de8c23deaa
          streamKey: 3dc5d7641f918baa083a5c52a5bd9cbckfa7f8c0950ea48ebcc5ef9de8c23deaa
          srtSecret: c51739512d0088d98a46925c9b74c73akfa7f8c0950ea48ebcc5ef9de8c23deaa
          trial: false
          status: idle
          maxResolution: 1080p
          maxDuration: 28800
          createdAt: "2024-10-15T08:48:31.551351Z"
          reconnectWindow: 60
          enableRecording: true
          enableDvrMode: true
          mediaPolicy: public
          metadata:
            livestream_name: fastpix_livestream
          lowLatency: true
          closedCaptions: false
          playbackIds:
            - id: 4e43ec52-4775-4f68-a3ff-a57d8a59bba8
              accessPolicy: public
          srtPlaybackResponse:
            srtPlaybackStreamId: playfa7f8c0950ea48ebcc5ef9de8c23deaa
            srtPlaybackSecret: 490e707dd4d165c9e38d261b252f9457kfa7f8c0950ea48ebcc5ef9de8c23deaa
    livestreamgetResponse:
      type: object
      description: Displays the result of the request.
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          $ref: "#/components/schemas/getCreateLiveStreamResponseDTO"
      example:
        success: true
        data:
          streamId: fa7f8c0950ea48ebcc5ef9de8c23deaa
          streamKey: 3dc5d7641f918baa083a5c52a5bd9cbckfa7f8c0950ea48ebcc5ef9de8c23deaa
          srtSecret: c51739512d0088d98a46925c9b74c73akfa7f8c0950ea48ebcc5ef9de8c23deaa
          trial: false
          status: idle
          maxResolution: 1080p
          maxDuration: 28800
          createdAt: "2024-10-15T08:48:31.551351Z"
          reconnectWindow: 60
          enableRecording: true
          enableDvrMode: false
          mediaPolicy: public
          metadata:
            livestream_name: fastpix_livestream
          lowLatency: true
          closedCaptions: false
          playbackIds:
            - id: 4e43ec52-4775-4f68-a3ff-a57d8a59bba8
              accessPolicy: public
          mediaIds:
            - 03cdf35d-8626-4b5f-bd14-d2212cd2a991
          srtPlaybackResponse:
            srtPlaybackStreamId: playfa7f8c0950ea48ebcc5ef9de8c23deaa
            srtPlaybackSecret: 490e707dd4d165c9e38d261b252f9457kfa7f8c0950ea48ebcc5ef9de8c23deaa
    patchResponseDTO:
      type: object
      description: Displays the result of the request.
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          $ref: "#/components/schemas/patchResponseData"
      example:
        success: true
        data:
          streamId: fa7f8c0950ea48ebcc5ef9de8c23deaa
          streamKey: 3dc5d7641f918baa083a5c52a5bd9cbckfa7f8c0950ea48ebcc5ef9de8c23deaa
          srtSecret: c51739512d0088d98a46925c9b74c73akfa7f8c0950ea48ebcc5ef9de8c23deaa
          trial: false
          status: idle
          maxResolution: 1080p
          maxDuration: 28800
          createdAt: "2024-10-15T08:48:31.551351Z"
          reconnectWindow: 100
          enableRecording: true
          enableDvrMode: false
          mediaPolicy: public
          metadata:
            livestream_name: Gaming_stream
          lowLatency: true
          closedCaptions: false
          playbackIds:
            - id: 4e43ec52-4775-4f68-a3ff-a57d8a59bba8
              accessPolicy: public
          srtPlaybackResponse:
            srtPlaybackStreamId: playfa7f8c0950ea48ebcc5ef9de8c23deaa
            srtPlaybackSecret: 490e707dd4d165c9e38d261b252f9457kfa7f8c0950ea48ebcc5ef9de8c23deaa

    LiveStreamDeleteResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
      example:
        success: true
    PlaybackIdResponse:
      type: object
      description: A collection of Playback ID objects utilized for crafting HLS playback urls.
      properties:
        id:
          type: string
          format: uuid
          example: 68b7ac0f-2504-4dd5-b7b4-d84ab4fee1bd
          description: Unique identifier for the playbackId
        accessPolicy:
          type: string
          example: public
          description: Determines if access to the streamed content is kept private or available to all.
    LiveStreamPagination:
      type: object
      description: Pagination organizes content into pages for better readability and navigation.
      properties:
        totalRecords:
          type: integer
          example: 12
          description: It gives the total number of media assets that are accessible overall.
        currentOffset:
          type: integer
          example: 5
          description: Determines the current point for data retrieval within a paginated list.
        offsetCount:
          type: integer
          example: 2
          description: The offset count is expressed as total records by limit.
    getCreateLiveStreamResponseDTO:
      type: object
      description: Displays the result of the request.
      properties:
        streamId:
          type: string
          example: 61a264dcc447b63da6fb79ef925cd76d
          description: Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
        streamKey:
          type: string
          description: A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
        srtSecret:
          type: string
          description: A secret used for securing the SRT stream. This ensures that only authorized users can access the stream.
        trial:
          type: boolean
          example: true
          description: FastPix allows for a to trial the live stream for free. The duration of trial streams is five minutes. After five minutes of activity, the trial stream is turned off, and the recorded asset is removed after a day.
        status:
          type: string
          example:
            possibleValue: idle, preparing, active, disabled
            example: idle
          description: The current live stream status can be one of four values:Idle, Preparing, Active or Disabled.The Idle status signifies that there isn"t a broadcast in progress.The preparing status indicates that the stream is getting prepared. while, the Active status indicates that a broadcast is currently in progress. The Disabled status means that no more RTMPS streams can be published.
        maxResolution:
          type: string
          example:
            possibleValue: 1080p, 720p, 480p
            example: 1080p
            default: 1080p
          description: Max resolution can be used to control the maximum resolution your media is encoded, stored, and streamed at.
        maxDuration:
          type: integer
          example: 28800
          maximum: 28800
          minimum: 0
          description: The maximum duration in seconds that a live stream can have before it ends the stream. `0` means no enforced maximum (unbounded).
        createdAt:
          type: string
          format: date-time
          description: It is the moment when the stream was created Time the media was generated, defined as a localDateTime (UTC Time).
        reconnectWindow:
          type: integer
          example: 60
          maximum: 1800
          minimum: 60
          default: 60
          description: In case the software streaming the live, gets disrupted for any reason and gets disconnected from FastPix, the reconnect window specifies the time span FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time which is up to 1800 seconds.
        enableRecording:
          type: boolean
          example:
            example: true
            default: true
          description: When set to true, FastPix records and stores the livestream for on-demand viewing. When set to false, the livestream is not recorded.
        enableDvrMode:
          type: boolean
          example:
            example: true
            default: false
          description: Enables DVR (Digital Video Recorder) functionality for the live stream. When set to true, viewers can pause, rewind, and resume playback during the live broadcast. This allows time-shifted viewing of the stream while it is still ongoing.
        mediaPolicy:
          type: string
          example:
            possibleValue: public, private
            example: public
            default: public
          description: Determines whether the recorded stream must be publicly accessible or private in Live to VOD (Video on Demand).
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          description: You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s 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.
          example:
            livestream_name: fastpix_livestream
        lowLatency:
          type: boolean
          description: Enables low-latency streaming mode to reduce playback delay.
          example: true
        closedCaptions:
          type: boolean
          description: when provided true Enables closed captions for the livestream.
          example: false
        playbackIds:
          type: array
          description: A collection of Playback ID objects utilized for crafting HLS playback urls.
          items:
            $ref: "#/components/schemas/PlaybackIdResponse"
        simulcastResponses:
          type: array
          description: A list of simulcast responses created for the livestream.
          items:
            $ref: '#/components/schemas/liveSimulcast'
        mediaIds:
          type: array
          description: A list of media IDs created when recording is enabled. Each media ID represents a recorded video (Live to VOD). If the stream is stopped and started again outside the reconnect window, a new media ID is generated for each session.
          items:
            type: string
            format: uuid
        srtPlaybackResponse:
          $ref: "#/components/schemas/SrtPlaybackResponse"
    CreateLiveStreamResponseDTO:
      type: object
      description: Displays the result of the request.
      properties:
        streamId:
          type: string
          example: 61a264dcc447b63da6fb79ef925cd76d
          description: Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
        streamKey:
          type: string
          description: A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
        srtSecret:
          type: string
          description: A secret used for securing the SRT stream. This ensures that only authorized users can access the stream.
        trial:
          type: boolean
          example: true
          description: FastPix allows for a to trial the live stream for free. The duration of trial streams is five minutes. After five minutes of activity, the trial stream is turned off, and the recorded asset is removed after a day.
        status:
          type: string
          example:
            possibleValue: idle, preparing, active, disabled
            example: idle
          description: The current live stream status can be one of four values:Idle, Preparing, Active or Disabled.The Idle status signifies that there isn"t a broadcast in progress.The preparing status indicates that the stream is getting prepared. while, the Active status indicates that a broadcast is currently in progress. The Disabled status means that no more RTMPS streams can be published.
        maxResolution:
          type: string
          example:
            possibleValue: 1080p, 720p, 480p
            example: 1080p
            default: 1080p
          description: Max resolution can be used to control the maximum resolution your media is encoded, stored, and streamed at.
        maxDuration:
          type: integer
          example: 28800
          maximum: 28800
          minimum: 0
          description: The maximum duration in seconds that a live stream can have before it ends the stream. `0` means no enforced maximum (unbounded).
        createdAt:
          type: string
          format: date-time
          description: It is the moment when the stream was created Time the media was generated, defined as a localDateTime (UTC Time).
        reconnectWindow:
          type: integer
          example: 60
          maximum: 1800
          minimum: 60
          default: 60
          description: In case the software streaming the live, gets disrupted for any reason and gets disconnected from FastPix, the reconnect window specifies the time span FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time which is up to 1800 seconds.
        enableRecording:
          type: boolean
          example:
            example: true
            default: true
          description: When set to true, the livestream will be recorded and stored for later viewing purposes. If set to false, the livestream will not be recorded.
        enableDvrMode:
          type: boolean
          example:
            example: true
            default: false
          description: Enables DVR (Digital Video Recorder) functionality for the live stream. When set to true, viewers can pause, rewind, and resume playback during the live broadcast. This allows time-shifted viewing of the stream while it is still ongoing.
        mediaPolicy:
          type: string
          example:
            possibleValue: public, private
            example: public
            default: public
          description: Determines whether the recorded stream should be publicly accessible or private in Live to VOD (Video on Demand).
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          description: You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s 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.
          example:
            livestream_name: fastpix_livestream
        lowLatency:
          type: boolean
          description: Enables low-latency streaming mode to reduce playback delay.
          example: true
        closedCaptions:
          type: boolean
          description: when provided true Enables closed captions for the livestream.
          example: false
        playbackIds:
          type: array
          description: A collection of Playback ID objects utilized for crafting HLS playback urls.
          items:
            $ref: "#/components/schemas/PlaybackIdResponse"
        srtPlaybackResponse:
          $ref: "#/components/schemas/SrtPlaybackResponse"
    patchResponseData:
      type: object
      description: Displays the result of the request.
      properties:
        streamId:
          type: string
          description: Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
        streamKey:
          type: string
          description: A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
        srtSecret:
          type: string
          description: A secret used for securing the SRT stream. This ensures that only authorized users can access the stream.
        trial:
          type: boolean
          example: false
          description: FastPix allows for a to trial the live stream for free. The duration of trial streams is five minutes. After five minutes of activity, the trial stream is turned off, and the recorded asset is removed after a day.
        status:
          type: string
          example:
            possibleValue: idle, preparing, active, disabled
            example: idle
          description: The current live stream status can be one of four values:Idle, Preparing, Active or Disabled.The Idle status signifies that there isn"t a broadcast in progress.The preparing status indicates that the stream is getting prepared. while, the Active status indicates that a broadcast is currently in progress. The Disabled status means that no more RTMPS streams can be published.
        maxResolution:
          type: string
          example:
            possibleValue: 1080p, 720p, 480p
            example: 1080p
            default: 1080p
          description: Max resolution can be used to control the maximum resolution your media is encoded, stored, and streamed at.
        maxDuration:
          type: integer
          example: 28800
          maximum: 28800
          minimum: 0
          description: The maximum duration in seconds that a live stream can have before it ends the stream. `0` means no enforced maximum (unbounded).
        createdAt:
          type: string
          format: date-time
          description: It is the moment when the stream was created Time the media was generated, defined as a localDateTime (UTC Time).
        reconnectWindow:
          type: integer
          example:
            example: 60
            maximum: 1800
            minimum: 60
            default: 60
          description: In case the software streaming the live, gets disrupted for any reason and gets disconnected from FastPix, the reconnect window specifies the time span FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time which is up to 1800 seconds.
        enableRecording:
          type: boolean
          example:
            example: true
            default: true
          description: When set to true, the livestream will be recorded and stored for later viewing purposes. If set to false, the livestream will not be recorded.
        enableDvrMode:
          type: boolean
          example:
            example: true
            default: false
          description: Enables DVR (Digital Video Recorder) functionality for the live stream. When set to true, viewers can pause, rewind, and resume playback during the live broadcast. This allows time-shifted viewing of the stream while it is still ongoing.
        mediaPolicy:
          type: string
          example:
            possibleValue: public, private
            example: public
            default: public
          description: Determines whether the recorded stream must be publicly accessible or private in Live to VOD (Video on Demand).
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          description: You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s 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.
          example:
            livestream_name: fastpix_livestream
        lowLatency:
          type: boolean
          description: Enables low-latency streaming mode to reduce playback delay.
          example: true
        closedCaptions:
          type: boolean
          description: when provided true Enables closed captions for the livestream.
          example: false
        playbackIds:
          type: array
          items:
            $ref: "#/components/schemas/PlaybackIdResponse"
        srtPlaybackResponse:
          $ref: "#/components/schemas/SrtPlaybackResponse"
    getStreamsResponse:
      type: object
      description: Displays the result of the request.
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          type: array
          description: Displays the result of the request.
          items:
            $ref: "#/components/schemas/getCreateLiveStreamResponseDTO"
        pagination:
          $ref: "#/components/schemas/LiveStreamPagination"
      example:
        success: true
        data:
          - streamId: fa7f8c0950ea48ebcc5ef9de8c23deaa
            streamKey: 3dc5d7641f918baa083a5c52a5bd9cbckfa7f8c0950ea48ebcc5ef9de8c23deaa
            srtSecret: c51739512d0088d98a46925c9b74c73akfa7f8c0950ea48ebcc5ef9de8c23deaa
            trial: false
            status: idle
            maxResolution: 1080p
            maxDuration: 28800
            createdAt: "2024-10-15T08:48:31.551351Z"
            reconnectWindow: 100
            enableRecording: true
            enableDvrMode: true
            mediaPolicy: public
            metadata:
              livestream_name: Gaming_stream
            lowLatency: false
            closedCaptions: false
            playbackIds:
              - id: 4e43ec52-4775-4f68-a3ff-a57d8a59bba8
                accessPolicy: public
            mediaIds:
              - 03cdf35d-8626-4b5f-bd14-d2212cd2a991
            srtPlaybackResponse:
              srtPlaybackStreamId: playfa7f8c0950ea48ebcc5ef9de8c23deaa
              srtPlaybackSecret: 490e707dd4d165c9e38d261b252f9457kfa7f8c0950ea48ebcc5ef9de8c23deaa
        pagination:
          totalRecords: 4
          currentOffset: 1
          offsetCount: 4
    playbackIdRequest:
      type: object
      properties:
        accessPolicy:
          $ref: "#/components/schemas/BasicAccessPolicy"
      example:
        accessPolicy: public
    PlaybackIdSuccessResponse:
      type: object
      description: Displays the result of the request.
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
              example: 68b7ac0f-2504-4dd5-b7b4-d84ab4fee1bd
              description: Unique identifier for the playbackId
            accessPolicy:
              type: string
              example: public
              description: Determines if access to the streamed content is kept private or available to all.
      example:
        success: true
        data:
          id: 88b7ac0f-2504-4dd5-b7b4-d84ab4fee1bd
          accessPolicy: public
    simulcastRequest:
      type: object
      required:
        - url
        - streamKey
      properties:
        url:
          type: string
          example: rtmp://hyd01.contribute.live-video.net/app/
          default: rtmp://example.com/
          description: The RTMPS hostname, combined with the application name, is crucial for connecting to third-party live streaming services and transmitting the live stream.
        streamKey:
          type: string
          example: live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk
          default: d851d91d5b768b36k61a264dcc447b
          description: A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          description: You can search for videos with specific key-value pairs using metadata, when you tag a video in "key":"value" pairs.
          example:
            livestream_name: Tech-Connect Summit
      example:
        url: rtmp://hyd01.contribute.live-video.net/app/
        streamKey: live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk
        metadata:
          livestream_name: Tech-Connect Summit

    simulcastUpdateRequest:
      type: object
      properties:
        isEnabled:
          type: boolean
          example: true
          default: true
          description: When set to false, the simulcast is disabled for the specified stream.
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          description: You can search for videos with specific key-value pairs using metadata, when you tag a video in "key":"value" pairs.
          example:
            livestream_name: Tech today
      example:
        isEnabled: true
        metadata:
          simulcast_name: Tech today
    liveSimulcast:
      type: object
      properties:
        simulcastId:
          type: string
          example: 8717422d89288ad5958d4a86e9afe2a2
          description: When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
        url:
          type: string
          example: rtmp://hyd01.contribute.live-video.net/app/
          description: The RTMPS hostname, combined with the application name, is crucial for connecting to third-party live streaming services and transmitting the live stream.
        streamKey:
          type: string
          example: 9310547d1df9c219d851d91d5b768b36k61a264dcc447b63da6fb79ef925cd76d
          description: A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
        isEnabled:
          type: boolean
          example: true
          description: When the value is true, the simulcast must be enabled for the given stream
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 255
          maxProperties: 10
          description: You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s 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.
    simulcastResponse:
      type: object
      description: Displays the result of the request.
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          type: object
          description: Displays the result of the request.
          properties:
            simulcastId:
              type: string
              example: 8717422d89288ad5958d4a86e9afe2a2
              description: When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
            url:
              type: string
              example: rtmp://hyd01.contribute.live-video.net/app/
              description: The RTMPS hostname, combined with the application name, is crucial for connecting to third-party live streaming services and transmitting the live stream.
            streamKey:
              type: string
              example: 9310547d1df9c219d851d91d5b768b36k61a264dcc447b63da6fb79ef925cd76d
              description: A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
            isEnabled:
              type: boolean
              example: true
              description: When the value is true, the simulcast must be enabled for the given stream
            metadata:
              type: object
              additionalProperties:
                type: string
                maxLength: 255
              maxProperties: 10
              description: You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s 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.
      example:
        success: true
        data:
          simulcastId: 8717422d89288ad5958d4a86e9afe2a2
          url: rtmp://hyd01.contribute.live-video.net/app/
          streamKey: live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk
          isEnabled: true
          metadata:
            livestream_name: Tech-Connect Summit
    simulcastUpdateResponse:
      type: object
      description: Displays the result of the request.
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
        data:
          type: object
          description: Displays the result of the request.
          properties:
            simulcastId:
              type: string
              example: 8717422d89288ad5958d4a86e9afe2a2
              description: When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
            url:
              type: string
              example: rtmp://hyd01.contribute.live-video.net/app/
              description: The RTMP hostname, combined with the application name, is crucial for connecting to third-party live streaming services and transmitting the live stream.
            streamKey:
              type: string
              example: 9310547d1df9c219d851d91d5b768b36k61a264dcc447b63da6fb79ef925cd76d
              description: A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
            isEnabled:
              type: boolean
              example: false
              description: When set to false, the simulcast is disabled for the specified stream.
            metadata:
              type: object
              additionalProperties:
                type: string
                maxLength: 255
              maxProperties: 10
              description: You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s 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.
              example:
                simulcast_name: Tech today
      example:
        success: true
        data:
          simulcastId: 8717422d89288ad5958d4a86e9afe2a2
          url: rtmp://hyd01.contribute.live-video.net/app/
          streamKey: live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk
          isEnabled: false
          metadata:
            simulcast_name: Tech today
    simulcastdeleteResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
      example:
        success: true
    CreateResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Shows the request status. Returns true for success and false for failure.
          example: true
        data:
          $ref: "#/components/schemas/CreateSigningKeyResponseDTO"
      example:
        success: true
        data:
          id: fc9d9368-6ee5-4b16-ae50-880a2374bdc4
          privateKey: LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUV2Z0lCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktnd2dnU2tBZ0VBQW9JQkFRREtaN1JKT1IrbXZGeVQxSWFIL0hVUkYwQnRncDJzK0srdUd4TUZ4N1JiaGNudVBMYU14WjM1b0lNWndhdHJrdDFDM3JxVFZsQzBsSnExeENFTyt3Zi9JNHQ0bktmUFB2WG83NGFCQi82YmR0MXpaSHp0OGFIenBnL3YrdEtCWVc5SEdWQ0tYc2JpNjczbHgwcFhHdXVnem8wdnZMR2lKWDBiL0Z4WEI5U1R3RkV5Q1dQOFJhczZ3VWVuSUdVM2UwMmJiV3Z4UnNoMWNER2xSRk03RWw2RVQ2MUQrS0tLTndnUGNYR1pvY0YwZTFxRU5iVGdPZUdBMFNDU0xIT3NtQ0NBQTNtSndJS1VaY0Z2MmpGRUx4Uk5MTnhoMjM5UEdUT3BuWmdvTFp5Skt4b2REN1FpV1N1eDVZY1Z0MFgrSk9rZXNBOEpjM1ZtM0tGc0IwL3RYck9QQWdNQkFBRUNnZ0VBUHhNWUxLVmZocTgyVGw4eFdWbEVCZ0p2OG5COHdIVnpFZGVnRXZJTDgyVjY2d0lDaFZYa0IvR01TVStBSXZMT2Z0TTM0MGhIdUM2REU5ZTkwWlJMQnFoR0ExMFdNbEJWZzdSNC91YkY0aDZsbmhzWGozTDRYQnhJNVNrTnhvSGRrcE9COU16YVA4YmxFNkVLT3FES0F2KzdJY0EwdnVuZDFnWExwTmRzMkduTW5nZW1qOUhJZWh1eTNLY0taNHlheFo1YkRKVEpLZlFrTlFDQzhOR0hIdWovQmRWUnU1RHRrZVdNMFFpN2FKeW5lSXRxOGhtbXdxcVNMTnpTOTZtcHpBdzF3RzFXTHVML1A3TGxJekVWa2ZJUFc0SW1zRXhsSG5FUG0ySld1RUNMQ1pRL25NODdhQXVXekROektCYW51LzZhdXhnSDB2Wnc5YWowTmxNNFFRS0JnUURPM3Y0YlN4bWluZGJpVEdSaXdFVXVyODh4TVA3M2U5RSt2SHlzb3JZMWZycFpkdXJHOVlFb09MUFN1YnQ5WkhZNFhGOFhxRWZ4bE94d294eDVzcU9PcGNMTnFnOWhTSWxPaXEyYmVnN2V2RGpOMml6b3JKRFl3VEhGQ0Era25FbmFpL0J2TU16N3AyVVkrUEEzUnJ4Z25BK3RkQlErZWlSZ1c0WmhnMkhWcndLQmdRRDZlVEpwRTRxZVFYdmpnMy9FS081UkllRklZOHphTGMvMVVHODBqNmVvbStNK3UyTmdUVDJqVmNyMkdQbjZTbHRNRlJNem5qOVJHYmQ1MCt5a2k0Y1NYU1JPdE44alV2M0FseHJtZzEwVTVtSWIrUXFIZ3g2QldyeXkvakxHYXVvMUJnVFg1dDZ0VXVEUUZuVDJSM2xoNGRNZ044T3V4VlR3OCtadGloSllJUUtCZ1FERE00ZHpHWnBHNThrc0lBbFpaVFBpcWVKSCtJT2Q0eWUrbXZ6SnFYOWxXdjljQytuZGN5czhXTVRWd293MzllUFhxdEhQOE9weCtxUmdaSWtxREhabzArRE5UL3JUUVM3Ty9leHpHT21QSXV3MjBmZ3VWU2NZWUxRbHgwVjdmajN5Q3JvRk1YYzZ2dW1XZHMrMFdQckg3bnFjb1R1NCtHZjZ4R0k1QVUvLzRRS0JnUUR6TFcvdjdIVU1xTzhyT0tSM1FuWCtkekpPSWZibGJNMFdrdjBrdnNROFF2MGlEclN3N3MwRkkycGwvR0hXeXhKUWo3V1F5L2NWT2k2VUxWajNlQyt2ZUphamc1K1FvQ2FWTVIrQTVkRWRWWCt6UU5za0xmMFVBWkJyQjdrc1F1a1lpYnR5RWtmblp5dTFXOWc2czdINWdsS0VXUiszTXdjQTJRdkRGZVl4Z1FLQmdDWVdlKzQ4bVVaUEl5ZnR4NVFaQllnYTE2blpndzYxZmxtdEdpQlVGWGVMR3BTaU1XNXc5R3RYVDZPbFh1Zy91TkNKbHR4TDE4c0NEeDNVaU9DNWFTMEN4OTc5TlFrSm1YRWw1UDNtMFNGaVU4VlZ0SFp1dHd3SWFKTFZockZ1T3NJV1BtRFN4aHhMaFpPNmJ5aWRwbHlXLzl1eGpwMlZrQ0Y3OGd5QXRRSWsKLS0tLS1FTkQgUFJJVkFURSBLRVktLS0tLQo=
          createdAt: "2024-01-11T10:00:06.618993Z"
    GetAllSigningKeysResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Shows the request status. Returns true for success and false for failure.
          example: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetAllSigningKeysResponseDto'
        pagination:
          $ref: '#/components/schemas/SigningKeysPagination'
    DeleteSigningKeyResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
          description: Shows the request status. Returns true for success and false for failure.
      example:
        success: true
    CreateSigningKeyResponseDTO:
      type: object
      description: Displays the result of the request.
      properties:
        id:
          type: string
          format: uuid
          description: A unique identifier is generated by FastPix for the signing keys.
          example: fc9d9368-6ee5-4b16-ae50-880a2374bdc4
        privateKey:
          type: string
          description: A private key is a byte encoded secret key used to create a signed JSON Web Token (JWT) for authentication.
          example: LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUV2Z0lCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktnd2dnU2tBZ0VBQW9JQkFRREtaN1JKT1IrbXZGeVQxSWFIL0hVUkYwQnRncDJzK0srdUd4TUZ4N1JiaGNudVBMYU14WjM1b0lNWndhdHJrdDFDM3JxVFZsQzBsSnExeENFTyt3Zi9JNHQ0bktmUFB2WG83NGFCQi82YmR0MXpaSHp0OGFIenBnL3YrdEtCWVc5SEdWQ0tYc2JpNjczbHgwcFhHdXVnem8wdnZMR2lKWDBiL0Z4WEI5U1R3RkV5Q1dQOFJhczZ3VWVuSUdVM2UwMmJiV3Z4UnNoMWNER2xSRk03RWw2RVQ2MUQrS0tLTndnUGNYR1pvY0YwZTFxRU5iVGdPZUdBMFNDU0xIT3NtQ0NBQTNtSndJS1VaY0Z2MmpGRUx4Uk5MTnhoMjM5UEdUT3BuWmdvTFp5Skt4b2REN1FpV1N1eDVZY1Z0MFgrSk9rZXNBOEpjM1ZtM0tGc0IwL3RYck9QQWdNQkFBRUNnZ0VBUHhNWUxLVmZocTgyVGw4eFdWbEVCZ0p2OG5COHdIVnpFZGVnRXZJTDgyVjY2d0lDaFZYa0IvR01TVStBSXZMT2Z0TTM0MGhIdUM2REU5ZTkwWlJMQnFoR0ExMFdNbEJWZzdSNC91YkY0aDZsbmhzWGozTDRYQnhJNVNrTnhvSGRrcE9COU16YVA4YmxFNkVLT3FES0F2KzdJY0EwdnVuZDFnWExwTmRzMkduTW5nZW1qOUhJZWh1eTNLY0taNHlheFo1YkRKVEpLZlFrTlFDQzhOR0hIdWovQmRWUnU1RHRrZVdNMFFpN2FKeW5lSXRxOGhtbXdxcVNMTnpTOTZtcHpBdzF3RzFXTHVML1A3TGxJekVWa2ZJUFc0SW1zRXhsSG5FUG0ySld1RUNMQ1pRL25NODdhQXVXekROektCYW51LzZhdXhnSDB2Wnc5YWowTmxNNFFRS0JnUURPM3Y0YlN4bWluZGJpVEdSaXdFVXVyODh4TVA3M2U5RSt2SHlzb3JZMWZycFpkdXJHOVlFb09MUFN1YnQ5WkhZNFhGOFhxRWZ4bE94d294eDVzcU9PcGNMTnFnOWhTSWxPaXEyYmVnN2V2RGpOMml6b3JKRFl3VEhGQ0Era25FbmFpL0J2TU16N3AyVVkrUEEzUnJ4Z25BK3RkQlErZWlSZ1c0WmhnMkhWcndLQmdRRDZlVEpwRTRxZVFYdmpnMy9FS081UkllRklZOHphTGMvMVVHODBqNmVvbStNK3UyTmdUVDJqVmNyMkdQbjZTbHRNRlJNem5qOVJHYmQ1MCt5a2k0Y1NYU1JPdE44alV2M0FseHJtZzEwVTVtSWIrUXFIZ3g2QldyeXkvakxHYXVvMUJnVFg1dDZ0VXVEUUZuVDJSM2xoNGRNZ044T3V4VlR3OCtadGloSllJUUtCZ1FERE00ZHpHWnBHNThrc0lBbFpaVFBpcWVKSCtJT2Q0eWUrbXZ6SnFYOWxXdjljQytuZGN5czhXTVRWd293MzllUFhxdEhQOE9weCtxUmdaSWtxREhabzArRE5UL3JUUVM3Ty9leHpHT21QSXV3MjBmZ3VWU2NZWUxRbHgwVjdmajN5Q3JvRk1YYzZ2dW1XZHMrMFdQckg3bnFjb1R1NCtHZjZ4R0k1QVUvLzRRS0JnUUR6TFcvdjdIVU1xTzhyT0tSM1FuWCtkekpPSWZibGJNMFdrdjBrdnNROFF2MGlEclN3N3MwRkkycGwvR0hXeXhKUWo3V1F5L2NWT2k2VUxWajNlQyt2ZUphamc1K1FvQ2FWTVIrQTVkRWRWWCt6UU5za0xmMFVBWkJyQjdrc1F1a1lpYnR5RWtmblp5dTFXOWc2czdINWdsS0VXUiszTXdjQTJRdkRGZVl4Z1FLQmdDWVdlKzQ4bVVaUEl5ZnR4NVFaQllnYTE2blpndzYxZmxtdEdpQlVGWGVMR3BTaU1XNXc5R3RYVDZPbFh1Zy91TkNKbHR4TDE4c0NEeDNVaU9DNWFTMEN4OTc5TlFrSm1YRWw1UDNtMFNGaVU4VlZ0SFp1dHd3SWFKTFZockZ1T3NJV1BtRFN4aHhMaFpPNmJ5aWRwbHlXLzl1eGpwMlZrQ0Y3OGd5QXRRSWsKLS0tLS1FTkQgUFJJVkFURSBLRVktLS0tLQo=
        createdAt:
          type: string
          format: date-time
          description: Time the Signing key was generated, defined as a localDateTime (UTC Time).
          example: "2024-01-11T10:00:06.618993Z"
    GetAllSigningKeysResponseDto:
      type: object
      description: Displays the result of the request.
      properties:
        id:
          type: string
          format: uuid
          description: A unique identifier is generated by FastPix for the signing keys.
          example: "84474705-92d5-4fa9-8cb8-e4a0ddb0598a"
        createdAt:
          type: string
          format: date-time
          description: Time the Signing key was generated, defined as a localDateTime (UTC Time).
          example: "2025-10-27T05:22:54.782954Z"
    getPublicPemUsingSigningKeyIdResponseDTO:
      type: object
      description: Displays the result of the request.
      properties:
        success:
          type: boolean
          description: Shows the request status. Returns true for success and false for failure.
          example: true
        data:
          type: object
          description: Displays the result of the request.
          properties:
            workspaceId:
              type: string
              format: uuid
              description: FastPix generates a unique identifier for each workspace.
              example: fc9d9368-6ee5-4b16-ae50-880ab374bdc6
            signingKeyId:
              type: string
              format: uuid
              example: 5ta85f64-5717-4562-b3fc-2c963f66afa6
            publicKey:
              type: string
              description: A public key is a byte encoded key used to create a signed JSON Web Token (JWT) for authentication.
              example: |
                -----BEGIN PUBLIC KEY-----
                MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvfUkdkrPIZGOAwMwrkQ9Jr6uNEsVQCgax8xHMSf4Ib3IwlE90M/wLJZGmSWcaAWzH4nSE5qh/fF4E4xHY0hYMS78Ve9GSV8mtLfzjcZ0agfmFO0B0/YVaXNKDGc3CUWAOoONZEMCA3wqLNSZ3yQhr/IZ4xVqBR0GLSYtFt2VNNAmgfAQkVLcZy+3V1ZaC49EgK4AoR51iwwv9DzRjZ/3rM8MSS9lEy0WQGXP/x+0k8hQvq482r/G32TSG00ZSKQDpRFieaFh6YRxMd/R0bhVAvTTO8STQa/M4PZGoBFqkPTpCw5uShtpe+Hm85vlHk/2qYx5NqIe4l+c/yo4w/ny/QIDAQAB
                -----END PUBLIC KEY-----
      example:
        success: true
        data:
          workspaceId: fc9d9368-6ee5-4b16-ae50-880ab374bdc6
          signingKeyId: 5ta85f64-5717-4562-b3fc-2c963f66afa6
          publicKey: |
            -----BEGIN PUBLIC KEY-----
            MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvfUkdkrPIZGOAwMwrkQ9Jr6uNEsVQCgax8xHMSf4Ib3IwlE90M/wLJZGmSWcaAWzH4nSE5qh/fF4E4xHY0hYMS78Ve9GSV8mtLfzjcZ0agfmFO0B0/YVaXNKDGc3CUWAOoONZEMCA3wqLNSZ3yQhr/IZ4xVqBR0GLSYtFt2VNNAmgfAQkVLcZy+3V1ZaC49EgK4AoR51iwwv9DzRjZ/3rM8MSS9lEy0WQGXP/x+0k8hQvq482r/G32TSG00ZSKQDpRFieaFh6YRxMd/R0bhVAvTTO8STQa/M4PZGoBFqkPTpCw5uShtpe+Hm85vlHk/2qYx5NqIe4l+c/yo4w/ny/QIDAQAB
            -----END PUBLIC KEY-----
    TimeSpan:
      type: array
      description: |
        The timespan from and to details displayed in the form of unix epoch timestamps.
      items:
        type: integer
      example:
        availableValue:
          - 1610025789
          - 1610025947
    ViewsList:
      type: object
      properties:
        viewId:
          type: string
          description: |
            The unique identifier for the viewing session of the user.
          example: 550e8400-e29b-41d4-a716-446655440000
        operatingSystem:
          type: string
          nullable: true
          description: |
            Operating System signifies the software platform utilized by the viewer
          example: macOs
        application:
          type: string
          nullable: true
          description: |
            The browser name of the viewer.
          example: chrome
        viewStartTime:
          type: string
          nullable: true
          description: |
            The start timestamp of the video view.
          example: "2023-12-06T08:04:14Z"
        viewEndTime:
          type: string
          nullable: true
          description: |
            The end timestamp of the video view.
          example: "2023-12-06T08:11:55Z"
        videoTitle:
          type: string
          nullable: true
          description: |
            The title of the Video.
          example: Club 69
        errorCode:
          type: string
          nullable: true
          description: |
            The code which represents specific issues or failures that occur during playback. These can be implementation specific.
          example: 1001
        errorMessage:
          type: string
          nullable: true
          description: |
            The notifications or messages that inform users or developers about issues or failures that have occurred during the playback representing error codes.
          example: An unexpected error occurred. Please try again later or contact support for assistance.
        errorId:
          type: string
          nullable: true
          description: |
            The unique identifier for the error that occurred during playback.
          example: 9pa85f64-5717-4562-b3fc-2c963f66afa6
        country:
          type: string
          nullable: true
          description: |
            Country of the viewer.
          example: USA
        viewWatchTime:
          type: number
          nullable: true
          description: |
            The watch time represents the time spent watching the video including staruptime, playback time ,buffering time.
          example: 0.5
        QoeScore:
          type: number
          nullable: true
          description: |
            The viewer experience encapsulated in the form of score while watching the video.
          example: 0.55
    Views:
      description: Displays the result of the request.
      type: object
      properties:
        asnId:
          type: integer
          nullable: true
          description: |
            The unique identifier assigned to an Autonomous System (AS) on the Internet. The ASN is used to identify and exchange routing information between different networks.
          format: long
          example: 55836
        asnName:
          type: string
          nullable: true
          description: |
            The Name associated with the asnId.
          example: RELIANCEJIO-IN Reliance Jio Infocomm Limited
        averageBitrate:
          description: |
            Average Bitrate represents the average bitrate of the video content watched by the viewer, expressed in bits per second (bps). This metric provides insight into the quality of the video stream.
          type: number
          nullable: true
          format: double
          example: 1512855.0
        avgDownscaling:
          description: |
            Average Downscaling refers to the average reduction in video resolution or quality during the playback of video content.
          type: number
          nullable: true
          format: double
          example: 0.045843694
        avgRequestLatency:
          description: |
            Average Request Latency average time it takes for a request to be made and processed during video playback
          type: number
          nullable: true
          format: double
          example: 473
        avgRequestThroughput:
          description: |
            Average Request Throughput refers to the average throughput or data transfer rate of HTTP requests made during video playback
          type: number
          nullable: true
          format: double
          example: 3339357.5
        avgUpscaling:
          description: |
            Average Upscaling refers to the average resolution of the video source is lower than the resolution of the playback device or screen.
          type: number
          nullable: true
          format: double
          example: 0.087843694
        beaconDomain:
          description: |
            Beacon Domain specifies the domain endpoint used by the player or SDK to send analytics or tracking beacons for playback events.
          type: string
          format: string
          example: "metrix.ws"
        browserEngine:
          description: |
            Browser Engine denotes the rendering engine used by the browser (e.g., Blink, Gecko, WebKit).
          type: string
          nullable: true
          example: null
        browserName:
          description: |
            Browser Name denotes the software application utilized by the viewer to access and watch the video content
          type: string
          nullable: true
          example: Chrome
        browserVersion:
          description: |
            Browser Version signifies the specific version of the browser software employed by the viewer
          type: string
          nullable: true
          example: Chrome 5.8.3
        bufferCount:
          type: integer
          nullable: true
          description: |
            Buffer Count represents the number of rebuffering events occurring during the video view.
          example: 1
        bufferFill:
          type: integer
          nullable: true
          format: long
          description: |
            Buffer Fill indicates the total time, in milliseconds, that viewers wait for rebuffering per video view.
          example: 4567
        bufferFrequency:
          description: |
            Buffer Frequency measures the rate at which rebuffering events occur, expressed as events per millisecond.
          type: number
          nullable: true
          format: double
          example: 0.012878
        bufferRatio:
          description: |
            Buffer Ratio refers to the percentage of time during video playback where the viewer experiences buffering or rebuffering events.
          type: number
          nullable: true
          format: double
          example: 0.018711979
        cdn:
          description: |
            Content Delivery Network (CDN) refers to the network infrastructure responsible for delivering the video content to the viewer.
          type: string
          nullable: true
          example: cloudflare
        city:
          description: |
            City indicates the geographical location of the viewer accessing the video content.
          type: string
          nullable: true
          example: California
        connectionType:
          description: |
            Connection Type signifies the type of network connection utilized by the viewers device
          type: string
          nullable: true
          example: wifi
        continent:
          description: |
            Continent represents the continent name of the viewer accessing the video content.
          type: string
          nullable: true
          example: North America
        country:
          description: |
            Country represents the coded text that represents the country name of viewer accessing the video content.
          type: string
          nullable: true
          example: United States Of America
        countryCode:
          description: |
            Country Code denotes the two-letter ISO code representing the country of origin for the viewer accessing the video content.
          type: string
          nullable: true
          example: US
        # custom1-10:
        custom:
          type: object
          description: |
            User defined metadata. Only accessible once it is enabled in the organization settings.
          properties:
            Custom:
              type: array
              nullable: true
              description: A list of custom dimension objects.
              items:
                type: object
                properties:
                  dimensionName:
                    type: string
                    description: |
                      Unique identifier for a custom dimension used to categorize or segment analytics data (for example, custom_1).
                    example: custom_1
                  displayName:
                    type: string
                    description: |
                      A user-friendly display label that represents the corresponding custom dimension in analytics dashboards and reports; users can assign a specific name based on their tracking needs.
                    example: email
                  value:
                    type: string
                    description: |
                      Allows assigning user-friendly data values such as email addresses, identifiers, or other meaningful information.
                    example: johndoe@gmail.com
            # type: array
            # items:
            #   properties:
            #       dimensionName:
            #         description: |
            #           Unique identifier for a custom dimension used to categorize or segment analytics data (for example, custom_1).
            #         type: string
            #         example: custom_1
            #       displayName:
            #         description: |
            #           A user-friendly display label that represents the corresponding custom dimension in analytics dashboards and reports; users can assign a specific name based on their tracking needs.
            #         type: string
            #         example: email
            #       value:
            #         description: |
            #           Allows assigning user-friendly data values such as email addresses, identifiers, or other meaningful information.
            #         type: string
            #         example: johndoe@gmail.com

        deviceManufacturer:
          description: |
            Device Manufacturer indicates the brand or manufacturer of the device used by the viewer.
          type: string
          nullable: true
          example: Apple
        deviceModel:
          description: |
            Device Model represents the specific model of the device used by the viewer.
          type: string
          nullable: true
          example: Macintosh
        deviceName:
          description: |
            Device Name refers to the name or label assigned to the device used by the viewer.
          type: string
          nullable: true
          example: Apple
        deviceType:
          description: |
            Device Type denotes the classification of the device used by the viewer
          type: string
          nullable: true
          example: Desktop
        drmType:
          description: |
            DRM Type indicates the type of Digital Rights Management (DRM) utilized during video playback
          type: string
          nullable: true
          example: wideivne
        droppedFrameCount:
          description: |
            Dropped Frame Count represents the number of frames dropped by the video player during playback.
          type: integer
          format: long
          nullable: true
          example: 7
        errorCode:
          description: |
            Error Code is an identifier representing a specific type of error that occurred during video playback, potentially leading to playback failure.
          type: string
          nullable: true
          example: 1002
        errorContext: #NANA
          description: |
            Specifies the component or stage where the playback error originated, such as streaming, cdn, decoder, or player. This context helps diagnose whether the failure was caused by delivery issues, playback logic, or media decoding problems within the FastPix streaming pipeline.
          type: string
          nullable: true
          example: player
        errorId:
          type: integer
          nullable: true
          format: long
          description: |
            The unique identifier which identifies each type of error that occurs.
          example: 3456
        errorMessage:
          description: |
            Error Message is a descriptive message generated by the video player when an error occurs during playback, associated with an error code.
          type: string
          nullable: true
          example: TIMEOUT
        exitBeforeVideoStart:
          description: |
            Exit Before Video Start indicates whether a viewer abandoned the video before it started playing, typically due to long loading times.
          type: boolean
          example: true
        experimentName:
          description: |
            Experiment Name is used in A/B testing scenarios to categorize video views into different experiments.
          type: string
          nullable: true
          example: null
        fpApiVersion: #NANA
          description: |
            Specifies the version of the FastPix API used during data collection or playback reporting. This helps ensure compatibility and traceability between client SDK versions and backend processing.
          nullable: true
          type: string
          example: v2.3
        fpEmbed: #NANA
          description: |
            Identifies the type or source of the FastPix player embed used for playback — for example, whether the video was played through a direct player integration, an iframe, or a third-party embedded context. This helps differentiate playback environments and measure performance across embed types.
          type: boolean
          nullable: true
          example: null
        fpEmbedVersion: #NANA
          description: |
            Specifies the version of the FastPix embed script or SDK used to initialize the player. This helps track playback behavior and debug issues across different embed versions or deployment environments.
          type: string
          nullable: true
          example: null
        fpLiveStreamId:
          description: |
            FastPix Live Stream ID is the unique identifier associated with a live stream video media within the FastPix Video Platform.
          type: string
          nullable: true
          format: uuid
          example: null
        fpPlaybackId:
          description: |
            FastPix Playback ID refers to the unique identifier associated with the playback instance of a video, particularly used in FastPix Video Platform.
          type: string
          nullable: true
          format: uuid
          example: null
        fpSdk:
          description: |
            FastPix SDK Name identifies the name of the FastPix Player SDK utilized within the player workspace.
          type: string
          nullable: true
          example: shakaplayer-fastpix
        fpSdkVersion:
          description: |
            FastPix SDK Version specifies the version of the FastPix Player SDK integrated into the player.
          type: string
          nullable: true
          example: 1.1.0
        fpViewerId: #NANA
          description: |
            Represents a unique, anonymized identifier assigned to each viewer by the FastPix SDK. This ID helps correlate multiple playback sessions or events to the same viewer across sessions or devices without exposing any personal information.
          type: string
          nullable: true
          example: cf4ab502-23ef-4927-ae55-89b2a319432f
        insertTimestamp: #WillRemove
          description: |
            Insert Timestamp refers to the time instance when the view is started.
          type: string
          example: 1710591342067
        ipAddress: #NANA
          description: |
            Represents the IP address of the user or device that initiated the playback session.
          type: string
          example: 124.123.136.94
        jumpLatency:
          description: |
            Jump Latency refers to the delay or latency experienced when there is a jump or seek action performed by the viewer while watching a video.
          type: number
          nullable: true
          format: double
          example: 2396
        latitude:
          description: |
            Latitude refers to the geographical coordinate representing the north-south position of the viewers location, truncated to one decimal place.
          type: string
          nullable: true
          example: 17.384

        liveStreamLatency:
          description: |
            Live Stream Latency measures the average time taken from the point of ingest to the point of display for live stream video views.
          type: integer
          format: long
          nullable: true
          example: null
        longitude:
          description: |
            Longitude denotes the geographical coordinate representing the east-west position of the viewers location, truncated to one decimal place.
          type: string
          nullable: true
          example: 78.4564
        maxDownscaling:
          description: |
            Maximum Downscale Percentage represents the highest percentage of downscaling applied to the video during the view.
          type: number
          nullable: true
          format: double
          example: 0.78541666
        maxRequestLatency:
          description: |
            Max Request Latency refers to the maximum rate of data transfer (throughput) during requests made by the playback.
          type: number
          nullable: true
          format: double
          example: null
        maxUpscaling:
          description: |
            Maximum Upscale Percentage represents the highest percentage of upscaling applied to the video during the view.
          type: number
          nullable: true
          format: double
          example: 0.08175
        mediaId:
          type: string
          nullable: true
          description: |
            The media Id value if the video asset is internal to FastPix.
          format: uuid
          example: rmp7fvw5lPD01l8PZ2aN74js84XrTWxHy
        osName:
          description: |
            Operating System signifies the name of software platform utilized by the viewer.
          type: string
          nullable: true
          example: MacOS
        osVersion:
          description: |
            Operating System Version specifies the specific version of the operating system being used by the viewer
          type: string
          example: MacOS 10.15.7
        pageContext:
          description: |
            Page Context provides contextual information about the type of page being accessed.
          type: string
          nullable: true
          example: iframe
        pageLoadTime:
          description: |
            Page Load Time measures the time from when the user initiates loading the page to when all resources are loaded on the page.
          type: integer
          format: long
          nullable: true
          example: 453
        playbackScore:
          description: |
            Playback Success Score represents a numerical value indicating the success or quality of the video playback experience.
          type: number
          nullable: true
          format: double
          example: 1
        playerAutoplayOn:
          description: |
            Player Autoplay On indicates whether the video player automatically initiated playback of the video content.
          type: boolean
          example: true


        playerHeight:
          description: |
            Player Height refers to the vertical dimension, measured in pixels, of the video player as it appears on the webpage.
          oneOf:
            - type: string
            - type: integer
          nullable: true
          example: 2856
        playerInitializationTime:
          description: |
            Player Initialization Time measures the duration, in milliseconds, from the initialization of the player within the webpage to its readiness to receive further instructions.
          type: integer
          format: long
          nullable: true
          example: 24
        playerInstanceId:
          description: |
            Player Instance ID is a unique identifier that distinguishes each instance of the Player class created when initializing a video.
          type: string
          nullable: true
          format: uuid
          example: f479de20-6a25-46a5-b394-9fbdb07ea6df
        playerLanguage:
          description: |
            Player Language indicates the language used for text elements within the video player interface.
          type: string
          nullable: true
          example: null

        playerName:
          description: |
            Player Name serves to differentiate various configurations or types of players used across the website or application.
          type: string
          nullable: true
          example: ChanaJor Player
        playerPoster:
          description: |
            Player Poster refers to the image displayed as a preview before the video playback begins.
          type: string
          nullable: true
          example: null
        playerPreloadOn:
          description: |
            Player Preload On indicates whether the player is configured to preload the video content upon page load.
          type: boolean
          example: true
        playerRemotePlayed:
          description: |
            Player Remote Played specifies if the video is being remotely played to devices such as AirPlay or Chromecast, obtained from the SDK.
          type: boolean
          example: false
        playerResolution:
          description: |
            Player Resolution refers to the resolution of the video player window or viewport where the video content is being displayed.
          type: string
          nullable: true
          example: 811X779
        playerSoftwareName: #NANA
          description: |
            Represents the name of the video player software or framework used for playback (for example, HTML5, HLS.js, Shaka Player).
          type: string
          nullable: true
          example: "HTML5"
        playerSoftwareVersion:
          description: |
            Player Software Version indicates the version number of the player software installed.
          type: string
          nullable: true
          example: v4.3.5
        playerSourceDomain: #NANA
          description: |
            Specifies the domain or source from which the player was loaded or embedded (for example, stream.fastpix.com or a customer’s custom domain). This helps identify the playback origin and differentiate between various deployment environments.
          type: string
          nullable: true
          example: stream.fastpix.com
        playerSourceHeight:
          description: |
            Player Source Height denotes the vertical dimension, measured in pixels, of the source video content being transmitted to the player.
          type: integer
          format: long
          nullable: true
          example: 1080
        playerSourceWidth:
          description: |
            Player Source Width represents the width of the source video as perceived by the player, typically measured in pixels.
          type: integer
          format: long
          nullable: true
          example: 1920
        playerVersion:
          description: |
            Player Version indicates the version of the player used to render the video content. It is often utilized for performance comparison between different player versions.
          type: string
          nullable: true
          example: null
        playerViewCount: #NANA
          description: |
            Represents the total number of times the video player has been initialized or viewed for a specific session or video. This metric helps track playback engagement and identify view patterns across different players or sessions.
          oneOf:
            - type: string
            - type: integer
          nullable: true
          example: 0
        playerWidth:
          description: |
            Player Width refers to the width of the player displayed within the webpage, measured in pixels.
          type: integer
          format: long
          nullable: true
          example: 801
        propertyId: #NANA ####
          description: |
            Represents the unique identifier assigned to a FastPix property, which is associated with a specific workspace or project. It helps link playback and analytics data to the correct property configuration.
          oneOf:
            - type: string
            - type: integer
              format: long
          nullable: true
          example: null
        qualityOfExperienceScore:
          description: |
            Quality Of Experience Score quantifies the overall viewer experience based on various metrics, providing a decimal score to assess the quality of the viewing experience.
          type: number
          nullable: true
          format: double
          example: 0.922192410885397
        region:
          description: |
            Region denotes the geographical region of the viewer accessing the video content.
          type: string
          nullable: true
          example: Telangana
        renderQualityScore:
          description: |
            Render Quality Score is a decimal value representing the score indicating the perceived quality of the video.
          type: number
          nullable: true
          format: double
          example: 1
        sessionId:
          description: |
            Session ID refers to the unique identifier tracking a viewers session within the FastPix platform.
          type: string
          nullable: true
          format: uuid
          example: 58a97574-da3f-473f-8904-08f9f01489c8
        sign: #NANA
          description: |
            Represents a cryptographic signature used to verify the authenticity and integrity of the playback or API request within the FastPix platform. It ensures that the data has not been tampered with and originates from a trusted source.
          type: string
          nullable: true
          format: string
          example: null
        stabilityScore:
          description: |
            Stability Score quantifies the smoothness of video playback, typically represented as a decimal value.
          type: number
          nullable: true
          format: double
          example: 0.8320748
        startupScore:
          description: |
            Startup Score evaluates the startup performance of the player, usually represented as a decimal value
          type: number
          nullable: true
          format: double
          example: 0.97811466
        subPropertyId:
          description: |
            Sub Property ID denotes the unique identifier assigned to FastPix properties, previously linked with a specific workspace.
          type: string
          nullable: true
          example: null
        totalStartupTime: #NANA
          description: |
            Represents the total time (in milliseconds) taken for the video player to start playback from the moment the user initiates the session. This includes loading, buffering, and initialization delays before the first frame is rendered.
          type: integer
          format: long
          nullable: true
          example: 5285
        updatedTimestamp:
          description: |
            Updated Timestamp refers to when the record is updated to a particular Video.
          type: string
          nullable: true
          format: datetime
          example: 1710591342067
        usedFullScreen:
          description: |
            Used Fullscreen denotes whether the viewer utilized the full-screen mode while watching the video.
          type: boolean
          example: true
        userAgent:
          description: |
            User Agent represents the user agent string transmitted by the viewers device to identify itself to the server, typically including information about the device and browser.
          type: string
          nullable: true
          example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36
        videoContentType:
          description: |
            Video Content Type specifies the classification of the video content.
          type: string
          nullable: true
          example: null
        videoDuration:
          description: |
            Video Duration represents the length of the video, provided in milliseconds, typically supplied to FastPix through custom metadata.
          type: integer
          format: long
          nullable: true
          example: 588
        videoEncodingVariant: #NANA
          description: |
            Indicates the specific encoding variant or rendition of the video being played, such as resolution, bitrate, or codec type. This helps identify which encoded version of the video was selected for playback.
          type: string
          nullable: true
          example: 1080p_h264
        videoId:
          description: |
            Video ID refers to an internal identifier assigned by the user or system to uniquely identify a particular video.
          type: string
          nullable: true
          format: uuid
          example: 65b65e7e20ce0aaf6d7d5596
        videoLanguage:
          description: |
            Video Language denotes the primary audio language of the video content, assuming it remains unchanged after playback initiation.
          type: string
          nullable: true
          example: null
        videoProducer:
          description: |
            Specifies the creator or source responsible for producing the video content.
          type: string
          nullable: true
          example: null
        videoResolution:
          description: |
            Video Resolution refers to the resolution of the video being played.
          type: string
          nullable: true
          example: 1080X1920
        videoSeries:
          description: |
            Video Series denotes the name of a series to which the video content belongs.
          type: string
          nullable: true
          example: Propel 23
        videoSourceDomain:
          description: |
            Video Source Domain identifies the domain from which the video source originates.
          type: string
          nullable: true
          example: ibee.ai
        videoSourceDuration:
          description: |
            Video Source Duration represents the duration of the video source content, measured in milliseconds.
          type: integer
          format: long
          nullable: true
          example: 771090

        videoSourceHostname:
          description: |
            Video Source Hostname represents the hostname of the video.
          type: string
          nullable: true
          example: ott-sandbox-cdn.ibee.ai
        videoSourceStreamType:
          description: |
            Video Source Stream Type denotes the type of stream used by the player, although it is currently unused.
          type: string
          nullable: true
          example: on-demand
        videoSourceType:
          description: |
            Video Source Type denotes the format of the video source as determined by the player.
          type: string
          nullable: true
          example: application/dash+xml
        videoSourceUrl:
          description: |
            Video Source URL refers to the URL of the video source accessed by the player.
          type: string
          nullable: true
          example: https://ott-sandbox-cdn.ibee.ai/videos/650801bd148907a509076b99/650801bd148907a509076b99_h264.mpd
        videoStartupFailed:
          description: |
            Video Startup Failure is a boolean metric indicating whether a viewer encountered an error before the first frame of the video commenced playback.
          type: boolean
          example: false
        videoStartupTime:
          description: |
            Video Startup Time measures the duration, in milliseconds, from the initialization of the player within the webpage to its readiness to receive further instructions.
          type: integer
          format: long
          nullable: true
          example: 209
        videoTitle:
          description: |
            Video Title refers to the title of the video content being viewed.
          type: string
          nullable: true
          example: Cycle
        videoVariantId: #NANA
          description: |
            Represents the unique identifier for the specific video variant or rendition being played. Each variant corresponds to a particular encoding configuration, such as resolution or bitrate, used for adaptive streaming and performance tracking.
          type: string
          nullable: true
          example: null
        videoVariantName: #NANA
          description: |
            Specifies the human-readable name of the video variant or rendition being played (for example, “1080p H.264” or “720p AV1”). This helps identify the playback quality or encoding configuration selected during streaming.
          type: string
          nullable: true
          example: null
        viewEnd:
          description: |
            View End refers to the date and time, in Coordinated Universal Time (UTC), when the video viewing session concluded.
          type: string
          nullable: true
          example: 1710591342067
        viewHasAd:
          description: |
            View Has Ad is a boolean metric indicating whether an advertisement played or attempted to play during the video view.
          type: boolean
          example: false
        viewHasError: #NANA
          description: |
            Indicates whether any playback error occurred during the video view. This boolean flag helps identify failed or interrupted playback sessions caused by player, network, or media-related issues.
          type: boolean
          example: false
        viewId:
          description: |
            View ID is a unique identifier assigned to each individual video viewing session.
          type: string
          format: uuid
          example: 36935287-5d08-47a0-9365-5eaa150fc4fa

        viewMaxPlayheadPosition:
          description: |
            View Max Playhead Position represents the furthest point reached by the playhead during the video view, measured in milliseconds.
          type: integer
          format: long
          nullable: true
          example: 2524
        viewPageUrl:
          description: |
            View Page URL denotes the URL address of the web page where the video content is being accessed.
          type: string
          nullable: true
          example: https://chanajor.com/player/659d7de2500fe544eb2706da_1_1?time=66
        viewPlayingTime:
          description: |
            Playing Time denotes the total duration of time the video content was actively playing during the view, excluding time spent buffering, seeking, or joining.
          type: integer
          format: long
          nullable: true
          example: 523657
        viewSeekedCount:
          description: |
            View Seeked Count signifies the number of times the viewer attempted to seek to a new location within the video.
          type: integer
          nullable: true
          example: 1
        viewSeekedDuration:
          description: |
            View Seeked Duration indicates the total duration of time spent waiting for playback to resume after the viewer seeks to a new location. Seek Latency metric in the Dashboard is derived by dividing this value by the view_seek_count.
          type: integer
          format: long
          nullable: true
          example: 809
        viewSessionId: #NANA
          description: |
            Represents the unique identifier assigned to a single playback session within FastPix. This ID is used to correlate all playback events, errors, and metrics that occur during the same viewing session.
          type: string
          format: uuid
          nullable: true
          example: 4fa85f64-5717-4562-b3fc-2c963f66afa6
        viewStart:
          description: |
            View Start refers to the date and time, in Coordinated Universal Time (UTC), when the video viewing session commenced.
          type: string
          nullable: true
          example: 1710591342067
        viewTotalContentPlaybackTime:
          description: |
            View Total Content Playback Time represents the cumulative duration of video content watched by the viewer, measured in milliseconds. This metric is internally utilized to calculate upscale and downscale percentages.
          type: integer
          nullable: true
          format: long
          example: 22358
        viewerId:
          description: |
            Viewer ID refers to a customer-defined identifier representing the viewer who is watching the video stream. It must be anonymized and not contain any personally identifiable information.
          type: string
          nullable: true
          format: uuid
          example: 649c5098ba7cb499f5e1041f
        watchTime:
          description: |
            Total Watch Time denotes the total duration of video content watched by the viewer, encompassing startup time, playing time, and potential rebuffering time, measured in milliseconds.
          type: integer
          nullable: true
          format: long
          example: 4307
        workspaceId:
          description: |
            It is a unique identifier associated with a specific workspace within the FastPix platform.
          type: string
          format: uuid
          example: c08f55f8-92e1-4e17-9475-bc9024a07f78
        events:
          description: |
            Events specifies the order of events journey of the video playback
          type: array
          items:
            type: object
            properties:
              pt:
                description: |
                  The player_playhead_time represents the current position of the playhead (the point in the video that is being watched) on the video seekbar, measured in milliseconds. This value indicates how far into the video playback has progressed at any given moment.
                type: integer
                format: long
                nullable: true
              e:
                description: |
                  Name of the event.
                type: string
                nullable: true
              d:
                type: object
                additionalProperties: true

              vt:
                description: |
                  The unix epoch timestamp which represents the actual time the event has occurred.
                oneOf:
                  - type: string
                  - type: integer
                    format: long
                nullable: true
#              event_time:
#                description: |
#                  The unix epoch timestamp when the event was captured.
#                oneOf:
#                  - type: string
#                  - type: integer
#                    format: long
#                nullable: true
          example:
            availableValue:
              - e: playing
                vt: 1710591347846
                pt: 8990
              - e: variantChanged
                vt: 1710592342067
                pt: 8990
                d:
                  br: 7837883
                  cd: avc1.4d4028
                  h: 1920
                  w: 1080
    ViewsByTopContentDetails:
      description: Retrieves a list of the top video views
      type: object
      properties:
        videoTitle:
          description: Title of the video
          type: string
          example: example video title
        views:
          description: Total count of view sessions for a particular video content.
          type: integer
          example: 44
        uniqueViews:
          description: Total count of unique video viewers for particular video content.
          type: integer
          example: 40
    TopErrorDetails:
      description: Retrieves a list of errors that have occurred most frequently in the system, ranked by their count of occurrences.
      type: array
      items:
        type: object
        properties:
          percentage:
            description: views affected by the specific errors.
            oneOf:
              - type: integer
                format: integer
              - type: number
                format: double
            nullable: true
            example: 0.0222222222222222
          uniqueViewersEffectedPercentage:
            description: percentage of unique viewers affected by the specific error.
            oneOf:
              - type: integer
                format: integer
              - type: number
                format: double
            nullable: true
            example: 0.0122222222222222
          notes:
            description: Information about the specific error.
            type: string
            nullable: true
            example: An informative note
          message:
            description: error message or description.
            type: string
            nullable: true
            example: "com.fastpix.stats.sdk.h71.a - android.media.mediadrm$mediadrmstateexception: failed to handle key response: drm vendor-defined error: -2998"
          lastSeen:
            description: The timestamp of when the error was last observed.
            type: string
            nullable: true
            format: string
            example: "2023-12-01T11:31:07.000Z"
          count:
            description: Number of occurrences of the specific error.
            type: integer
            nullable: true
            example: 4
          code:
            description: Error code associated with the specific error.
            type: string
            nullable: true
            example: 1003
    ErrorDetails:
      description: The endpoint retrieves a comprehensive list of errors that have occurred by providing detailed information about each error instance.
      type: array
      items:
        type: object
        properties:
          percentage:
            description: views affected by the specific errors.
            oneOf:
              - type: integer
                format: integer
              - type: number
                format: double
            nullable: true
            example: 0.0222222222222222
          notes:
            description: Information about the specific error.
            type: string
            nullable: true
            example: An informative note
          message:
            description: error message or description.
            type: string
            nullable: true
            example: "com.fastpix.stats.sdk.h71.a - android.media.mediadrm$mediadrmstateexception: failed to handle key response: drm vendor-defined error: -2998"
          lastSeen:
            description: The timestamp of when the error was last observed.
            type: string
            nullable: true
            format: string
            example: "2023-12-01T11:31:07.000Z"
          id:
            description: Unique identifier for the error instance.
            type: string
            nullable: true
            example: "5f8d0d55b54764421b7156c5"
          description:
            description: A brief description of the error.
            type: string
            nullable: true
            example: "ERROR_CODE_IO_NETWORK_CONNECTION_TIMEOUT"
          count:
            description: Number of occurrences of the specific error.
            type: integer
            nullable: true
            example: 4
          code:
            description: Error code associated with the specific error.
            type: string
            nullable: true
            example: 1003
    MetricsComparisonDetails:
      description: Compare multiple metrics across specified dimensions.
      type: object
      properties:
        value:
          description: The specific metric value calculated based on the applied filters.
          type: number
          format: double
          example: 23
        type:
          type: string
          example: score
          description: value can be score that ranges from 0 to 100
        name:
          type: string
          example: Startup Score
          description: value can be score that ranges from 0 to 100
        metric:
          description: |
            The metric field represents the name of the Key Performance Indicator (KPI) being tracked or analyzed. It identifies a specific measurable aspect of the video playback experience, such as buffering time, video start failure rate, or playback quality.
          type: string
          example: startup_score
        measurement:
          type: string
          nullable: true
          example: count
          description: value can be avg, sum, count or 95th
        items:
          type: array
          nullable: true
          description: Nested comparison items
          items:
            $ref: "#/components/schemas/MetricsComparisonDetails"
    MetricsTimeseriesmetadataDetails:
      description: Retrieves breakdown values for a specified metric and timespan
      type: object
      properties:
        granularity:
          description: the unit for aggregating the timeseries data.
          type: string
          example: day
        aggregation:
          description: defines the field or dimension on which the aggregation is to be   applied.
          type: string
          example: viewEnd
    MetricsmetadataDetails:
      description: Retrieves breakdown values for a specified metric and timespan
      type: object
      properties:
        aggregation:
          description: defines the field or dimension on which the aggregation is to be   applied.
          type: string
          example: viewEnd
    MetricsTimeseriesDataDetails:
      description: The metrics value at specific time intervals.
      type: object
      properties:
        intervalTime:
          description: The timestamp for the data point indicating when the metric value was recorded.
          type: string
          format: date-time
          example: "2023-12-04T14:00:00.000Z"
        metricValue:
          type: number
          format: double
          nullable: true
          description: The value of the specified metric at the given interval.
          example: 0.793110142151515
        numberOfViews:
          description: The total number of views recorded during that interval.
          type: integer
          nullable: true
          format: long
          example: 143244
    MetricsOverallDataDetails:
      description: Retrieves overall values for a specified metric
      type: object
      properties:
        value:
          type: number
          format: double
          nullable: true
          description: metric value calculated based on the applied filters.
          example: 0.740365072855583
        totalWatchTime:
          description: Total time watched across all views, represented in milliseconds.
          type: integer
          nullable: true
          format: long
          example: 59534302
        uniqueViews:
          description: The count of unique viewers who interacted with the content.
          type: integer
          nullable: true
          format: long
          example: 44
        totalViews:
          description: The total number of views recorded.
          type: integer
          nullable: true
          format: long
          example: 195
        totalPlayTime:
          description: Total time spent playing the video, represented in milliseconds.
          type: integer
          nullable: true
          format: long
          example: 24729470
        globalValue:
          type: number
          format: double
          nullable: true
          description: A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan.
          example: 0.740365072855583
    MetricsOverallmetadataDetails:
      description: metadata that has to be paased for metric calculations.
      type: object
      properties:
        aggregation:
          description: defines the field or dimension on which the aggregation is to be   applied.
          type: string
          example: viewEnd
    MetricsBreakdownDetails:
      description: Retrieves breakdown values for a specified metric and timespan
      type: array
      items:
        type: object
        properties:
          views:
            description: Total count of view sessions for a paricular video content.
            type: integer
            nullable: true
            format: long
            example: 17
          value:
            type: number
            format: double
            nullable: true
            description: The specific metric value calculated based on the applied filters.
            example: 0.868748761512138
          totalWatchTime:
            description: Total time watched across all views, represented in milliseconds.
            type: integer
            nullable: true
            format: long
            example: 218599
          totalPlayingTime:
            description: Total time spent playing the video, represented in milliseconds.
            type: integer
            nullable: true
            format: long
            example: 218599
          field:
            description: the value of dimension or filter value on which the aggregation is to be applied.
            type: string
            nullable: true
            example: Chrome
    Dimensiondetails:
      type: array
      description: filter values associated with a specific dimension
      items:
        $ref: "#/components/schemas/BrowserNameDimensiondetails"
    BrowserNameDimensiondetails:
      type: object
      properties:
        value:
          description: The specific metric value calculated based on the applied filters.
          type: string
          example: Chrome
        uniqueCount:
          description: The count of unique viewers who interacted with the content.
          type: integer
          example: 20
        count:
          description: The count of viewers.
          type: integer
          example: 44
    Dimensions:
      type: array
      description: The endpoint retrieves a comprehensive list of dimensions
      items:
        type: string
        example:
          - browser_name
          - browser_version
          - os_name
          - os_version
          - device_name
          - device_model
          - device_type
          - device_manufacturer
          - player_remote_played
          - player_name
          - player_version
          - player_software_name
          - player_software_version
          - player_resolution
          - fp_sdk
          - fp_sdk_version
          - player_autoplay_on
          - player_preload_on
          - video_title
          - video_id
          - video_series
          - fp_playback_id
          - fp_live_stream_id
          - media_id
          - video_source_stream_type
          - video_source_type
          - video_encoding_variant
          - experiment_name
          - sub_property_id
          - drm_type
          - asn_name
          - cdn
          - video_source_hostname
          - connection_type
          - view_session_id
          - continent
          - country
          - region
          - viewer_id
          - error_code
          - exit_before_video_start
          - view_has_ad
          - video_startup_failed
          - video_content_type
          - page_context
          - playback_failed
          - custom_1
          - custom_2
          - custom_3
          - custom_4
          - custom_5
          - custom_6
          - custom_7
          - custom_8
          - custom_9
          - custom_10

    DataPagination:
      description: Pagination organizes content into pages for better readability and navigation.
      type: object
      properties:
        totalRecords:
          type: integer
          description: |
            The total number of records retrieved within the timespan.
          example: 2
        currentOffset:
          type: integer
          description: |
            The current offset value. 

            Default: 1
          example: 1
        offsetCount:
          type: integer
          description: |
            The total number of offsets based on limit.
          example: 1