Skip to main content
POST
Schedule steps or a recipe to run on the clock

Authorizations

Authorization
string
header
required

Authorization: Bearer mm_live_…. Mint a key at mediamonster.app/keys; every plan includes the API. A test key, mm_test_…, runs every check a live key does and spends nothing: each run finishes at once with a stand-in file, and says livemode: false. A key does only what its scopes allow.

Headers

X-Request-Id
string

Your own id for this request — 8 to 128 letters, digits, ., _, : or -. Used in place of one we mint, and echoed back.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$
Idempotency-Key
string

Retry this POST safely: the first request with a key runs and its answer is kept for a day; a retry with the same key and the same request gets that answer again, marked Idempotent-Replayed: true, instead of running twice. 1–255 printable characters — a UUID is a good one.

Required string length: 1 - 255

Body

application/json
name
string
required
Maximum string length: 80
recipe_id
string

A recipe saved on the Workbench.

recipe_version
integer | null

Stay on this version of recipe_id, whatever it's edited to. null, or left out on a new automation, follows the recipe.

Required range: x >= 1
steps
object[]

Or steps written inline.

repeat
enum<string>
Available options:
once,
hourly,
daily,
weekly,
monthly
starts_at
string<date-time>
at
string

HH:MM, local.

Pattern: ^\d{2}:\d{2}$
every_hours
enum<integer>
Available options:
1,
2,
3,
4,
6,
8,
12
weekdays
integer[]
Required range: 0 <= x <= 6
month_day
integer
Required range: 1 <= x <= 28
timezone
string
ends_after
integer | null
trigger
enum<string>

Anything but clock runs on what the trigger brings, with source set to trigger (a webhook can also be none, for steps that make their own file). webhook and upload get a private link, email an address.

Available options:
clock,
webhook,
upload,
email,
podcast,
feed,
youtube
trigger_source
string

For podcast and feed: the feed's address. For youtube: the channel's @handle or link.

most_runs_a_day
integer | null

Optional. null or left out is no limit.

Required range: 1 <= x <= 5000
most_credits_a_month
integer | null

Optional, for any automation. The most credits its runs spend in a calendar month; a run that would go past it is skipped. null is no limit.

Required range: 1 <= x <= 10000000
send_webhook_url
string | null

An https address to post each run's outcome to. null clears it.

input_values
object | null

Values for its steps' {{inputs}}. Every required one has to be here unless it runs from a link, whose requests can send them. Names the steps don't use are dropped. null clears them.

most_upload_mb
integer | null

For upload: the largest file its page takes, in MB. null is the plan's.

Required range: 1 <= x <= 100
only_if
object[] | null

For folder and trigger: only files meeting every condition start a run; the rest are skipped, at no cost, with the reason in the history. A condition on a length, shape or size that wasn't measured doesn't match. null clears it.

Maximum array length: 8
source
enum<string>
Available options:
none,
asset,
folder,
trigger
source_asset_id
string<uuid>
source_asset_ids
string<uuid>[]

For asset: several Vault files, each run on every time. Replaces source_asset_id.

Maximum array length: 50
source_folder
string
most_files
integer
Required range: 1 <= x <= 200
output_folder
string
enabled
boolean
run_now
boolean

On a change: fire it once now, off its clock.

Response

The schedule.

Steps, or a saved recipe, run on their own: on the clock, once or on repeat, or when files are posted to its link.

id
string<uuid>
name
string
enabled
boolean
recipe
object
steps
object[]
repeat
enum<string>
Available options:
once,
hourly,
daily,
weekly,
monthly
starts_at
string<date-time>
at_minute
integer

Minutes past local midnight.

every_hours
integer
weekdays
integer[]
Required range: 0 <= x <= 6
month_day
integer
timezone
string
ends_after
integer | null
when
string

How it reads, such as "Weekdays at 09:00".

source
enum<string>
Available options:
none,
asset,
folder,
trigger
trigger
enum<string>

What starts it: the clock; a POST to trigger_url (webhook), or files dropped on the page there (upload); mail to trigger_email; or something new in the podcast, feed or channel at trigger_source, checked every 10 minutes.

Available options:
clock,
webhook,
upload,
email,
podcast,
feed,
youtube
trigger_email
string | null

For email: its address. Each attachment of mail sent to it is a run. Only for callers who may change it.

trigger_source
string | null

For podcast, feed and youtube: the feed it reads.

trigger_url
string | null

For webhook: the path to POST files to, on this host. Only for callers who may change it. Anyone holding it can run the automation.

most_runs_a_day
integer | null

The most runs its link starts in any 24 hours. null is no limit.

most_credits_a_month
integer | null

The most credits its runs spend in a calendar month, in its timezone. A run that would go past it is skipped until the month turns. null is no limit.

credits_this_month
integer | null

What its runs have spent this calendar month, counting a run still going at its quote. null when it has no most_credits_a_month.

send_webhook_url
string | null

Where each run's outcome is posted, signed like a run's own webhook_url.

only_if
object[] | null

For folder and trigger: the conditions every incoming file has to meet to start a run. The rest are skipped, at no cost. null is every file.

inputs
object[]

What its steps ask to be told: the {{names}} in them.

input_values
object

The values those run with. A request to its link can send its own inputs, which win for that request.

most_upload_mb
integer | null

For upload: the largest file its page takes, in MB. null is the plan's.

source_asset
object | null

The first of source_assets.

source_assets
object[]

For asset: every Vault file each run starts from, one run each.

source_folder
string | null
most_files
integer
output_folder
string
next_run_at
string<date-time> | null
last_run_at
string<date-time> | null
run_count
integer
paused
object | null
finished
boolean
estimate
object
created_by
string | null
created_at
string<date-time>
updated_at
string<date-time>
can_edit
boolean