Clips

Get a clip storyboard

Returns a signed 4x4 WebP storyboard whose 16 tiles are sampled evenly across the requested window (durationMs/16 apart; every 5 seconds for the default 80s window) from a rendered clip, including its layouts, b-roll, zooms, and masks. startTimeMs is on the clip's playback timeline (cuts applied). Only startTimeMs and durationMs control the storyboard; tile count, dimensions, and format are fixed. By default returns a 302 redirect — set ?response=json to get {url, columns, rows, intervalMs} JSON instead.

get/v1/videos/{id}/clips/{clipId}/storyboard

Request

  • Base URL: https://api.tella.com
  • URL: https://api.tella.com/v1/videos/{id}/clips/{clipId}/storyboard
  • Auth: HTTP bearer

Path parameters

idstring required

Video identifier

Example:vid_abc123def456
clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Query parameters

startTimeMsinteger

Start time in ms on the selected target's playback timeline. Defaults to 0.

Example:1000
durationMsinteger

Storyboard window duration in ms. Defaults to 80000; the selected target's remaining duration may shorten it. Pass the target's full duration to sample it end to end.

Example:30000
response'json'

Set to 'json' to receive {url, columns, rows, intervalMs} instead of the default 302 redirect.

Example:json

Response

Returned when ?response=json is set

columnsinteger required

Tiles per row

intervalMsinteger required

Spacing between tiles in ms. Tile i (row-major) shows the frame at startTimeMs + i * intervalMs.

rowsinteger required

Tile rows

urlstring uri required

Signed CDN URL of the WebP sheet

Example response

{
  "columns": 4,
  "intervalMs": 5000,
  "rows": 4
}

Changes

No recorded changes to this operation across all 1 revision of this API.