Generating
Generate the Escape menu
Produces the pack's Escape menu: a gui that reskins the pause screen. A director plans every button from the prompt (its colour, its art and, unless you set them, its words), and the result is one asset: the shared button face with its hover and disabled states, and each button's own label art. Because the button face is shared, the title screen, the options screens and the world list wear the same look.
A pack holds one. A second is refused with conflict; change the existing one in the Studio instead.
The heading over the buttons is either words (heading), taken exactly as written, or a picture drawn from a description (logoPrompt). Send one or neither: with neither, the director chooses the words.
The whole menu is one charge, settled by what its run used.
/packs/{pack}/escape-menuPath parameters
packstringrequiredThe pack's slug, as returned by the packs endpoints.
Body
promptstringrequiredWhat the menu is made of and how it should feel. Applied to every button.
namestringYour label. Defaults to the screen's own name.
headingstringmax 20 charactersExact words for the heading over the buttons. Anything past 20 characters is cut off. Omit to let the director choose.
logoPromptstringmax 200 charactersA picture to draw as the heading instead of words, described. Anything past 200 characters is cut off. Its backdrop is keyed out, so it floats over the player's world.
sweepbooleanWhether light sweeps across the button faces. Omit to let the director decide from the prompt.
Response · 202
Accepted. The work runs asynchronously — poll job until it leaves generating.
idstringrequiredThe asset's id within the pack.
typestringrequiredWhat is generating. For an item, item or item3d.
Options: model, vehicle, mob, block, block_face, model_texture, item, item_model, item3d, armor, armor3d, gui, hud, dialog, icon, rank_tag, sound
kindstringrequiredThe file format it is stored as.
Options: texture, model, font, sound
statusstringrequiredAlways generating — nothing is finished when this returns.
packstringrequiredThe pack it was written into.
jobstringrequiredPoll this at GET /jobs/{job} until it leaves generating.
Error codes
Branch on error.code, never on the message.
invalid_request400Something in the body or query is wrong. message says what.
invalid_api_key401The key isn't one of ours, or it has been revoked.
missing_api_key401No Authorization: Bearer header was sent.
wrong_key_kind401An MCP key sent to the REST API, or an API key sent to the MCP server. Each only opens its own.
insufficient_credits402Not enough AI Credits to run this. Nothing was started or charged.
account_suspended403The account is suspended, so its keys open nothing. message says until when, if the suspension has an end date.
asset_limit_reached403The pack is at its asset limit.
forbidden403Valid key, but not permitted to do this in this pack.
plan_required403The key is valid, but its account's plan does not include the API.
not_found404No such pack, asset or job.
conflict409That vanilla target is already reskinned in this pack. Change it in the Studio rather than overwriting it.
unavailable503The feature behind this endpoint is switched off.