Loading API documentation
Metadata
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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/metadata", {
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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_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.
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/metadata", {
input: {
media_url: ""
},
webhookUrl: "https://optional.webhook.url/for/results",
});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/metadata", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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/metadata", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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);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.
media_url string* requiredURL of the media file (video or audio) to analyze
extract_frames booleanWhether to extract the start and end frames for videos. Note that when true the request will be slower.
{
"media_url": ""
}{
"media": {
"media_type": "video",
"url": "",
"content_type": "",
"file_name": "",
"codec": "",
"container": "",
"timebase": "",
"resolution": {
"aspect_ratio": ""
},
"format": {
"container": "",
"video_codec": "",
"profile": "",
"pixel_format": ""
}
}
}media_type stringType of media (always 'video') Default value: "video"
url string* requiredURL where the media file can be accessed
content_type string* requiredMIME type of the media file
file_name string* requiredOriginal filename of the media
file_size integer* requiredSize of the file in bytes
duration float* requiredDuration of the media in seconds
bitrate integer* requiredOverall bitrate of the media in bits per second
codec string* requiredCodec used to encode the media
container string* requiredContainer format of the media file (e.g., 'mp4', 'mov')
fps integer* requiredFrames per second
frame_count integer* requiredTotal number of frames in the video
timebase string* requiredTime base used for frame timestamps
Video resolution information
Detailed video format information
Audio track information if video has audio
start_frame_url stringURL of the extracted first frame
end_frame_url stringURL of the extracted last frame
media_type stringType of media (always 'audio') Default value: "audio"
url string* requiredURL where the media file can be accessed
content_type string* requiredMIME type of the media file
file_name string* requiredOriginal filename of the media
file_size integer* requiredSize of the file in bytes
duration float* requiredDuration of the media in seconds
bitrate integer* requiredOverall bitrate of the media in bits per second
codec string* requiredCodec used to encode the media
container string* requiredContainer format of the media file (e.g., 'mp4', 'mov')
channels integer* requiredNumber of audio channels
sample_rate integer* requiredAudio sample rate in Hz
codec string* requiredAudio codec used (e.g., 'aac', 'mp3')
channels integer* requiredNumber of audio channels
sample_rate integer* requiredAudio sample rate in Hz
bitrate integer* requiredAudio bitrate in bits per second
container string* requiredContainer format of the video
video_codec string* requiredVideo codec used (e.g., 'h264')
profile string* requiredCodec profile (e.g., 'main', 'high')
level float* requiredCodec level (e.g., 4.1)
pixel_format string* requiredPixel format used (e.g., 'yuv420p')
bitrate integer* requiredVideo bitrate in bits per second
aspect_ratio string* requiredDisplay aspect ratio (e.g., '16:9')
width integer* requiredWidth of the video in pixels
height integer* requiredHeight of the video in pixels