HEheygen
Audio

Search audio (music or sound effects)

Changed on

Searches the music or sound-effects catalog by natural-language description (type=music by default, or sound_effects). Returns tracks ranked by similarity, each with a download URL, paginated by cursor.

get/v3/audio/sounds

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/audio/sounds
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

querystring required

Natural-language description of the audio you want, e.g. 'upbeat lofi hip-hop' or 'tense cinematic riser'. Results are ranked by semantic similarity to this text.

type'music' | 'sound_effects'

Audio content type to search: 'music' (background-music catalog) or 'sound_effects' (SFX catalog). Defaults to 'music'.

limitinteger

Maximum number of results to return (1-50).

min_scorenumber

Minimum semantic similarity score (0-1). Tracks scoring below this are omitted.

tokenstring

Opaque cursor token for the next page, taken from 'next_token' in a prior response.

Response

Successful response

has_moreboolean

Whether more pages are available

next_tokenstring nullable

Opaque cursor for the next page

Example response

{
  "data": [
    {
      "id": "rev_abc123",
      "name": "Upbeat Lofi Loop",
      "description": "Jazz, happy, jazzy, upbeat, rhythmic",
      "audio_url": "https://files.heygen.ai/audio/music_abc123.mp3",
      "duration": 120,
      "peak_offset": 0.37,
      "placement": "hit",
      "score": 0.83
    }
  ]
}

Changes