Generating
Generate a sound
Produces a sound.
The event name is the feature. entity.creeper.primed replaces the creeper fuse; custom.gate_open is a new event you fire by command. A malformed one is refused rather than quietly corrected, because the name decides what the sound does.
Sounds take no reference image. Each take is a separate provider call and is charged accordingly.
/packs/{pack}/soundsPath parameters
packstringrequiredThe pack's slug, as returned by the packs endpoints.
Body
promptstringrequiredWhat it should sound like.
eventstringrequiredThe Minecraft event name this sound answers to.
namestringYour label.
categorystringWhich volume slider controls it.
Options: master, music, record, weather, block, hostile, neutral, player, ambient, voice
subtitlestringThe subtitle shown when it plays.
durationSecondsnumber0.5–30Omit to let the model choose a length.
promptInfluencenumber0–1How literally to follow the prompt.
loopbooleandefault falseWhether it should loop seamlessly.
takeCountinteger1–10default 4How many alternatives to generate.
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.
unavailable503The feature behind this endpoint is switched off.