Introduction
fal provides official client libraries for multiple programming languages, offering a seamless interface to interact with our platform.Supported Languages
We officially support the following languages:JavaScript/TypeScript
Python
Swift (iOS)
Java
Kotlin
Dart (Flutter)
Don’t see your language?We are working on adding support for more languages. Reach out on our Discord Community and let us know which language you would like to see next.In the meantime, you can use the REST API directly.
Installation
First, add the client as a dependency in your project:Java Async SupportIf your code relies on asynchronous operations via
CompletableFuture or Future, you can use the ai.fal.client:fal-client-async artifact instead, which contains the necessary APIs for asynchronous programming.Features
1. Call an endpoint
Endpoints requests are managed by a queue system. This allows fal to provide a reliable and scalable service. Thesubscribe method allows you to submit a request to the queue and wait for the result.
2. Queue Management
You can manage the queue using the following methods:Submit a Request
Submit a request to the queue using thequeue.submit method.
request_id and use it to retrieve the result later.
WebhooksFor long-running requests, such as training jobs, you can use webhooks to receive the result asynchronously. You can specify the webhook URL when submitting a request.
Check Request Status
Retrieve the status of a specific request in the queue:Retrieve Request Result
Get the result of a specific request from the queue:3. File Uploads
Some endpoints require files as input. However, since the endpoints run asynchronously, processed by the queue, you will need to provide URLs to the files instead of the actual file content. Luckily, the client library provides a way to upload files to the server and get a URL to use in the request.4. Streaming
Some endpoints support streaming:5. Realtime Communication
For the endpoints that support real-time inference via WebSockets, you can use the realtime client that abstracts the WebSocket connection, re-connection, serialization, and provides a simple interface to interact with the endpoint:6. Run
The endpoints can also be called directly instead of using the queue system.Prefer the queueWe do not recommend this use most use cases as it will block the client
until the response is received. Moreover, if the connection is closed before
the response is received, the request will be lost.
API References
For a complete list of available methods and their parameters, please refer to the language-specific API Reference documentation:- JavaScript/TypeScript API Reference
- Python API Reference
- Swift (iOS) API Reference
- Java API Reference
- Kotlin API Reference
- Dart (Flutter) API Reference
Examples
Check out some of the examples below to see real-world use cases of the client libraries:- JavaScript: See
fal.realtimein action with SDXL Lightning: https://github.com/fal-ai/sdxl-lightning-demo-app - Dart (Flutter): Simple Flutter app using fal image inference: https://pub.dev/packages/fal_client/example
Migration Guide
JavaScript: Migrating from serverless-client to client
As fal no longer uses “serverless” as part of the AI provider branding, we also made sure that’s reflected in our libraries. However, that’s not the only thing that changed in the new client. There was lot’s of improvements that happened thanks to our community feedback.
So, if you were using the @fal-ai/serverless-client package, you can upgrade to the new @fal-ai/client package by following these steps:
1
Remove the
@fal-ai/serverless-client package from your project:2
Install the new
@fal-ai/client package:3
Update your imports:
4
Now APIs return a
Result<Output> type that contains the data which is the API output and the requestId. This is a breaking change from the previous version, that allows us to return extra data to the caller without future breaking changes.NoteThe
fal object is now a named export from the package that represents a singleton instance of the FalClient and was added to make it as easy as possible to migrate from the old singleton-only client. However, starting in 1.0.0 you can create multiple instances of the FalClient with the createFalClient function.Support
If you encounter any issues or have questions, please:- Visit the respective GitHub repositories:
- Join our Discord Community