@fal-ai/client/src/client.d.ts

The fal.ai client for JavaScript and TypeScript

import { Config } from "./config";
import { QueueClient, QueueSubscribeOptions } from "./queue";
import { RealtimeClient } from "./realtime";
import { StorageClient } from "./storage";
import { StreamingClient } from "./streaming";
import { EndpointType, InputType, OutputType } from "./types/client";
import { Result, RunOptions } from "./types/common";
/**
 * The main client type, it provides access to simple API model usage,
 * as well as access to the `queue` and `storage` APIs.
 *
 * @see createFalClient
 */
export interface FalClient {
    /**
     * The queue client to interact with the queue API.
     */
    readonly queue: QueueClient;
    /**
     * The realtime client to interact with the realtime API
     * and receive updates in real-time.
     * @see #RealtimeClient
     * @see #RealtimeClient.connect
     */
    readonly realtime: RealtimeClient;
    /**
     * The storage client to interact with the storage API.
     */
    readonly storage: StorageClient;
    /**
     * The streaming client to interact with the streaming API.
     * @see #stream
     */
    readonly streaming: StreamingClient;
    /**
     * Runs a fal endpoint identified by its `endpointId`.
     *
     * @param endpointId The endpoint id, e.g. `fal-ai/fast-sdxl`.
     * @param options The request options, including the input payload.
     * @returns A promise that resolves to the result of the request once it's completed.
     *
     * @note
     * We **do not recommend** this use for 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. Instead, we recommend
     * using the `subscribe` method for most use cases.
     */
    run<Id extends EndpointType>(endpointId: Id, options: RunOptions<InputType<Id>>): Promise<Result<OutputType<Id>>>;
    /**
     * Subscribes to updates for a specific request in the queue.
     *
     * @param endpointId - The ID of the API endpoint.
     * @param options - Options to configure how the request is run and how updates are received.
     * @returns A promise that resolves to the result of the request once it's completed.
     */
    subscribe<Id extends EndpointType>(endpointId: Id, options: RunOptions<InputType<Id>> & QueueSubscribeOptions): Promise<Result<OutputType<Id>>>;
    /**
     * Calls a fal app that supports streaming and provides a streaming-capable
     * object as a result, that can be used to get partial results through either
     * `AsyncIterator` or through an event listener.
     *
     * @param endpointId the endpoint id, e.g. `fal-ai/llavav15-13b`.
     * @param options the request options, including the input payload.
     * @returns the `FalStream` instance.
     */
    stream: StreamingClient["stream"];
}
/**
 * Creates a new reference of the `FalClient`.
 * @param userConfig Optional configuration to override the default settings.
 * @returns a new instance of the `FalClient`.
 */
export declare function createFalClient(userConfig?: Config): FalClient;