Videos

Add a poster to a video from a URL

post/api/v1/videos/{id}/posters

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/videos/{id}/posters
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: videos:write)

Path parameters

idstring required

video ID

Request body

sourcestring nullable

Where the poster was generated (defaults to "api")

urlstring required

HTTP(S) URL of a poster image; downloaded and attached to the video

weightnumber nullable

Rotation weight; heavier posters are served first

external_idstring nullable

The generating system's own poster id; unique per video, usable to address the poster in updates

video_poster_type'static' | 'animated' nullable

Derived from the file format when omitted

Response

Video with the new poster

accessstring

Visibility, e.g. "public" or "private"

idstring
descriptionstring nullable
hashtagsstring[]
published_atstring date-time nullable

When the video is/was published; null for an unpublished draft. A future value is scheduled.

durationnumber nullable

Duration in seconds

captionstring nullable
custom_fieldsobject
action_urlstring nullable
product_idsstring[]
action_typestring nullable
thumbnail_urlstring nullable
display_social_attributionsboolean nullable
content_generation_type'aigc' nullable

Whether the video contains AI-generated content.

archived_atstring date-time nullable
audio_disabledboolean
action_custom_labelstring nullable
is_publishedboolean

Whether the video is currently live (published_at is set and not in the future). Evaluated at request time, so a scheduled video flips to true automatically when its time passes.

action_type_translationstring nullable

Translated CTA display label; for custom actions, this is the custom label.

watch_urlstring

Web URL where a viewer can watch the video.

Changes

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