Videos

Create a video

Creates a video in a channel. Provide the source one of four ways (in order of preference): url (server downloads it — best for any real size, no client egress needed), s3_key (after a direct-to-S3 upload via the upload-signature endpoints), inline file_base64 (short clips only, ≤5MB — the body is buffered and rides the JSON parser; larger inline uploads are rejected), or a multipart file (mp4/mov, max 5GB). channel_id is optional when the token resolves to a single channel; otherwise it is required. Video duration must be at least 3 seconds. The maximum follows the business's short-video subscription limit: 1 hour by default, up to the 3-hour platform ceiling.

post/api/v1/videos

Request

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

Request body

OR
OR

Response

Created 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.