Skip to main content
POST
Make an instant link

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

Body

application/json
template
string
required

A saved template's id, or a built-in's slug like og-card.

security
enum<string>
default:signed
Available options:
signed,
open
per_ip_per_hour
integer | null
Required range: 1 <= x <= 10000
most_renders
integer | null
Required range: 1 <= x <= 1000000
expires_at
string<date-time> | null
version

Pin a saved template: true for its current version, or a version number. Left out, the link follows the latest.

name
string
Maximum string length: 80

Response

The link, its secret (signed links only) and an example URL that works.

A URL on the CDN host that draws a template from its query string: <url>?<field>=…&size=WxH&s=<signature>. The first request for a set of values renders it and costs one Fill a template (1 credit); every later one is served from storage for nothing.

id
string
Pattern: ^[a-z0-9]{16}$
url
string

The link with no query, as a PNG. End it in .jpg or .webp for those. Add fields as query parameters, then sign it.

template
string

A saved template's id, or a built-in's slug.

template_version
integer | null

The version it's pinned to. Null follows the template's latest.

name
string | null
security
enum<string>

signed answers only URLs whose s is HMAC-SHA256, hex, of <path>?<query> under the link's secret: every parameter but s, sorted by name, each escaped as encodeURIComponent does, joined with &. open answers any query, and is always held to per_ip_per_hour.

Available options:
signed,
open
per_ip_per_hour
integer | null

New pictures one address can make in an hour. Cached ones don't count.

most_renders
integer | null

New pictures the link can ever make. Null is no limit.

render_count
integer

New pictures it has made so far.

last_rendered_at
string<date-time> | null
expires_at
string<date-time> | null
enabled
boolean
created_at
string<date-time>
example_url
string

The template's own words as a URL, signed when the link is.

secret
string | null

The signing secret, shown this once. Null for an open link.