Renders

POST /v1/renders は 1 つのテンプレートを画像または PDF にレンダリングします。

# Request

bash

curl https://api.mostlyrender.com/v1/renders \
  -H "Authorization: Bearer mr_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "tpl_abc",
    "modifications": { "title": "Hello" },
    "output": "png"
  }'

Field	Type	Notes
`template`	string	必須。テンプレート ID。(`templateId` も受け入れられます。)
`modifications`	object	レイヤー上書き、レイヤー名をキーとします。Templates as parameters を参照してください。
`output`	string	`png` (デフォルト)、`jpeg`、`webp`、または `pdf`。
`async`	boolean	ジョブをキューに入れ、インラインでレンダリングする代わりに `202` を返します。
`webhookUrl`	string	完了時の署名付きコールバック (非同期を意味します)。Async & webhooks を参照してください。

# Response

json

{
  "id": "rnd_abc123",
  "url": "https://img.mostlyrender.com/mostlyrender/renders/rnd_abc123.png",
  "output": "png"
}

url はパブリックで CDN キャッシュされています。レンダリングはアプリの Usage でもログされます。

# Output formats

png — ロスレス、透明度対応。デフォルトです。
jpeg / webp — より小さい; 写真に適しています。
pdf — ベクトル、印刷対応アセットに最適です。

# SDK

python

out = mr.render("tpl_abc", modifications={"title": "Hello"}, output="pdf")
print(out["url"])

1 回の呼び出しで多くの画像を処理する場合は Batch を参照してください。API キーなしで <img>/OG 埋め込みの場合は Signed render URLs を参照してください。