# fal-ai/rife/video

## Video Interpolation

Interpolate videos with RIFE - Real-Time Intermediate Flow Estimation

### Table of contents

1. [Calling the API](#1-calling-the-api)
   - [Install the client](#install-the-client)
   - [Setup your API Key](#setup-your-api-key)
   - [Submit a request](#submit-a-request)
2. [Authentication](#2-authentication)
   - [API Key](#api-key)
3. [Queue](#3-queue)
   - [Submit a request](#submit-a-request-1)
   - [Fetch request status](#fetch-request-status)
   - [Get the result](#get-the-result)
4. [Files](#4-files)
   - [Data URI (base64)](#data-uri-base64)
   - [Hosted files (URL)](#hosted-files-url)
   - [Uploading files](#uploading-files)
5. [Schema](#5-schema)
   - [Input](#input)
   - [Output](#output)
   - [Other](#other-types)

### About

Interpolate between frames of a video using the RIFE model.

### 1. Calling the API

#### Install the client

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

```bash
npm install --save @fal-ai/client
```

#### Setup your API Key

Set `FAL_KEY` as an environment variable in your runtime.

```bash
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.

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

const result = await fal.subscribe("fal-ai/rife/video", {
  input: {
    video_url: "https://storage.googleapis.com/falserverless/example_inputs/interpolation-video-input.mp4"
  },
  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.

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

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

## 3. Queue

### Submit a request

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

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

const { request_id } = await fal.queue.submit("fal-ai/rife/video", {
  input: {
    video_url: "https://storage.googleapis.com/falserverless/example_inputs/interpolation-video-input.mp4"
  },
  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.

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

const status = await fal.queue.status("fal-ai/rife/video", {
  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](#output) for the expected result format.

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

const result = await fal.queue.result("fal-ai/rife/video", {
  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.

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

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

## 5. Schema

### Input

`video_url` **string** \* required  
The URL of the video to use for interpolation.

`num_frames` **integer**  
The number of frames to generate between the input video frames. Default value: `1`

`use_scene_detection` **boolean**  
If True, the input video will be split into scenes before interpolation.

`use_calculated_fps` **boolean**  
If True, the function will use the calculated FPS of the input video multiplied by the number of frames to determine the output FPS.

`fps` **integer**  
Frames per second for the output video. Only applicable if use_calculated_fps is False. Default value: `8`

`loop` **boolean**  
If True, the final frame will be looped back to the first frame to create a seamless loop.

```json
{
  "video_url": "https://storage.googleapis.com/falserverless/example_inputs/interpolation-video-input.mp4",
  "num_frames": 1,
  "use_calculated_fps": true,
  "fps": 8
}
```

### Output

`video` **File** \* required

```json
{
  "video": {
    "url": "https://storage.googleapis.com/falserverless/example_outputs/rife-video-output.mp4"
  }
}
```

### Other types

#### Image

`url` **string** \* required  
The URL where the file can be downloaded from.

`content_type` **string**  
The mime type of the file.

`file_name` **string**  
The name of the file. It will be auto-generated if not provided.

`file_size` **integer**  
The size of the file in bytes.

`width` **integer**  
The width of the image in pixels.

`height` **integer**  
The height of the image in pixels.

#### File

`url` **string** \* required  
The URL where the file can be downloaded from.

`content_type` **string**  
The mime type of the file.

`file_name` **string**  
The name of the file. It will be auto-generated if not provided.

`file_size` **integer**  
The size of the file in bytes.