Videos

Publish a video, optionally at a scheduled time

Publishes the video immediately, or — when published_at is a future time — schedules it. Scheduling is capped at 28 days from now; a published_at beyond that window (or in the past) returns 422. Omit the body to publish now. A scheduled video becomes visible automatically once the time passes, with no further call.

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

Request

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

Path parameters

idstring required

video ID

Request body

published_atstring date-time

ISO 8601 time to publish. A future time schedules the video (capped at 28 days from now; a time beyond that window, or in the past, returns 422). Omit to publish now.

Response

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