{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mux Animated Images Storyboards API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Storyboards",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a Storyboard Image for Timeline Hover Previews",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mux.com/:PLAYBACK_ID/storyboard.:EXTENSION",
            "params": [
              {
                "name": "PLAYBACK_ID",
                "value": "",
                "type": "path",
                "description": "The asset or live stream's playback ID."
              },
              {
                "name": "TOKEN",
                "value": "",
                "type": "query",
                "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback)."
              },
              {
                "name": "EXTENSION",
                "value": "",
                "type": "path",
                "description": "The storyboard image extension, either 'jpg', 'png', or 'webp'."
              },
              {
                "name": "program_start_time",
                "value": "",
                "type": "query",
                "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream."
              },
              {
                "name": "program_end_time",
                "value": "",
                "type": "query",
                "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream."
              },
              {
                "name": "asset_start_time",
                "value": "",
                "type": "query",
                "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips)."
              },
              {
                "name": "asset_end_time",
                "value": "",
                "type": "query",
                "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips)."
              }
            ]
          },
          "docs": "Fetch a storyboard image composed of multiple thumbnails for use in [timeline hover previews](https://docs.mux.com/guides/create-timeline-hover-previews)."
        },
        {
          "info": {
            "name": "Retrieve Storyboard Metadata in WebVTT Format",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mux.com/:PLAYBACK_ID/storyboard.vtt",
            "params": [
              {
                "name": "PLAYBACK_ID",
                "value": "",
                "type": "path",
                "description": "The asset or live stream's playback ID."
              },
              {
                "name": "TOKEN",
                "value": "",
                "type": "query",
                "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback)."
              },
              {
                "name": "program_start_time",
                "value": "",
                "type": "query",
                "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream."
              },
              {
                "name": "program_end_time",
                "value": "",
                "type": "query",
                "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream."
              },
              {
                "name": "asset_start_time",
                "value": "",
                "type": "query",
                "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips)."
              },
              {
                "name": "asset_end_time",
                "value": "",
                "type": "query",
                "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips)."
              }
            ]
          },
          "docs": "Fetch metadata for the [storyboard image in WebVTT format](https://docs.mux.com/guides/create-timeline-hover-previews#webvtt), detailing the coordinates and time ranges of each thumbnail."
        },
        {
          "info": {
            "name": "Retrieve Storyboard Metadata in JSON Format",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mux.com/:PLAYBACK_ID/storyboard.json",
            "params": [
              {
                "name": "PLAYBACK_ID",
                "value": "",
                "type": "path",
                "description": "The asset or live stream's playback ID."
              },
              {
                "name": "TOKEN",
                "value": "",
                "type": "query",
                "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback)."
              },
              {
                "name": "program_start_time",
                "value": "",
                "type": "query",
                "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream."
              },
              {
                "name": "program_end_time",
                "value": "",
                "type": "query",
                "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream."
              },
              {
                "name": "asset_start_time",
                "value": "",
                "type": "query",
                "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips)."
              },
              {
                "name": "asset_end_time",
                "value": "",
                "type": "query",
                "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips)."
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the storyboard image URL in the response. Can be either 'jpg', 'png', or 'webp'. Defaults to 'jpg'."
              }
            ]
          },
          "docs": "Fetch metadata for the [storyboard image in JSON format](https://docs.mux.com/guides/create-timeline-hover-previews#json), detailing the coordinates and time ranges of each thumbnail."
        }
      ]
    }
  ],
  "bundled": true
}