Skip to navigation

Queue a Minecraft player render

View as Markdown

Queues an mcrender job and answers 202 with the job id straight away. Poll GET /v1/jobs/{id}, or hold on GET /v1/jobs/{id}/wait, to get the rendered PNG. Passing skinUrl skips the player lookup entirely and renders that texture as-is.

Path parameters

playerstringRequired
Java or Bedrock username, Java UUID, Floodgate UUID or XUID

Query parameters

renderenumOptionalDefaults to wave
Which view to render
scaleintegerOptional1-4Defaults to 1
Multiplier on the view resolution
skinUrlstringOptionalformat: "uri"
Render this skin instead of the player one. Skips the player lookup.
capeUrlstringOptionalformat: "uri"
Render this cape instead of the player one

Response

The job was queued
successboolean
dataobject

Errors

400
Bad Request Error
404
Not Found Error
502
Bad Gateway Error