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.

POST/packs/{pack}/sounds

Currently unavailable. This endpoint answers 503 unavailablewhile the feature is switched off. Everything below still describes it for when it's back.

Path parameters

packstringrequired

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

Body

promptstringrequired

What it should sound like.

eventstringrequired

The Minecraft event name this sound answers to.

namestring

Your label.

categorystring

Which volume slider controls it.

Options: master, music, record, weather, block, hostile, neutral, player, ambient, voice

subtitlestring

The subtitle shown when it plays.

durationSecondsnumber0.5–30

Omit to let the model choose a length.

promptInfluencenumber0–1

How literally to follow the prompt.

loopbooleandefault false

Whether it should loop seamlessly.

takeCountinteger1–10default 4

How many alternatives to generate.

Response · 202

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

idstringrequired

The asset's name within the pack.

kindstringrequired

Which store the generated asset lands in.

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.

insufficient_credits402

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

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 is on Starter. The API needs a paid plan.

not_found404

No such pack, asset or job.

unavailable503

The feature behind this endpoint is switched off.