Skip to main content

fal.ai Python client

This is a Python client library for interacting with ML models deployed on fal.ai.

Getting started

To install the client, run:

pip install fal-client

To use the client, you need to have an API key. You can get one by signing up at fal.ai. Once you have it, set it as an environment variable:

export FAL_KEY=your-api-key

Now you can use the client to interact with your models. Here's an example of how to use it:

import fal_client

response = fal_client.run("fal-ai/fast-sdxl", arguments={"prompt": "a cute cat, realistic, orange"})
print(response["images"][0]["url"])

Asynchronous requests

The client also supports asynchronous requests out of the box. Here's an example:

import asyncio
import fal_client

async def main():
    response = await fal_client.run_async("fal-ai/fast-sdxl", arguments={"prompt": "a cute cat, realistic, orange"})
    print(response["images"][0]["url"])


asyncio.run(main())

Uploading files

If the model requires files as input, you can upload them directly to fal's CDN and pass the URLs to the client. Here's an example:

import fal_client

audio_url = fal_client.upload_file("path/to/audio.wav")
response = fal_client.run("fal-ai/whisper", arguments={"audio_url": audio_url})
print(response["text"])

Encoding files as in-memory data URLs

If you don't want to upload your file to our CDN service (for latency reasons, for example), you can encode it as a data URL and pass it directly to the client. Here's an example:

import fal_client

audio_data_url = fal_client.encode_file("path/to/audio.wav")
response = fal_client.run("fal-ai/whisper", arguments={"audio_url": audio_data_url})
print(response["text"])

Queuing requests

When you want to send a request and keep receiving updates on its status, you can use the submit method. Here's an example:

import asyncio
import fal_client

async def main():
    response = await fal_client.submit_async("fal-ai/fast-sdxl", arguments={"prompt": "a cute cat, realistic, orange"})

    logs_index = 0
    async for event in response.iter_events(with_logs=True):
        if isinstance(event, fal_client.Queued):
            print("Queued. Position:", event.position)
        elif isinstance(event, (fal_client.InProgress, fal_client.Completed)):
            new_logs = event.logs[logs_index:]
            for log in new_logs:
                print(log["message"])
            logs_index = len(event.logs)

    result = await response.get()
    print(result["images"][0]["url"])


asyncio.run(main())

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fal_client-1.0.1.tar.gz (43.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fal_client-1.0.1-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

Details for the file fal_client-1.0.1.tar.gz.

File metadata

  • Download URL: fal_client-1.0.1.tar.gz
  • Upload date:
  • Size: 43.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for fal_client-1.0.1.tar.gz
Algorithm Hash digest
SHA256 46d1cee3426d0a2ad34f32b7dbfbdff83487c3dcf8aeae1aac2ffd5815e2055c
MD5 0f76ffade7bdf2831cdde8d94c704bd3
BLAKE2b-256 fd625b4c56b998b99b6fadb40f17fea7ba5aff83b5a047dee550d1980d1df968

See more details on using hashes here.

Provenance

The following attestation bundles were made for fal_client-1.0.1.tar.gz:

Publisher: release.yaml on fal-ai/fal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fal_client-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: fal_client-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 26.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for fal_client-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 57e900aabd45b03f788498195e4c562c79a37b06e3dd54371d81130496841ddb
MD5 6fc35d56ca180fbe50de091fca64c849
BLAKE2b-256 775d216ab130709f9dadf4554f09652e4634d5d04f1ce42a24e85b56d9707a35

See more details on using hashes here.

Provenance

The following attestation bundles were made for fal_client-1.0.1-py3-none-any.whl:

Publisher: release.yaml on fal-ai/fal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 files

1.0.0

2 files

0.14.1

2 files

0.14.0

2 files

0.13.2

2 files

0.13.1

2 files

0.13.0

2 files

0.12.0

2 files

0.11.0

2 files

0.10.0

2 files

0.9.1

2 files

0.9.0

2 files

0.8.1

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.9

2 files

0.5.8

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page