Interface FalClient

The main client type, it provides access to simple API model usage, as well as access to the queue and storage APIs.

See

createFalClient

interface FalClient {
    queue: QueueClient;
    realtime: RealtimeClient;
    storage: StorageClient;
    stream: (<Output, Input>(endpointId: string, options: StreamOptions<Input>) => Promise<FalStream<Input, Output>>);
    streaming: StreamingClient;
    run<Output, Input>(endpointId: string, options: RunOptions<Input>): Promise<Result<Output>>;
    subscribe<Output, Input>(endpointId: string, options: RunOptions<Input> & QueueSubscribeOptions): Promise<Result<Output>>;
}

Properties

queue realtime storage stream streaming

Methods

run subscribe

Properties

Readonlyqueue

queue: QueueClient

The queue client to interact with the queue API.

Readonlyrealtime

realtime: RealtimeClient

The realtime client to interact with the realtime API and receive updates in real-time.

See

  • #RealtimeClient
  • #RealtimeClient.connect

Readonlystorage

storage: StorageClient

The storage client to interact with the storage API.

stream

stream: (<Output, Input>(endpointId: string, options: StreamOptions<Input>) => Promise<FalStream<Input, Output>>)

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.

Type declaration

    • <Output, Input>(endpointId, options): Promise<FalStream<Input, Output>>

    • 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.

      Type Parameters

      • Output = any
      • Input = Record<string, any>

      Parameters

      • endpointId: string

        the endpoint id, e.g. fal-ai/llavav15-13b.

      • options: StreamOptions<Input>

        the request options, including the input payload.

      Returns Promise<FalStream<Input, Output>>

      the FalStream instance.

Param: endpointId

the endpoint id, e.g. fal-ai/llavav15-13b.

Param: options

the request options, including the input payload.

Returns

the FalStream instance.

Readonlystreaming

streaming: StreamingClient

The streaming client to interact with the streaming API.

See

#stream

Methods

run

subscribe

  • subscribe<Output, Input>(endpointId, options): Promise<Result<Output>>

  • Subscribes to updates for a specific request in the queue.

    Type Parameters

    • Output = any
    • Input = Record<string, any>

    Parameters

    • endpointId: string

      The ID of the API endpoint.

    • options: RunOptions<Input> & QueueSubscribeOptions

      Options to configure how the request is run and how updates are received.

    Returns Promise<Result<Output>>

    A promise that resolves to the result of the request once it's completed.

Settings

Member Visibility

On This Page

Properties
Methods