videos

Changed on

Editorial image metadata; image bytes are uploaded through tusd.

patch/api/videos/{video_id}/images/{id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie sessionid

Path parameters

idinteger required
video_idinteger required

Request body

role'network_logo' | 'channel_logo' | 'show_logo' | 'show_still' | 'episode_still' | 'key_art_titled' | 'key_art_untitled' | 'behind_the_scenes' | 'location' | 'news_event' | 'portrait_headshot' | 'portrait_half_body' | 'portrait_full_body' | 'cast_ensemble'
  • network_logo - Network logo
  • channel_logo - Channel logo
  • show_logo - Show logo
  • show_still - Show still
  • episode_still - Episode still
  • key_art_titled - Key art with title
  • key_art_untitled - Key art without title
  • behind_the_scenes - Behind the scenes
  • location - Location
  • news_event - News event
  • portrait_headshot - Portrait, headshot
  • portrait_half_body - Portrait, half body
  • portrait_full_body - Portrait, full body
  • cast_ensemble - Cast ensemble

Response

idinteger required
videointeger required
role'network_logo' | 'channel_logo' | 'show_logo' | 'show_still' | 'episode_still' | 'key_art_titled' | 'key_art_untitled' | 'behind_the_scenes' | 'location' | 'news_event' | 'portrait_headshot' | 'portrait_half_body' | 'portrait_full_body' | 'cast_ensemble' required
  • network_logo - Network logo
  • channel_logo - Channel logo
  • show_logo - Show logo
  • show_still - Show still
  • episode_still - Episode still
  • key_art_titled - Key art with title
  • key_art_untitled - Key art without title
  • behind_the_scenes - Behind the scenes
  • location - Location
  • news_event - News event
  • portrait_headshot - Portrait, headshot
  • portrait_half_body - Portrait, half body
  • portrait_full_body - Portrait, full body
  • cast_ensemble - Cast ensemble
filenamestring required
mediaType'image/jpeg' | 'image/png' | 'image/webp' required
  • image/jpeg - JPEG
  • image/png - PNG
  • image/webp - WebP
widthinteger required
heightinteger required
urlstring required
createdTimestring date-time required

Changes

  • 3761c2b166bbRevision changes
    • breaking

      for the path request parameter id, the type changed from string to integer

    • breaking

      for the path request parameter video_id, the type changed from string to integer

    • info

      removed the pattern ^\d+$ from the path request parameter id

    • info

      removed the pattern ^\d+$ from the path request parameter video_id

  • 3eab16a32fdaRevision changes
    • info

      endpoint added