Download the PHP package hosmelq/falai without Composer
On this page you can find all versions of the php package hosmelq/falai. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hosmelq/falai
More information about hosmelq/falai
Files in hosmelq/falai
Informations about the package falai
falai-php
The fal.ai client for PHP.
Built on the Saloon PHP library with sse-saloon for Server-Sent Events support.
Features
- Queue-based processing - Submit requests to fal.ai's queue system for asynchronous processing.
- Synchronous execution - Direct model execution without queueing.
- Status streaming - Stream status updates using Server-Sent Events.
- Request cancellation - Cancel queued requests when needed.
Requirements
- PHP 8.2+
ext-sodium
(optional, required for webhook verification).- PSR-16 cache implementation (optional, for improved webhook verification performance).
Installation
Configuration
Set your fal.ai API key as an environment variable:
Or pass it directly to the client:
Basic Usage
Queue-based execution (recommended):
Synchronous execution:
Usage
Queue Operations
The recommended approach for most requests. The queue system provides better reliability, enables request cancellation, and handles longer-running tasks efficiently:
Submit Request
Submit a request to the queue for asynchronous processing:
Check Status
Check the current status of a queued request:
Get Results
Retrieve the final results from a completed request:
Stream Status Updates
Stream status updates using Server-Sent Events:
Cancel Request
Cancel queued requests before they start processing:
Webhooks
Configure webhooks to receive automatic notifications when your queued requests complete. This eliminates the need to poll for status updates and provides immediate notification of task completion.
Setting Up Webhooks
Include a webhook URL when submitting requests to the queue:
When the request completes, fal.ai will send a POST request to your webhook URL with the result data. See the webhook payload documentation for payload structure details.
Webhook Verification
For security, verify webhook signatures to ensure requests are authentic and originate from fal.ai. The verification process uses cryptographic signatures and timestamp validation:
Performance Optimization
For better performance with webhook verification, install a PSR-16 cache implementation:
This caches the public keys used for signature verification, reducing the number of HTTP requests to fal.ai.
Synchronous Execution
For direct execution without queueing, use the run()
method.
⚠️ Important: Queue-based processing is the recommended approach for most use cases as it provides better reliability and handling of longer-running requests.
⚠️ Critical: If the connection fails during synchronous requests, the result cannot be retrieved. See synchronous requests documentation for more details.
Error Handling
Handle API errors and exceptions that may occur during requests:
When streaming status updates:
Priority and Hints
Advanced configuration options for fine-tuning queue behavior. See the optimization documentation for detailed strategies:
Testing
Changelog
See CHANGELOG.md for a list of changes.
Credits
- Hosmel Quintana
- All Contributors
Built on:
License
The MIT License (MIT). Please see License File for more information.
All versions of falai with dependencies
hosmelq/sse-saloon Version ^0.1.0
saloonphp/saloon Version ^3.14
thecodingmachine/safe Version ^3.3