Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 3.2 KB

README.md

File metadata and controls

74 lines (49 loc) · 3.2 KB
Raw

The fal.ai Dart/Flutter client

fal_client pub.dev package Build License

About the Project

The fal_client is a robust and user-friendly library designed for seamless integration of fal model inference and training endpoints in Dart and Flutter projects. Developed in pure Dart, it provides developers with simple APIs to interact with AI models and works across all supported Flutter platforms.

Getting Started

The fal_client library serves as a client for fal APIs. For guidance on running out inference and training APIs, refer to the quickstart guide.

Client Library

This client library is crafted as a lightweight layer atop platform standards like http and cross_file. This ensures a hassle-free integration into your existing codebase. Moreover, it addresses platform disparities, guaranteeing flawless operation across various Flutter runtimes.

Note: Ensure you've reviewed the fal getting started guide to acquire your credentials and register your functions.

  1. Start by adding fal_client as a dependency:
flutter pub add fal_client
  1. Setup the client instance:
import 'package:fal_client/fal_client.dart';

final fal = FalClient.withCredentials('FAL_KEY');
  1. Now use fal.subscribe to dispatch requests to the model API:
final output = await fal.subscribe('fal-ai/flux/dev',
  input: {
    'prompt': 'a cute shih-tzu puppy'
  },
  onQueueUpdate: (update) => {print(update)}
);
print(output.data);
print(output.requestId);

Notes:

  • Replace fal-ai/flux/dev with the model of your preference. Check fal.ai/models for all available models.
  • The result type is a FalOutput.data and the entries depend on the API output schema.

Roadmap

See the open feature requests for a list of proposed features and join the discussion.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Make sure you read our Code of Conduct
  2. Fork the project and clone your fork
  3. Setup the local environment with npm install
  4. Create a feature branch (git checkout -b feature/add-cool-thing) or a bugfix branch (git checkout -b fix/smash-that-bug)
  5. Commit the changes (git commit -m 'feat(client): added a cool thing') - use conventional commits
  6. Push to the branch (git push --set-upstream origin feature/add-cool-thing)
  7. Open a Pull Request

Check the good first issue queue, your contribution will be welcome!

License

Distributed under the MIT License. See LICENSE for more information.