Generating

Generate a mob

Produces a mob: a creature RP Engine spawns in the world, which walks, fights and makes its own sounds. The Studio's Mob answer on the Add asset dialog, in one run: the creature is built as a 3D model, then set up (behaviour, health, hitbox) and animated for each state, and given its own ambient, hurt, death and attack sounds.

This is the slowest one: a model build and a rig, typically ten to twenty minutes. One charge for all of it, refunded in full if the build fails; a rig that fails after the build is not charged, and leaves the mob without animations (animate it again with POST /packs/{pack}/mobs/{model}/rig).

Change its behaviour, drops and abilities in the Studio's mob editor.

POST/packs/{pack}/mobs

Path parameters

packstringrequired

The pack's slug, as returned by the packs endpoints.

Body

promptstringrequired

What the creature is.

namestring

Your label. Falls back to the prompt.

statesarray of string

Which states to animate. Absent animates death, attack, hurt, walk and idle.

referenceIdstring

A reference image: the referenceId from POST /packs/{pack}/references, or one uploaded in the Studio.

useStyleGuidebooleandefault true

Follow the pack's style guide — its palette, its notes and its reference pictures. Defaults to true, so a pack with a style guide produces assets that match it without this field. Send false for one asset that should deliberately not match. A pack with no style guide, or one switched off, ignores this either way.

Response · 202

Accepted. The work runs asynchronously — poll job until it leaves generating.

idstringrequired

The asset's id within the pack.

typestringrequired

What 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

kindstringrequired

The file format it is stored as.

Options: texture, model, font, sound

statusstringrequired

Always generating — nothing is finished when this returns.

packstringrequired

The pack it was written into.

jobstringrequired

Poll this at GET /jobs/{job} until it leaves generating.

Error codes

Branch on error.code, never on the message.

invalid_request400

Something in the body or query is wrong. message says what.

invalid_api_key401

The key isn't one of ours, or it has been revoked.

missing_api_key401

No Authorization: Bearer header was sent.

wrong_key_kind401

An MCP key sent to the REST API, or an API key sent to the MCP server. Each only opens its own.

insufficient_credits402

Not enough AI Credits to run this. Nothing was started or charged.

account_suspended403

The account is suspended, so its keys open nothing. message says until when, if the suspension has an end date.

asset_limit_reached403

The pack is at its asset limit.

forbidden403

Valid key, but not permitted to do this in this pack.

plan_required403

The key is valid, but its account's plan does not include the API.

not_found404

No such pack, asset or job.