Skip to main content
POST
Run any skill by slug

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

Path Parameters

slug
enum<string>
required

The skill's slug, from GET /api/v1/skills.

Available options:
background-remover,
face-cutout,
blur-background,
smart-expand,
upscale,
alt-text,
restyle,
generate,
background-swap,
new-perspectives,
object-remove,
restore,
colourise,
headshot,
virtual-stage,
sky-replace,
day-to-dusk,
try-on,
virtual-model,
poster,
colouring-page,
meme,
fill-template,
mockup,
swap,
text-to-video,
animate,
text-to-voice,
music,
sound-effects,
reference-to-video,
finish-draft,
voice-design,
image-to-3d,
captions,
transcript,
watermark,
extract-audio,
video-to-gif,
thumbnail,
clean-audio,
trim-video,
split-video,
upscale-video,
b-roll,
dub-video,
add-soundtrack,
add-voiceover,
vocal-remover,
video-background-remover,
slow-motion,
lip-sync,
remove-silences,
cut-to-brief,
animated-text,
join,
compress-video,
deinterlace,
stabilise-video,
smart-reframe,
translate-captions,
talking-photo,
image-qa,
auto-tag,
classify,
face-check,
ai-text-detector,
ai-image-detector,
ai-video-detector,
ai-audio-detector,
blur-faces,
video-face-blur,
image-to-text,
collage,
slideshow,
image-splitter,
pixelate,
view-metadata,
mute-video,
clips,
youtube-thumbnail,
video-multiplier,
graphic-multiplier,
avatar-video,
ugc-ad,
ad-hooks,
static-ads,
ad-scripts,
write-rows,
digital-twin,
podcast-cover,
explainer,
brand-film,
site-promo,
music-video,
micro-drama,
convert-document,
merge-pdf,
split-pdf,
extract-pages,
compress-pdf,
pdf-to-pdfa,
protect-pdf,
unlock-pdf,
html-to-pdf,
pdf-to-images,
images-to-pdf,
ocr-pdf,
repair-pdf,
rotate-pdf,
watermark-pdf,
crop-pdf,
page-numbers,
organize-pdf,
extract-text,
summarise-document,
translate-document,
pdf-to-markdown,
pdf-to-sheet,
extract-pdf-images,
filter-rows,
remove-duplicate-rows,
keep-first-rows,
split-into-rows,
add-column,
stack-sheets,
match-sheets,
word-count,
readability,
paraphrase,
grammar-check,
fit-length,
humanize,
redact,
youtube-chapters,
youtube-description,
social-post,
show-notes,
pull-quotes,
clean-transcript,
audiogram,
visualizer,
lyric-video,
normalise-loudness,
change-speed,
reverse-video,
loop-video,
vectorise,
colour-palette,
qr-code,
screenshot,
character-sheet,
casting,
location-recce,
props,
wardrobe,
hair-makeup,
storyboard,
mood-board,
set-dressing,
creature-design,
vehicle-design,
relight,
pose-sheet,
expression-sheet,
character-scene,
age-shift,
packshot,
lifestyle-scene,
packaging-design,
logo-concepts,
icon-set,
sticker-sheet,
sketch-to-render,
comic-page,
storybook-page,
seamless-pattern,
tattoo-design,
floor-plan-render

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

url
string<uri>
upload_id
string<uuid>
job_id
string<uuid>
asset_id
string<uuid>
prompt
string
reference_url
string<uri>
reference_job_id
string<uuid>
reference_asset_id
string<uuid>
variations
integer
Required range: 1 <= x <= 4
duration_seconds
number
Required range: x >= 0
options
object
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 job 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.

credits_charged
integer

Charged when the job started; refunded if it fails.

vault
object

What save_to_vault filed. A run still going when the call came back says how to file it once it is done.