Packs

Read a sound's settings and takes

A sound's event (the name /playsound and a sounds.json know it by: a vanilla one is replaced, any other is new), its volume category, subtitle and whether it loops, and its takes: every candidate a generation or an edit made, with the one that ships in selectedTake. Listen to a take with GET /packs/{pack}/sounds/{sound}/takes/{take} and choose it with POST /packs/{pack}/sounds/{sound}.

GET/packs/{pack}/sounds/{sound}

Path parameters

packstringrequired

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

soundstringrequired

The sound's name from the asset listing.

Response · 200

The sound.

packstringrequired

The pack.

soundobjectrequired

The sound.

idstringrequired

The sound's id, its name in the asset listing.

namestringrequired

Its label.

eventstringrequired

The sound event it plays as. A vanilla event is replaced; any other is new.

categorystringrequired

Which volume slider controls it.

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

subtitlestringrequired

Its subtitle. Null when it has none.

durationSecondsnumberrequired

How long the shipping take is.

loopbooleanrequired

Whether it is meant to loop.

statusstringrequired

generating, ready or error.

Options: generating, ready, error

promptstringrequired

What it was generated from. Null for an upload.

errorstringrequired

Why its generation failed. Null unless status is error.

takesarray of objectrequired

Every candidate, in the order they were made. Empty for a sound older than takes.

idstringrequired

The take's id within this sound.

durationSecondsnumberrequired

Its length.

createdAtstringrequired

ISO 8601.

selectedTakestringrequired

The take the pack ships. Null for a sound older than takes.

Error codes

Branch on error.code, never on the message.

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.

account_suspended403

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

plan_required403

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

not_found404

No such pack, asset or job.