FFmpeg API Waveform | JSON

fal-ai/ffmpeg-api/waveform

Get waveform data from audio files using FFmpeg API.

Inference

Commercial use

Schema

Playground API

About

Waveform

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/ffmpeg-api/waveform", {
  input: {
    media_url: ""
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.

import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

Protect your API Key

When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.

3. Queue#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("fal-ai/ffmpeg-api/waveform", {
  input: {
    media_url: ""
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("fal-ai/ffmpeg-api/waveform", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/ffmpeg-api/waveform", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Auto uploads

The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).

Read more about file handling in our file upload guide.

5. Schema#

Input#

media_url string* required

URL of the audio file to analyze

points_per_second float

Controls how many points are sampled per second of audio. Lower values (e.g. 1-2) create a coarser waveform, higher values (e.g. 4-10) create a more detailed one. Default value: 4

precision integer

Number of decimal places for the waveform values. Higher values provide more precision but increase payload size. Default value: 2

smoothing_window integer

Size of the smoothing window. Higher values create a smoother waveform. Must be an odd number. Default value: 3

{
  "media_url": "",
  "points_per_second": 4,
  "precision": 2,
  "smoothing_window": 3
}

Output#

waveform list<float>* required

Normalized waveform data as an array of values between -1 and 1. The number of points is determined by audio duration × points_per_second.

duration float* required

Duration of the audio in seconds

points integer* required

Number of points in the waveform data

precision integer* required

Number of decimal places used in the waveform values

{}

Other types#

AudioTrack#

codec string* required

Audio codec used (e.g., 'aac', 'mp3')

channels integer* required

Number of audio channels

sample_rate integer* required

Audio sample rate in Hz

bitrate integer* required

Audio bitrate in bits per second

Track#

id string* required

Unique identifier for the track

type string* required

Type of track ('video' or 'audio')

keyframes list<Keyframe>* required

List of keyframes that make up this track

Audio#

media_type MediaTypeEnum

Type of media (always 'audio') Default value: "audio"

Possible enum values: audio

url string* required

URL where the media file can be accessed

content_type string* required

MIME type of the media file

file_name string* required

Original filename of the media

file_size integer* required

Size of the file in bytes

duration float* required

Duration of the media in seconds

bitrate integer* required

Overall bitrate of the media in bits per second

codec string* required

Codec used to encode the media

container string* required

Container format of the media file (e.g., 'mp4', 'mov')

channels integer* required

Number of audio channels

sample_rate integer* required

Audio sample rate in Hz

Keyframe#

timestamp float* required

The timestamp in milliseconds where this keyframe starts

duration float* required

The duration in milliseconds of this keyframe

url string* required

The URL where this keyframe's media file can be accessed

Video#

media_type MediaTypeEnum

Type of media (always 'video') Default value: "video"

Possible enum values: video

url string* required

URL where the media file can be accessed

content_type string* required

MIME type of the media file

file_name string* required

Original filename of the media

file_size integer* required

Size of the file in bytes

duration float* required

Duration of the media in seconds

bitrate integer* required

Overall bitrate of the media in bits per second

codec string* required

Codec used to encode the media

container string* required

Container format of the media file (e.g., 'mp4', 'mov')

fps integer* required

Frames per second

frame_count integer* required

Total number of frames in the video

timebase string* required

Time base used for frame timestamps

resolution Resolution* required

Video resolution information

format VideoFormat* required

Detailed video format information

audio AudioTrack

Audio track information if video has audio

start_frame_url string

URL of the extracted first frame

end_frame_url string

URL of the extracted last frame

Resolution#

aspect_ratio string* required

Display aspect ratio (e.g., '16:9')

width integer* required

Width of the video in pixels

height integer* required

Height of the video in pixels

VideoFormat#

container string* required

Container format of the video

video_codec string* required

Video codec used (e.g., 'h264')

profile string* required

Codec profile (e.g., 'main', 'high')

level float* required

Codec level (e.g., 4.1)

pixel_format string* required

Pixel format used (e.g., 'yuv420p')

bitrate integer* required

Video bitrate in bits per second

FFmpeg API Waveform JSON

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

AudioTrack#

Track#

Audio#

Keyframe#

Video#

Resolution#

VideoFormat#