Renders
POST /v1/renders renderiza um template para uma imagem ou PDF.
# Request
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 | Obrigatório. O ID do template. (templateId também é aceito.) |
modifications |
object | Sobrescrita de camadas, chaveadas por nome de camada. Ver Templates as parameters. |
output |
string | png (padrão), jpeg, webp, ou pdf. |
async |
boolean | Enfileirar o trabalho e retornar 202 em vez de renderizar em tempo real. |
webhookUrl |
string | Callback assinado após conclusão (implica async). Ver Async & webhooks. |
notifyEmail |
string | Enviar email para este endereço quando o trabalho terminar (implica async). |
# Response
{
"id": "rnd_abc123",
"url": "https://img.mostlyrender.com/mostlyrender/renders/rnd_abc123.png",
"output": "png"
}
O url é público e armazenado em cache na CDN. Renders também são registrados no app em Usage.
# Output formats
png— sem perda, transparência. O padrão.jpeg/webp— menor; bom para fotos.pdf— vetor, ótimo para ativos prontos para impressão.
# SDK
out = mr.render("tpl_abc", modifications={"title": "Hello"}, output="pdf")
print(out["url"])
Para muitas imagens em uma única chamada, ver Batch. Para incorporação de <img>/OG sem uma chave de API, ver Signed render URLs.