Skip to main content
POST
Run the same steps once per row

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

Query Parameters

dry_run
boolean
default:false

true to check and price the run without running it. Same as dry_run in the body.

Body

application/json

The steps, with {{column}} wherever a row's value goes, and the rows: one of rows, csv or matrix. A file every row starts from is url, upload_id, job_id or asset_id; a file per row is a column of links or Vault ids named by file_column.

url
string<uri>
upload_id
string<uuid>
job_id
string<uuid>
asset_id
string<uuid>
recipe
string

As POST /api/v1/runs takes it.

steps
object[]
Minimum array length: 1
output
object

Save as, applied to the finished file: {"format": "webp", "quality": "85"}. Or a list of up to 5, one file each, all made from the last step's file: [{"format": "png"}, {"format": "webp"}]. In a list, format takes png, jpeg or webp. An entry that changes nothing on the finished file makes no file. The extra files are free.

rows
object[]

One object per row. Its keys are the variables: Product Name is {{product_name}}.

Maximum array length: 1000
csv
string

A sheet's text, header row first.

matrix
object

Up to 4 lists. Every value is run with every value of every other list.

file_column
string

The column holding each row's file: a link (a direct file, a video site, a Drive or Dropbox share, a podcast episode) or a Vault file id. A link two rows share is fetched once. A picture option such as end-frame can hold {{column}} too, for a picture per row.

naming
string

What each result is called, from its row: {{sku}}-{{colour}}. {{row}} is the row's number.

budget
integer

The most credits the batch spends. It pauses before a row would take it over.

Required range: x >= 1
check
object

Check each picture and make the ones that fail again, up to retries times.

locks
object
name
string
webhook_url
string<uri>

Told once, when every row has settled.

dry_run
boolean
default:false

Check everything and answer with the price instead of running. Also taken as ?dry_run=true.

Response

With dry_run: what it would cost.

The response is of type object.