Skip to content
ForgeCastDocs

Sounds

Search a catalog of short sound effects, browse it by category, and fetch the audio.

A catalog of short sound effects, the kind a streamer plays on stream. ForgeCast reads them from Myinstants.

Sounds can be copyrighted

Myinstants' users upload these sounds, so using one is up to whoever uses it, the same as for any file you download. Every answer carries source so you can credit it, and each sound has a sourceUrl to its page there.

All of these endpoints:

  • need the sounds:read scope (or a signed-in website user, or the desktop app);
  • allow 60 requests a minute per account;
  • answer 502 sound_source_unavailable when the source can't be reached. Recent answers are cached, so a short outage usually isn't noticed.

Search sounds

Search by words, or list the trending, best or most recent sounds, or a category.

GET/api/v1/soundssounds:read

Query parameters

Name

Type

curl -s "$FORGECAST_URL/api/v1/sounds?q=air%20horn&limit=2" \
  -H "Authorization: Bearer $FORGECAST_KEY"

nextOffset is the offset for the next page, or null when there's nothing more. color is the button colour the source gives the sound, or null.

List categories

The categories to browse by.

GET/api/v1/sounds/categoriessounds:read
curl -s "$FORGECAST_URL/api/v1/sounds/categories" \
  -H "Authorization: Bearer $FORGECAST_KEY"

Get one sound

One sound, in the same shape as the list. 404 for an unknown id.

GET/api/v1/sounds/:soundIdsounds:read
curl -s "$FORGECAST_URL/api/v1/sounds/dj-airhorn-sound-effect-kingbeatz_1" \
  -H "Authorization: Bearer $FORGECAST_KEY"

Get the audio

The sound's audio file, streamed through ForgeCast so a client only ever talks to the ForgeCast API. Content-Type is audio/…, and Content-Length is sent when it's known, so a client can show a progress bar. Files are at most 8 MB (413 payload_too_large otherwise).

GET/api/v1/sounds/:soundId/audiosounds:read
curl -s "$FORGECAST_URL/api/v1/sounds/dj-airhorn-sound-effect-kingbeatz_1/audio" \
  -H "Authorization: Bearer $FORGECAST_KEY" \
  -o airhorn.mp3

On this page