Skip to main content
GET
Poll a recipe run

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}$

Path Parameters

id
string<uuid>
required

The run's id.

Query Parameters

stream
boolean
default:false

true to answer text/event-stream: an event: status each time it changes, then event: done with it settled — or as it stands after 150 seconds, when the stream closes. A keepalive comment every 15 seconds holds it open.

Response

The run — or, with stream=true, its changes as they happen.

A recipe run: its steps in order, each with its state, and the finished files under outputs once every step is done.

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

"/api/v1/runs/9a1d…"

name
string | null
recipe
object | null

The recipe the steps came from, and which version of it ran. Null for steps sent inline.

progress
object
facts
object

What analysis steps worked out, by name.

notes
object[]
shots
any[]
moments
any[]
outputs
object[]
credits_charged
integer
error
string | null
created_at
string<date-time>
updated_at
string<date-time>
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.

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.