Skip to main content
POST
Create a video schedule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.

Body

application/json
name
string
required
Required string length: 1 - 120
videos_per_day
integer
required
Required range: 1 <= x <= 10
starts_on
string
required

First posting day, YYYY-MM-DD

Pattern: ^\d{4}-\d{2}-\d{2}$
connection_ids
string<uuid>[]
required

Accounts every video is posted to

Minimum array length: 1
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
days_of_week
integer[]

0 = Sunday to 6 = Saturday. Omit or empty for every day.

Maximum array length: 7
Required range: 0 <= x <= 6
post_hour
integer

Hour of the day posts go out. Default 9.

Required range: 0 <= x <= 23
time_zone
string

IANA time zone, e.g. America/New_York. Default UTC.

Required string length: 1 - 64
ends_on
string | null

Last posting day. Omit or null to run until paused.

Pattern: ^\d{4}-\d{2}-\d{2}$
caption
string | null

One caption for every post. Omit to have one written per video.

Maximum string length: 4000
direction
string | null

What the videos should be about, in your words

Maximum string length: 2000
allowed_templates
enum<string>[]

Templates the director may pick from. Omit or empty for any it can make.

Maximum array length: 8
Available options:
talking_avatar,
remotion,
freeform_ai,
meme_hook,
interview,
phone_mockup,
slideshow,
real_footage
notify_hours_before
integer

How far ahead the videos are planned and you are told what is coming. Default 1.

Required range: 0 <= x <= 24
notify_by_email
boolean
video_settings
object

Recipe parts pinned for every video: presenter, style, format, length, source.

source_video_id
string<uuid>

Model the schedule on this video: its template and recipe are pinned

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Success

data
object
required