Audio
Details for the AUDIO link type
Type Value: AUDIO
Status: PRODUCTION
An AUDIO
link type represents a direct audio file accessible via a URL. In addition to the baseline preview fields (title
, description
, image
), AUDIO
links offer specialized metadata—such as track duration, format, bitrate, and optional tags like artist, album, and waveform data. This makes it easy to present listeners with rich audio details, improving discoverability and user engagement.
What It Includes
When type
is AUDIO
, the response includes an audio
object with fields like:
- duration: Total length of the audio in seconds.
- creationDate: When the audio file was created.
- format: The container/format (e.g.,
mp3
,wav
). - title, artist, album: If available, these fields help provide context, e.g., track listings, podcast episode titles, or album-based navigation.
- size: File size in bytes.
- bitRate, audioCodec, sampleRate, channels: Technical details useful for quality assessment, compatibility checks, or showing advanced stats to users.
- waveform: An array of normalized amplitude values, enabling waveform visualizations in your UI.
- albumArtwork: Responsive images representing the album cover or related imagery for a richer browsing experience.
With this data, you can easily display album covers, show track durations, generate waveforms, or filter by bitrates—enhancing the overall audio experience.
Example Request
Example Response
Special Notes
- Metadata-Driven Experiences: Title, artist, and album fields let you present audio files as songs, episodes, or audio clips with meaningful context rather than just raw files.
- Visual Enhancements: Use waveform data to create visual indicators of volume/intensity over time, or show album artwork for brand recognition.
- Quality Indicators: Bitrate and sampleRate let you surface quality metrics or adaptively choose which files to offer based on user preferences or bandwidth.
Schema reference
For a full technical breakdown of all fields and validation rules, including detailed JSON schemas, please refer to the API Reference.