Skip to main content
POST
Convert or resize one file

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

A file, and what to write it as.

url
string<uri>

A public http(s) link to the file.

upload_id
string<uuid>

A finished direct upload.

job_id
string<uuid>

An earlier job's id, to reuse its source file.

asset_id
string<uuid>

A Vault file's id.

format
enum<string>
Available options:
png,
jpeg,
jpg,
webp,
mp4,
webm
quality
integer
default:85
Required range: 20 <= x <= 100
width
integer
Required range: x >= 16
height
integer
Required range: x >= 16
aspect
string
default:original
wait
boolean
default:true
webhook_url
string<uri>
save_to_vault

true to file the results in the Vault, or {"folder": "Clients/Acme"} to say where.

dry_run
boolean
default:false

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

Response

The conversion finished while the call waited — or, with dry_run, what it would cost.

One run of one skill, or one conversion. While status is queued or processing, poll poll_url.

id
string<uuid>
required
status
enum<string>
required
Available options:
queued,
processing,
complete,
failed
outputs
object[]
required
poll_url
string
required
Example:

"/api/v1/jobs/3f0c…"

skill
string | null

The skill's slug; null for a conversion.

format
string | null

What a conversion wrote; null for a skill.

source
object
error
string | null
created_at
string<date-time>
updated_at
string<date-time>
livemode
boolean

False for a test key's (mm_test_…) run, which charged nothing and ran nothing.

test
any

Present, and true, only on a test key's run.