Videos

Get a video

get/api/v1/videos/{id}

Request

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

Path parameters

idstring required

video ID

Query parameters

fieldsstring

Comma-separated subset of response fields to return, e.g. id,caption,duration. id is always included. Use it to cut response size on list calls. Valid fields: id, access, audio_disabled, caption, content_generation_type, description, duration, hashtags, archived_at, published_at, is_published, action_type, action_type_translation, action_url, action_custom_label, product_ids, variant_ids, custom_fields, display_social_attributions, external_media, thumbnail_url, watch_url, video_posters.

Response

The video

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.