PlayAI Inpaint | Audio to Audio

fal-ai/playai/inpaint/diffusion

A novel way to perform audio editing, ensuring smooth transitions and consistent speaker characteristics for edits.

Inference

Commercial use

Partner

Schema

Playground API

About

Edit existing speech by 'inpainting' only the words you want to change with PlayAI's voice inpainter.

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/playai/inpaint/diffusion", {
  input: {
    audio_url: "https://storage.googleapis.com/falserverless/model_tests/playai/matrix_neo.mp3",
    text: "The answer is out there Neo. It's looking for you.",
    output_text: "The answer is out there Morpheus. It's looking for you.",
    chunks: [{
      text: "The",
      timestamp: [0, 0.12]
    }, {
      text: "answer",
      timestamp: [0.12, 0.44]
    }, {
      text: "is",
      timestamp: [0.44, 0.66]
    }, {
      text: "out",
      timestamp: [0.66, 0.9]
    }, {
      text: "there",
      timestamp: [0.9, 1.12]
    }, {
      text: "Neo.",
      timestamp: [1.12, 1.7]
    }, {
      text: "It's",
      timestamp: [1.7, 3.38]
    }, {
      text: "looking",
      timestamp: [3.38, 3.6]
    }, {
      text: "for",
      timestamp: [3.6, 3.88]
    }, {
      text: "you.",
      timestamp: [3.88, 4.22]
    }]
  },
  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/playai/inpaint/diffusion", {
  input: {
    audio_url: "https://storage.googleapis.com/falserverless/model_tests/playai/matrix_neo.mp3",
    text: "The answer is out there Neo. It's looking for you.",
    output_text: "The answer is out there Morpheus. It's looking for you.",
    chunks: [{
      text: "The",
      timestamp: [0, 0.12]
    }, {
      text: "answer",
      timestamp: [0.12, 0.44]
    }, {
      text: "is",
      timestamp: [0.44, 0.66]
    }, {
      text: "out",
      timestamp: [0.66, 0.9]
    }, {
      text: "there",
      timestamp: [0.9, 1.12]
    }, {
      text: "Neo.",
      timestamp: [1.12, 1.7]
    }, {
      text: "It's",
      timestamp: [1.7, 3.38]
    }, {
      text: "looking",
      timestamp: [3.38, 3.6]
    }, {
      text: "for",
      timestamp: [3.6, 3.88]
    }, {
      text: "you.",
      timestamp: [3.88, 4.22]
    }]
  },
  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/playai/inpaint/diffusion", {
  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/playai/inpaint/diffusion", {
  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#

audio_url string* required

The URL of the audio file.

text string* required

Transcription of the input audio.

output_text string* required

Desired audio text. This is the text that will be spoken in the output audio. The model will find the difference between the input and output text and inpaint the audio accordingly.

chunks list<WordTime>* required

Word timestamps for the input audio. Each word is represented by an object containing the word text and its start/end timestamps. You can generate these timestamps using an ASR (Automatic Speech Recognition) on https://fal.ai/models/fal-ai/whisper.

response_format ResponseFormatEnum

The format of the response. Default value: "url"

Possible enum values: url, bytes

{
  "audio_url": "https://storage.googleapis.com/falserverless/model_tests/playai/matrix_neo.mp3",
  "text": "The answer is out there Neo. It's looking for you.",
  "output_text": "The answer is out there Morpheus. It's looking for you.",
  "chunks": [
    {
      "text": "The",
      "timestamp": [
        0,
        0.12
      ]
    },
    {
      "text": "answer",
      "timestamp": [
        0.12,
        0.44
      ]
    },
    {
      "text": "is",
      "timestamp": [
        0.44,
        0.66
      ]
    },
    {
      "text": "out",
      "timestamp": [
        0.66,
        0.9
      ]
    },
    {
      "text": "there",
      "timestamp": [
        0.9,
        1.12
      ]
    },
    {
      "text": "Neo.",
      "timestamp": [
        1.12,
        1.7
      ]
    },
    {
      "text": "It's",
      "timestamp": [
        1.7,
        3.38
      ]
    },
    {
      "text": "looking",
      "timestamp": [
        3.38,
        3.6
      ]
    },
    {
      "text": "for",
      "timestamp": [
        3.6,
        3.88
      ]
    },
    {
      "text": "you.",
      "timestamp": [
        3.88,
        4.22
      ]
    }
  ],
  "response_format": "url"
}

Output#

audio AudioFile* required

The generated audio file.

{
  "audio": {
    "file_size": 80685,
    "duration": 3.32,
    "file_name": "2e204365-6313-42c0-94c4-5ac11092672a.mp3",
    "content_type": "audio/mpeg",
    "url": "https://storage.googleapis.com/falserverless/model_tests/playai/diffusion-inpaint-output.mp3"
  }
}

Other types#

WordTime#

text string* required

The word to inpaint.

timestamp list<void>* required

The start and end timestamp of the word.

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.

file_data string

File data

AudioFile#

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.

file_data string

File data

duration float* required

The duration of the audio file in seconds.

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#

WordTime#

File#

AudioFile#

Related Models

PlayAI Inpaint Audio to Audio

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#

WordTime#

File#

AudioFile#

Related Models