AudioFile

The AudioFile type represents an audio file. It includes the file’s metadata and any extracted information.

Schema

FieldTypeDescription
idstringUnique identifier
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp
sourceIdstringID of the data source
remoteIdstringID in original system
titlestringAudio file title
urlstringAudio file URL
pathstring[]File path
pathStringstringPath as string
mimeTypestringMIME type
originalNamestringOriginal filename
sizenumberFile size in bytes
durationnumberDuration in seconds
bitratenumberBitrate in bits/s
sampleRatenumberSample rate in Hz
channelsnumberNumber of channels
codecstringAudio codec
formatstringAudio format
transcriptionstringTranscribed text
propertiesobjectAdditional properties
tagsstring[]Audio file tags

Example Usage

// Get all audio files
const { data } = await unbody.get
  .audioFile
  .select("title", "url", "duration")
  .exec();
 
// Search audio files
const { data } = await unbody.get
  .audioFile
  .search.about("my search query")
  .exec();
 
// Filter audio files
const { data } = await unbody.get
  .audioFile
  .where({ format: "mp3" })
  .exec();

Next Steps

©2024 Unbody