Skip to main content
GET
Poll a batch

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 batch's id.

Query Parameters

offset
integer
default:0
Required range: x >= 0
limit
integer
default:100
Required range: 1 <= x <= 200

Response

The batch.

A batch and a page of its rows.

id
string<uuid>
object
any
name
string
status
enum<string>
Available options:
running,
paused,
complete,
cancelled
paused_reason
string | null

budget, credits, or null.

rows
object
credits_charged
integer
budget
integer | null
failed_inputs
object[]

Every row whose own link couldn't be fetched — its file, or its picture in a {{column}} option — across all rows, not only this page. row is the row's index. Those rows failed without being charged; the others ran.

items
object[]
page
object
poll_url
string
results_url
string