Sign in
Storyboards

Retrieve storyboard metadata in JSON format

Fetch metadata for the storyboard image in JSON format, detailing the coordinates and time ranges of each thumbnail.

get/{PLAYBACK_ID}/storyboard.json

Path parameters

PLAYBACK_IDstring required

The asset or live stream's playback ID.

Query parameters

TOKENstring

Signed token (JWT) for secure video playback.

program_start_timeinteger

Set the start time of the asset created from a live stream when using the instant clipping feature. The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.

program_end_timeinteger

Set the end time of the asset created from a live stream when using the instant clipping feature. The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.

asset_start_timenumber float

Set the relative start time of the asset (in seconds) when using the instant clipping feature.

asset_end_timenumber float

Set the relative end time of the asset (in seconds) when using the instant clipping feature.

format'jpg' | 'png' | 'webp'

The format of the storyboard image URL in the response. Can be either 'jpg', 'png', or 'webp'. Defaults to 'jpg'.

Response

JSON storyboard retrieved successfully.

string required

Changes

Changed in 3 of the 28 revisions of this API.8

  • 4cb6473403b61See the full diff
    • ○

      added the new optional query request parameter format

      new-optional-request-parameter

  • 323c1dc63b7a6See the full diff
    • ○

      api tag Storyboards added

      api-tag-added

    • ○

      api tag Image removed

      api-tag-removed

    • ○

      added the new optional query request parameter asset_end_time

      new-optional-request-parameter

    • ○

      added the new optional query request parameter asset_start_time

      new-optional-request-parameter

    • ○

      added the new optional query request parameter program_end_time

      new-optional-request-parameter

    • ○

      added the new optional query request parameter program_start_time

      new-optional-request-parameter

  • d4d7fca3b7381See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog