Skip to main content
POST
Virtual try-on
POST /api/v1/run/try-on · MCP run_skill with skill: "try-on" Wear it before you buy it

What it looks like

The same woman in the same pose, without the coat

Before

Woman wearing the ivory wool coat in a pale studio

After

What it takes and hands back

  • Takes: a picture — as a url, an upload_id, a Vault asset_id, an earlier job_id, or a multipart file.
  • Second picture: required, as reference_url or reference_asset_id.
  • Hands back: a picture.

Price

11 credits per image.

Options

Send them in options. Anything left out takes its default.

Where it can sit in a recipe

Virtual try-on needs a second picture, which the steps can’t carry, so it runs on its own through POST /api/v1/run/try-on and can’t be one of the steps in a recipe.

Price it first

Add dry_run=true and the call makes every check, measures the file and answers with the price — without running or charging. A test key (mm_test_…) is free either way.
It answers 200 with credits, a step-by-step breakdown, and your balance after the run. See Dry runs.

Run it

The same code the Copy as code button hands out on the skill’s page in the app. Swap the link for your file, or send upload_id, asset_id or job_id instead.

See also

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

Wear it before you buy it

url
string<uri>
required

A public http(s) link to an image. Fetched once, checked like an upload.

reference_url
string<uri>
required

A public link to the second image this skill works with.

upload_id
string<uuid>

A finished direct upload (POST /api/v1/uploads), for a file too big to send in the body.

job_id
string<uuid>

An earlier job's id, to run this over its source file without sending it again.

asset_id
string<uuid>

A Vault file's id. The file is copied for the run and left as it was.

reference_job_id
string<uuid>

An earlier job whose source is the second image.

reference_asset_id
string<uuid>

A Vault image to use as the second image.

duration_seconds
number

How long the source runs, when it can't be measured. Anything measured on our side wins over it.

Required range: x >= 0
options
Virtual try-on options · object
wait
boolean
default:true

Hold the request until the job settles (up to 150 seconds). false answers 202 at once with a poll_url.

webhook_url
string<uri>

Where to POST the finished job, signed. Checked before anything is charged.

dry_run
boolean
default:false

Check everything and answer with the price, step by step, instead of running. Nothing is charged, queued or stored.

save_to_vault

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

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.