diff --git a/docs/reference/classes/ApiError.html b/docs/reference/classes/ApiError.html index 78109c0..1051e25 100644 --- a/docs/reference/classes/ApiError.html +++ b/docs/reference/classes/ApiError.html @@ -1,4 +1,4 @@ -ApiError | @fal-ai/client

Class ApiError<Body>

Type Parameters

  • Body

Hierarchy (view full)

Constructors

constructor +ApiError | @fal-ai/client

Class ApiError<Body>

Type Parameters

  • Body

Hierarchy (view full)

Constructors

constructor

Properties

body status -

Constructors

constructor

Properties

Readonlybody

body: Body

Readonlystatus

status: number

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlybody

body: Body

Readonlystatus

status: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/reference/classes/FalStream.html b/docs/reference/classes/FalStream.html index da6aaaa..393032e 100644 --- a/docs/reference/classes/FalStream.html +++ b/docs/reference/classes/FalStream.html @@ -1,5 +1,5 @@ FalStream | @fal-ai/client

Class FalStream<Input, Output>

The class representing a streaming response. With t

-

Type Parameters

  • Input
  • Output

Constructors

constructor +

Type Parameters

  • Input
  • Output

Constructors

constructor

Properties

config endpointId options @@ -9,18 +9,18 @@ abort done on -

Constructors

constructor

Properties

config

config: Required<Config>

endpointId

endpointId: string

options

options: StreamOptions<Input>

url

url: string

Accessors

signal

  • get signal(): AbortSignal

  • Gets the AbortSignal instance that can be used to listen for abort events.

    +

Constructors

constructor

Properties

config

config: Required<Config>

endpointId

endpointId: string

options

options: StreamOptions<Input>

url

url: string

Accessors

signal

Methods

[asyncIterator]

abort

Methods

[asyncIterator]

abort

  • abort(reason?): void

  • Aborts the streaming request.

    Note: This method is noop in case the request is already done.

    Parameters

    • Optionalreason: string | Error

      optional cause for aborting the request.

      -

    Returns void

done

  • done(): Promise<Output>

  • Gets a reference to the Promise that indicates whether the streaming +

Returns void

done

on

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

on

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/reference/classes/ValidationError.html b/docs/reference/classes/ValidationError.html index 886a5f6..02e4575 100644 --- a/docs/reference/classes/ValidationError.html +++ b/docs/reference/classes/ValidationError.html @@ -1,6 +1,6 @@ -ValidationError | @fal-ai/client

Class ValidationError

Hierarchy (view full)

  • ApiError<ValidationErrorBody>
    • ValidationError

Constructors

constructor +ValidationError | @fal-ai/client

Class ValidationError

Hierarchy (view full)

  • ApiError<ValidationErrorBody>
    • ValidationError

Constructors

constructor

Properties

body status

Accessors

fieldErrors

Methods

getFieldErrors -

Constructors

constructor

Properties

Readonlybody

body: ValidationErrorBody

Readonlystatus

status: number

Accessors

fieldErrors

Methods

getFieldErrors

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Constructors

constructor

Properties

Readonlybody

body: ValidationErrorBody

Readonlystatus

status: number

Accessors

fieldErrors

Methods

getFieldErrors

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/reference/functions/createFalClient.html b/docs/reference/functions/createFalClient.html index f82a8d9..7bd1689 100644 --- a/docs/reference/functions/createFalClient.html +++ b/docs/reference/functions/createFalClient.html @@ -1,4 +1,4 @@ createFalClient | @fal-ai/client

Function createFalClient

  • createFalClient(userConfig?): FalClient

  • Creates a new reference of the FalClient.

    Parameters

    • userConfig: Config = {}

      Optional configuration to override the default settings.

    Returns FalClient

    a new instance of the FalClient.

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/reference/functions/isCompletedQueueStatus.html b/docs/reference/functions/isCompletedQueueStatus.html index b017fb4..3397a92 100644 --- a/docs/reference/functions/isCompletedQueueStatus.html +++ b/docs/reference/functions/isCompletedQueueStatus.html @@ -1 +1 @@ -isCompletedQueueStatus | @fal-ai/client

Function isCompletedQueueStatus

Settings

Member Visibility
+isCompletedQueueStatus | @fal-ai/client

Function isCompletedQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/functions/isQueueStatus.html b/docs/reference/functions/isQueueStatus.html index 14446b1..ad5311c 100644 --- a/docs/reference/functions/isQueueStatus.html +++ b/docs/reference/functions/isQueueStatus.html @@ -1 +1 @@ -isQueueStatus | @fal-ai/client

Function isQueueStatus

Settings

Member Visibility
+isQueueStatus | @fal-ai/client

Function isQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/functions/parseEndpointId.html b/docs/reference/functions/parseEndpointId.html index 45903b6..5a9a445 100644 --- a/docs/reference/functions/parseEndpointId.html +++ b/docs/reference/functions/parseEndpointId.html @@ -1 +1 @@ -parseEndpointId | @fal-ai/client

Function parseEndpointId

  • parseEndpointId(id): EndpointId

  • Parameters

    • id: string

    Returns EndpointId

Settings

Member Visibility
+parseEndpointId | @fal-ai/client

Function parseEndpointId

  • parseEndpointId(id): EndpointId

  • Parameters

    • id: string

    Returns EndpointId

Settings

Member Visibility
diff --git a/docs/reference/functions/withMiddleware.html b/docs/reference/functions/withMiddleware.html index bdb5588..6c4eb12 100644 --- a/docs/reference/functions/withMiddleware.html +++ b/docs/reference/functions/withMiddleware.html @@ -1,4 +1,4 @@ withMiddleware | @fal-ai/client

Function withMiddleware

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/reference/functions/withProxy.html b/docs/reference/functions/withProxy.html index 23068e1..dfef76d 100644 --- a/docs/reference/functions/withProxy.html +++ b/docs/reference/functions/withProxy.html @@ -1 +1 @@ -withProxy | @fal-ai/client

Function withProxy

Settings

Member Visibility
+withProxy | @fal-ai/client

Function withProxy

Settings

Member Visibility
diff --git a/docs/reference/interfaces/CompletedQueueStatus.html b/docs/reference/interfaces/CompletedQueueStatus.html index 591920d..ee118d8 100644 --- a/docs/reference/interfaces/CompletedQueueStatus.html +++ b/docs/reference/interfaces/CompletedQueueStatus.html @@ -1,6 +1,6 @@ -CompletedQueueStatus | @fal-ai/client

Interface CompletedQueueStatus

interface CompletedQueueStatus {
    logs: RequestLog[];
    metrics?: Metrics;
    request_id: string;
    response_url: string;
    status: "COMPLETED";
}

Hierarchy

  • BaseQueueStatus
    • CompletedQueueStatus

Properties

logs +CompletedQueueStatus | @fal-ai/client

Interface CompletedQueueStatus

interface CompletedQueueStatus {
    logs: RequestLog[];
    metrics?: Metrics;
    request_id: string;
    response_url: string;
    status: "COMPLETED";
}

Hierarchy

  • BaseQueueStatus
    • CompletedQueueStatus

Properties

logs metrics? request_id response_url status -

Properties

logs

logs: RequestLog[]

Optionalmetrics

metrics?: Metrics

request_id

request_id: string

response_url

response_url: string

status

status: "COMPLETED"

Settings

Member Visibility

On This Page

Properties
+

Properties

logs

logs: RequestLog[]

Optionalmetrics

metrics?: Metrics

request_id

request_id: string

response_url

response_url: string

status

status: "COMPLETED"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/FalClient.html b/docs/reference/interfaces/FalClient.html index 58461e3..cdf51fe 100644 --- a/docs/reference/interfaces/FalClient.html +++ b/docs/reference/interfaces/FalClient.html @@ -1,7 +1,7 @@ FalClient | @fal-ai/client

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: (<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>) => Promise<FalStream<InputType<Id>, OutputType<Id>>>);
    streaming: StreamingClient;
    run<Id>(endpointId: Id, options: RunOptions<InputType<Id>>): Promise<Result<OutputType<Id>>>;
    subscribe<Id>(endpointId: Id, options: RunOptions<InputType<Id>> & QueueSubscribeOptions): Promise<Result<OutputType<Id>>>;
}

Properties

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

Properties

queue realtime storage stream @@ -9,14 +9,14 @@

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 +

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: (<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>) => Promise<FalStream<InputType<Id>, OutputType<Id>>>)

Calls a fal app that supports streaming and provides a streaming-capable +

Readonlystorage

storage: StorageClient

The storage client to interact with the storage API.

+

stream

stream: (<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>) => Promise<FalStream<InputType<Id>, 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.

Type declaration

    • <Id>(endpointId, options): Promise<FalStream<InputType<Id>, OutputType<Id>>>

    • Calls a fal app that supports streaming and provides a streaming-capable @@ -28,13 +28,13 @@

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.

+

Readonlystreaming

streaming: StreamingClient

The streaming client to interact with the streaming API.

See

#stream

-

Methods

run

Methods

run

  • run<Id>(endpointId, options): Promise<Result<OutputType<Id>>>

  • Runs a fal endpoints identified by its endpointId.

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      the registered function revision id or alias.

    • options: RunOptions<InputType<Id>>

    Returns Promise<Result<OutputType<Id>>>

    the remote function output

    -

subscribe

  • subscribe<Id>(endpointId, options): Promise<Result<OutputType<Id>>>

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

    +

subscribe

  • subscribe<Id>(endpointId, options): Promise<Result<OutputType<Id>>>

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

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      The ID of the API endpoint.

    • options: RunOptions<InputType<Id>> & QueueSubscribeOptions

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

    Returns Promise<Result<OutputType<Id>>>

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

    -

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/reference/interfaces/InProgressQueueStatus.html b/docs/reference/interfaces/InProgressQueueStatus.html index 08af9bf..1f12010 100644 --- a/docs/reference/interfaces/InProgressQueueStatus.html +++ b/docs/reference/interfaces/InProgressQueueStatus.html @@ -1,5 +1,5 @@ -InProgressQueueStatus | @fal-ai/client

Interface InProgressQueueStatus

interface InProgressQueueStatus {
    logs: RequestLog[];
    request_id: string;
    response_url: string;
    status: "IN_PROGRESS";
}

Hierarchy

  • BaseQueueStatus
    • InProgressQueueStatus

Properties

logs +InProgressQueueStatus | @fal-ai/client

Interface InProgressQueueStatus

interface InProgressQueueStatus {
    logs: RequestLog[];
    request_id: string;
    response_url: string;
    status: "IN_PROGRESS";
}

Hierarchy

  • BaseQueueStatus
    • InProgressQueueStatus

Properties

logs request_id response_url status -

Properties

logs

logs: RequestLog[]

request_id

request_id: string

response_url

response_url: string

status

status: "IN_PROGRESS"

Settings

Member Visibility

On This Page

Properties
+

Properties

logs

logs: RequestLog[]

request_id

request_id: string

response_url

response_url: string

status

status: "IN_PROGRESS"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/InQueueQueueStatus.html b/docs/reference/interfaces/InQueueQueueStatus.html index 71562b7..1d18d6b 100644 --- a/docs/reference/interfaces/InQueueQueueStatus.html +++ b/docs/reference/interfaces/InQueueQueueStatus.html @@ -1,5 +1,5 @@ -InQueueQueueStatus | @fal-ai/client

Interface InQueueQueueStatus

interface InQueueQueueStatus {
    queue_position: number;
    request_id: string;
    response_url: string;
    status: "IN_QUEUE";
}

Hierarchy

  • BaseQueueStatus
    • InQueueQueueStatus

Properties

queue_position +InQueueQueueStatus | @fal-ai/client

Interface InQueueQueueStatus

interface InQueueQueueStatus {
    queue_position: number;
    request_id: string;
    response_url: string;
    status: "IN_QUEUE";
}

Hierarchy

  • BaseQueueStatus
    • InQueueQueueStatus

Properties

queue_position request_id response_url status -

Properties

queue_position

queue_position: number

request_id

request_id: string

response_url

response_url: string

status

status: "IN_QUEUE"

Settings

Member Visibility

On This Page

Properties
+

Properties

queue_position

queue_position: number

request_id

request_id: string

response_url

response_url: string

status

status: "IN_QUEUE"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/QueueClient.html b/docs/reference/interfaces/QueueClient.html index a30ed77..53360e1 100644 --- a/docs/reference/interfaces/QueueClient.html +++ b/docs/reference/interfaces/QueueClient.html @@ -1,6 +1,6 @@ QueueClient | @fal-ai/client

Interface QueueClient

Represents a request queue with methods for submitting requests, checking their status, retrieving results, and subscribing to updates.

-
interface QueueClient {
    cancel(endpointId: string, options: BaseQueueOptions): Promise<void>;
    result<Id>(endpointId: Id, options: BaseQueueOptions): Promise<Result<any>>;
    status(endpointId: string, options: QueueStatusOptions): Promise<QueueStatus>;
    streamStatus(endpointId: string, options: QueueStatusStreamOptions): Promise<FalStream<unknown, QueueStatus>>;
    submit<Id>(endpointId: Id, options: SubmitOptions<InputType<Id>>): Promise<InQueueQueueStatus>;
    subscribeToStatus(endpointId: string, options: QueueStatusSubscriptionOptions): Promise<CompletedQueueStatus>;
}

Methods

cancel +
interface QueueClient {
    cancel(endpointId: string, options: BaseQueueOptions): Promise<void>;
    result<Id>(endpointId: Id, options: BaseQueueOptions): Promise<Result<any>>;
    status(endpointId: string, options: QueueStatusOptions): Promise<QueueStatus>;
    streamStatus(endpointId: string, options: QueueStatusStreamOptions): Promise<FalStream<unknown, QueueStatus>>;
    submit<Id>(endpointId: Id, options: SubmitOptions<InputType<Id>>): Promise<InQueueQueueStatus>;
    subscribeToStatus(endpointId: string, options: QueueStatusSubscriptionOptions): Promise<CompletedQueueStatus>;
}

Methods

cancel result status streamStatus @@ -12,25 +12,25 @@ is run and how updates are received.

Returns Promise<void>

A promise that resolves once the request is cancelled.

Throws

If the request cannot be cancelled.

-

result

  • result<Id>(endpointId, options): Promise<Result<any>>

  • Retrieves the result of a specific request from the queue.

    +

result

  • result<Id>(endpointId, options): Promise<Result<any>>

  • Retrieves the result of a specific request from the queue.

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      The ID of the function web endpoint.

    • options: BaseQueueOptions

      Options to configure how the request is run.

    Returns Promise<Result<any>>

    A promise that resolves to the result of the request.

    -

status

status

  • status(endpointId, options): Promise<QueueStatus>

  • Retrieves the status of a specific request in the queue.

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: QueueStatusOptions

      Options to configure how the request is run.

    Returns Promise<QueueStatus>

    A promise that resolves to the status of the request.

    -

streamStatus

streamStatus

  • streamStatus(endpointId, options): Promise<FalStream<unknown, QueueStatus>>

  • Subscribes to updates for a specific request in the queue using HTTP streaming events.

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: QueueStatusStreamOptions

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

    Returns Promise<FalStream<unknown, QueueStatus>>

    The streaming object that can be used to listen for updates.

    -

submit

submit

  • submit<Id>(endpointId, options): Promise<InQueueQueueStatus>

  • Submits a request to the queue.

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      The ID of the function web endpoint.

    • options: SubmitOptions<InputType<Id>>

      Options to configure how the request is run.

    Returns Promise<InQueueQueueStatus>

    A promise that resolves to the result of enqueuing the request.

    -

subscribeToStatus

subscribeToStatus

  • subscribeToStatus(endpointId, options): Promise<CompletedQueueStatus>

  • Subscribes to updates for a specific request in the queue using polling or streaming. See options.mode for more details.

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: QueueStatusSubscriptionOptions

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

    Returns Promise<CompletedQueueStatus>

    A promise that resolves to the final status of the request.

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/interfaces/RealtimeClient.html b/docs/reference/interfaces/RealtimeClient.html index f34c463..cba8256 100644 --- a/docs/reference/interfaces/RealtimeClient.html +++ b/docs/reference/interfaces/RealtimeClient.html @@ -1,6 +1,6 @@ -RealtimeClient | @fal-ai/client

Interface RealtimeClient

interface RealtimeClient {
    connect<Input, Output>(app: string, handler: RealtimeConnectionHandler<Output>): RealtimeConnection<Input>;
}

Methods

connect +RealtimeClient | @fal-ai/client

Interface RealtimeClient

interface RealtimeClient {
    connect<Input, Output>(app: string, handler: RealtimeConnectionHandler<Output>): RealtimeConnection<Input>;
}

Methods

connect

Methods

connect

  • connect<Input, Output>(app, handler): RealtimeConnection<Input>

  • Connect to the realtime endpoint. The default implementation uses WebSockets to connect to fal function endpoints that support WSS.

    Type Parameters

    • Input = any
    • Output = any

    Parameters

    • app: string

      the app alias or identifier.

    • handler: RealtimeConnectionHandler<Output>

      the connection handler.

      -

    Returns RealtimeConnection<Input>

Settings

Member Visibility

On This Page

Methods
+

Returns RealtimeConnection<Input>

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/interfaces/StorageClient.html b/docs/reference/interfaces/StorageClient.html index 15644a9..8330181 100644 --- a/docs/reference/interfaces/StorageClient.html +++ b/docs/reference/interfaces/StorageClient.html @@ -1,14 +1,14 @@ StorageClient | @fal-ai/client

Interface StorageClient

File support for the client. This interface establishes the contract for uploading files to the server and transforming the input to replace file objects with URLs.

-
interface StorageClient {
    transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>);
    upload: ((file: Blob) => Promise<string>);
}

Properties

transformInput +
interface StorageClient {
    transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>);
    upload: ((file: Blob) => Promise<string>);
}

Properties

transformInput upload

Properties

transformInput

transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>)

Transform the input to replace file objects with URLs. This is used to transform the input before sending it to the server and ensures that the server receives URLs instead of file objects.

Type declaration

upload

upload: ((file: Blob) => Promise<string>)

Upload a file to the server. Returns the URL of the uploaded file.

+

upload

upload: ((file: Blob) => Promise<string>)

Upload a file to the server. Returns the URL of the uploaded file.

Type declaration

    • (file): Promise<string>

    • Parameters

      • file: Blob

        the file to upload

      Returns Promise<string>

      the URL of the uploaded file

      -

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/StreamingClient.html b/docs/reference/interfaces/StreamingClient.html index 5224458..6379152 100644 --- a/docs/reference/interfaces/StreamingClient.html +++ b/docs/reference/interfaces/StreamingClient.html @@ -1,9 +1,9 @@ StreamingClient | @fal-ai/client

Interface StreamingClient

The streaming client interface.

-
interface StreamingClient {
    stream<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>): Promise<FalStream<InputType<Id>, OutputType<Id>>>;
}

Methods

stream +
interface StreamingClient {
    stream<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>): Promise<FalStream<InputType<Id>, OutputType<Id>>>;
}

Methods

stream

Methods

stream

  • stream<Id>(endpointId, options): Promise<FalStream<InputType<Id>, 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.

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

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

    • options: StreamOptions<InputType<Id>>

      the request options, including the input payload.

    Returns Promise<FalStream<InputType<Id>, OutputType<Id>>>

    the FalStream instance.

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/types/Metrics.html b/docs/reference/types/Metrics.html index 760d0a3..0904bdd 100644 --- a/docs/reference/types/Metrics.html +++ b/docs/reference/types/Metrics.html @@ -1 +1 @@ -Metrics | @fal-ai/client

Type Alias Metrics

Metrics: {
    inference_time: number | null;
}

Settings

Member Visibility
+Metrics | @fal-ai/client

Type Alias Metrics

Metrics: {
    inference_time: number | null;
}

Settings

Member Visibility
diff --git a/docs/reference/types/QueueStatus.html b/docs/reference/types/QueueStatus.html index 462a163..9611d54 100644 --- a/docs/reference/types/QueueStatus.html +++ b/docs/reference/types/QueueStatus.html @@ -1 +1 @@ -QueueStatus | @fal-ai/client

Type Alias QueueStatus

QueueStatus: InProgressQueueStatus | CompletedQueueStatus | InQueueQueueStatus

Settings

Member Visibility
+QueueStatus | @fal-ai/client

Type Alias QueueStatus

QueueStatus: InProgressQueueStatus | CompletedQueueStatus | InQueueQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/types/RequestLog.html b/docs/reference/types/RequestLog.html index 6dcd2e9..f4cce36 100644 --- a/docs/reference/types/RequestLog.html +++ b/docs/reference/types/RequestLog.html @@ -1 +1 @@ -RequestLog | @fal-ai/client

Type Alias RequestLog

RequestLog: {
    level:
        | "STDERR"
        | "STDOUT"
        | "ERROR"
        | "INFO"
        | "WARN"
        | "DEBUG";
    message: string;
    source: "USER";
    timestamp: string;
}

Settings

Member Visibility
+RequestLog | @fal-ai/client

Type Alias RequestLog

RequestLog: {
    level:
        | "STDERR"
        | "STDOUT"
        | "ERROR"
        | "INFO"
        | "WARN"
        | "DEBUG";
    message: string;
    source: "USER";
    timestamp: string;
}

Settings

Member Visibility
diff --git a/docs/reference/types/RequestMiddleware.html b/docs/reference/types/RequestMiddleware.html index da157e0..3a38837 100644 --- a/docs/reference/types/RequestMiddleware.html +++ b/docs/reference/types/RequestMiddleware.html @@ -1 +1 @@ -RequestMiddleware | @fal-ai/client

Type Alias RequestMiddleware

RequestMiddleware: ((request: RequestConfig) => Promise<RequestConfig>)

Settings

Member Visibility
+RequestMiddleware | @fal-ai/client

Type Alias RequestMiddleware

RequestMiddleware: ((request: RequestConfig) => Promise<RequestConfig>)

Settings

Member Visibility
diff --git a/docs/reference/types/ResponseHandler.html b/docs/reference/types/ResponseHandler.html index 78595ab..9fb54c3 100644 --- a/docs/reference/types/ResponseHandler.html +++ b/docs/reference/types/ResponseHandler.html @@ -1 +1 @@ -ResponseHandler | @fal-ai/client

Type Alias ResponseHandler<Output>

ResponseHandler<Output>: ((response: Response) => Promise<Output>)

Type Parameters

  • Output

Settings

Member Visibility
+ResponseHandler | @fal-ai/client

Type Alias ResponseHandler<Output>

ResponseHandler<Output>: ((response: Response) => Promise<Output>)

Type Parameters

  • Output

Settings

Member Visibility
diff --git a/docs/reference/types/Result.html b/docs/reference/types/Result.html index 7427fd2..a31de81 100644 --- a/docs/reference/types/Result.html +++ b/docs/reference/types/Result.html @@ -1,3 +1,3 @@ Result | @fal-ai/client

Type Alias Result<T>

Result<T>: {
    data: T;
    requestId: string;
}

Represents an API result, containing the data, the request ID and any other relevant information.

-

Type Parameters

  • T

Settings

Member Visibility
+

Type Parameters

Settings

Member Visibility
diff --git a/docs/reference/types/RunOptions.html b/docs/reference/types/RunOptions.html index 1d63f94..2655e4e 100644 --- a/docs/reference/types/RunOptions.html +++ b/docs/reference/types/RunOptions.html @@ -4,4 +4,4 @@
  • Optional Readonlyinput?: Input

    The function input. It will be submitted either as query params or the body payload, depending on the method.

  • Optional Readonlymethod?:
        | "get"
        | "post"
        | "put"
        | "delete"
        | string

    The HTTP method, defaults to post;

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/reference/types/UrlOptions.html b/docs/reference/types/UrlOptions.html index b9b5901..027a173 100644 --- a/docs/reference/types/UrlOptions.html +++ b/docs/reference/types/UrlOptions.html @@ -3,4 +3,4 @@
  • Optional Readonlysubdomain?: string

    If true, the function will use the queue to run the function asynchronously and return the result in a separate call. This influences how the URL is built.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/reference/types/ValidationErrorInfo.html b/docs/reference/types/ValidationErrorInfo.html index 1103224..cf8e4b0 100644 --- a/docs/reference/types/ValidationErrorInfo.html +++ b/docs/reference/types/ValidationErrorInfo.html @@ -1 +1 @@ -ValidationErrorInfo | @fal-ai/client

    Type Alias ValidationErrorInfo

    ValidationErrorInfo: {
        loc: (string | number)[];
        msg: string;
        type: string;
    }

    Settings

    Member Visibility
    +ValidationErrorInfo | @fal-ai/client

    Type Alias ValidationErrorInfo

    ValidationErrorInfo: {
        loc: (string | number)[];
        msg: string;
        type: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/reference/types/WebHookResponse.html b/docs/reference/types/WebHookResponse.html index 29be8c6..ad94e07 100644 --- a/docs/reference/types/WebHookResponse.html +++ b/docs/reference/types/WebHookResponse.html @@ -10,4 +10,4 @@
  • payload: Payload

    The payload of the response, structure determined by the Payload type.

  • request_id: string

    The unique identifier for the request.

  • status: "ERROR"

    Indicates an unsuccessful response.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/reference/variables/fal.html b/docs/reference/variables/fal.html index 6dac02b..70829c9 100644 --- a/docs/reference/variables/fal.html +++ b/docs/reference/variables/fal.html @@ -1,3 +1,3 @@ fal | @fal-ai/client

    Variable falConst

    fal: SingletonFalClient = ...

    Creates a singleton instance of the client. This is useful as a compatibility layer for existing code that uses the clients version prior to 1.0.0.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/libs/client/package.json b/libs/client/package.json index 1818bcc..808ece7 100644 --- a/libs/client/package.json +++ b/libs/client/package.json @@ -1,7 +1,7 @@ { "name": "@fal-ai/client", "description": "The fal.ai client for JavaScript and TypeScript", - "version": "1.2.0", + "version": "1.2.1", "license": "MIT", "repository": { "type": "git", diff --git a/libs/client/src/types/endpoints.ts b/libs/client/src/types/endpoints.ts index b539fe1..a78567c 100644 --- a/libs/client/src/types/endpoints.ts +++ b/libs/client/src/types/endpoints.ts @@ -2702,6 +2702,32 @@ export type DwposeOutput = { */ image: Image; }; +export type EditImageInput = { + /** + * The prompt to fill the masked part of the image. + */ + prompt: string; + /** + * The image URL to generate an image from. Needs to match the dimensions of the mask. + */ + image_url: string | Blob | File; + /** + * The mask URL to inpaint the image. Needs to match the dimensions of the input image. + */ + mask_url: string | Blob | File; + /** + * Seed for the random number generator + */ + seed?: number; + /** + * The style of the generated image Default value: `"auto"` + */ + style?: "auto" | "general" | "realistic" | "design" | "render_3D" | "anime"; + /** + * Whether to expand the prompt with MagicPrompt functionality. Default value: `true` + */ + expand_prompt?: boolean; +}; export type Era3dInput = { /** * URL of the image to remove background from @@ -6347,6 +6373,10 @@ export type FluxLoraFillInput = { * The mask to area to Inpaint in. */ mask_url: string | Blob | File; + /** + * Specifies whether to paste-back the original image onto to the non-inpainted areas of the output Default value: `true` + */ + paste_back?: boolean; }; export type FluxLoraFillOutput = { /** @@ -7675,7 +7705,7 @@ export type FluxPulidOutput = { */ prompt: string; }; -export type FluxRealismInput = { +export type FluxSchnellInput = { /** * The prompt to generate an image from. */ @@ -7692,7 +7722,7 @@ export type FluxRealismInput = { | "landscape_4_3" | "landscape_16_9"; /** - * The number of inference steps to perform. Default value: `28` + * The number of inference steps to perform. Default value: `4` */ num_inference_steps?: number; /** @@ -7700,11 +7730,6 @@ export type FluxRealismInput = { * will output the same image every time. */ seed?: number; - /** - * The CFG (Classifier Free Guidance) scale is a measure of how close you want - * the model to stick to your prompt when looking for a related image to show you. Default value: `3.5` - */ - guidance_scale?: number; /** * If set to true, the function will wait for the image to be generated and uploaded * before returning the response. This will increase the latency of the function but @@ -7719,16 +7744,8 @@ export type FluxRealismInput = { * If set to true, the safety checker will be enabled. Default value: `true` */ enable_safety_checker?: boolean; - /** - * The strength of the model. Default value: `1` - */ - strength?: number; - /** - * The output image format. Default value: `"jpeg"` - */ - output_format?: "jpeg" | "png"; }; -export type FluxRealismOutput = { +export type FluxSchnellOutput = { /** * The generated image files info. */ @@ -7751,11 +7768,11 @@ export type FluxRealismOutput = { */ prompt: string; }; -export type FluxSchnellInput = { +export type FluxSchnellReduxInput = { /** - * The prompt to generate an image from. + * The URL of the image to generate an image from. */ - prompt: string; + image_url: string | Blob | File; /** * The size of the generated image. Default value: `landscape_4_3` */ @@ -7791,7 +7808,7 @@ export type FluxSchnellInput = { */ enable_safety_checker?: boolean; }; -export type FluxSchnellOutput = { +export type FluxSchnellReduxOutput = { /** * The generated image files info. */ @@ -7814,13 +7831,17 @@ export type FluxSchnellOutput = { */ prompt: string; }; -export type FluxSchnellReduxInput = { +export type FluxSubjectInput = { /** - * The URL of the image to generate an image from. + * The prompt to generate an image from. + */ + prompt: string; + /** + * URL of image of the subject */ image_url: string | Blob | File; /** - * The size of the generated image. Default value: `landscape_4_3` + * The size of the generated image. Default value: `square_hd` */ image_size?: | ImageSize @@ -7831,7 +7852,7 @@ export type FluxSchnellReduxInput = { | "landscape_4_3" | "landscape_16_9"; /** - * The number of inference steps to perform. Default value: `4` + * The number of inference steps to perform. Default value: `8` */ num_inference_steps?: number; /** @@ -7839,6 +7860,11 @@ export type FluxSchnellReduxInput = { * will output the same image every time. */ seed?: number; + /** + * The CFG (Classifier Free Guidance) scale is a measure of how close you want + * the model to stick to your prompt when looking for a related image to show you. Default value: `3.5` + */ + guidance_scale?: number; /** * If set to true, the function will wait for the image to be generated and uploaded * before returning the response. This will increase the latency of the function but @@ -7853,8 +7879,12 @@ export type FluxSchnellReduxInput = { * If set to true, the safety checker will be enabled. Default value: `true` */ enable_safety_checker?: boolean; + /** + * The format of the generated image. Default value: `"png"` + */ + output_format?: "jpeg" | "png"; }; -export type FluxSchnellReduxOutput = { +export type FluxSubjectOutput = { /** * The generated image files info. */ @@ -7889,7 +7919,7 @@ export type FooocusImagePromptInput = { */ negative_prompt?: string; /** - * The style to use. Default value: `Fooocus Enhance,Fooocus V2,Fooocus Sharp` + * The style to use. Default value: `Fooocus V2,Fooocus Enhance,Fooocus Sharp` */ styles?: Array< | "Fooocus V2" @@ -8314,7 +8344,7 @@ export type FooocusInpaintInput = { */ negative_prompt?: string; /** - * The style to use. Default value: `Fooocus Enhance,Fooocus V2,Fooocus Sharp` + * The style to use. Default value: `Fooocus V2,Fooocus Enhance,Fooocus Sharp` */ styles?: Array< | "Fooocus V2" @@ -8757,7 +8787,7 @@ export type FooocusInput = { */ negative_prompt?: string; /** - * The style to use. Default value: `Fooocus Enhance,Fooocus V2,Fooocus Sharp` + * The style to use. Default value: `Fooocus V2,Fooocus Enhance,Fooocus Sharp` */ styles?: Array< | "Fooocus V2" @@ -9137,7 +9167,7 @@ export type FooocusLegacyInput = { */ negative_prompt?: string; /** - * The style to use. Default value: `Fooocus Enhance,Fooocus V2,Fooocus Sharp` + * The style to use. Default value: `Fooocus V2,Fooocus Enhance,Fooocus Sharp` */ styles?: Array< | "Fooocus V2" @@ -9531,7 +9561,7 @@ export type FooocusUpscaleOrVaryInput = { */ negative_prompt?: string; /** - * The style to use. Default value: `Fooocus Enhance,Fooocus V2,Fooocus Sharp` + * The style to use. Default value: `Fooocus V2,Fooocus Enhance,Fooocus Sharp` */ styles?: Array< | "Fooocus V2" @@ -10011,6 +10041,86 @@ export type HEDOutput = { */ image: Image; }; +export type HunyuanVideoInput = { + /** + * The prompt to generate a video from. + */ + prompt: string; + /** + * The seed to use for generating the video. + */ + seed?: number; +}; +export type HunyuanVideoOutput = { + /** + * The generated video + */ + video: File; + /** + * The seed used for generating the video. + */ + seed: number; +}; +export type Hyper3dRodinInput = { + /** + * A textual prompt to guide model generation. Required for Text-to-3D mode. Optional for Image-to-3D mode. Default value: `""` + */ + prompt?: string; + /** + * URL of images to use while generating the 3D model. Required for Image-to-3D mode. Optional for Text-to-3D mode. + */ + input_image_urls?: Array; + /** + * For fuse mode, One or more images are required.It will generate a model by extracting and fusing features of objects from multiple images.For concat mode, need to upload multiple multi-view images of the same object and generate the model.(You can upload multi-view images in any order, regardless of the order of view.) Default value: `"concat"` + */ + condition_mode?: "fuse" | "concat"; + /** + * Seed value for randomization, ranging from 0 to 65535. Optional. + */ + seed?: number; + /** + * Format of the geometry file. Possible values: glb, usdz, fbx, obj, stl. Default is glb. Default value: `"glb"` + */ + geometry_file_format?: "glb" | "usdz" | "fbx" | "obj" | "stl"; + /** + * Material type. Possible values: PBR, Shaded. Default is PBR. Default value: `"PBR"` + */ + material?: "PBR" | "Shaded"; + /** + * Generation quality. Possible values: high, medium, low, extra-low. Default is medium. Default value: `"medium"` + */ + quality?: "high" | "medium" | "low" | "extra-low"; + /** + * Whether to export the model using hyper mode. Default is false. + */ + use_hyper?: boolean; + /** + * Tier of generation. For Rodin Sketch, set to Sketch. For Rodin Regular, set to Regular. Default value: `"Regular"` + */ + tier?: "Regular" | "Sketch"; + /** + * When generating the human-like model, this parameter control the generation result to T/A Pose. + */ + TAPose?: boolean; + /** + * An array that specifies the dimensions and scaling factor of the bounding box. Typically, this array contains 3 elements, Length(X-axis), Width(Y-axis) and Height(Z-axis). + */ + bbox_condition?: Array; + /** + * Generation add-on features. Default is []. Possible values are HighPack. The HighPack option will provide 4K resolution textures instead of the default 1K, as well as models with high-poly. It will cost triple the billable units. + */ + addons?: "HighPack"; +}; +export type Hyper3dRodinOutput = { + /** + * Generated 3D object file. + */ + model_mesh: File; + /** + * Seed value used for generation. + */ + seed: number; +}; export type HyperSdxlImageToImageInput = { /** * The URL of the image to use as a starting point for the generation. @@ -10322,7 +10432,7 @@ export type IclightV2Input = { */ num_images?: number; /** - * The number of images to generate. Default value: `1` + * The Default value: `1` */ cfg?: number; /** @@ -10339,7 +10449,7 @@ export type IclightV2Input = { hr_downscale?: number; /** * The CFG (Classifier Free Guidance) scale is a measure of how close you want - * the model to stick to your prompt when looking for a related image to show you. Default value: `3.5` + * the model to stick to your prompt when looking for a related image to show you. Default value: `5` */ guidance_scale?: number; /** @@ -10374,6 +10484,274 @@ export type IclightV2Output = { */ prompt: string; }; +export type IdeogramV2EditInput = { + /** + * The prompt to fill the masked part of the image. + */ + prompt: string; + /** + * The image URL to generate an image from. Needs to match the dimensions of the mask. + */ + image_url: string | Blob | File; + /** + * The mask URL to inpaint the image. Needs to match the dimensions of the input image. + */ + mask_url: string | Blob | File; + /** + * Seed for the random number generator + */ + seed?: number; + /** + * The style of the generated image Default value: `"auto"` + */ + style?: "auto" | "general" | "realistic" | "design" | "render_3D" | "anime"; + /** + * Whether to expand the prompt with MagicPrompt functionality. Default value: `true` + */ + expand_prompt?: boolean; +}; +export type IdeogramV2EditOutput = { + /** + * + */ + images: Array; + /** + * Seed used for the random number generator + */ + seed: number; +}; +export type IdeogramV2Input = { + /** + * + */ + prompt: string; + /** + * The aspect ratio of the generated image Default value: `"1:1"` + */ + aspect_ratio?: + | "10:16" + | "16:10" + | "9:16" + | "16:9" + | "4:3" + | "3:4" + | "1:1" + | "1:3" + | "3:1" + | "3:2" + | "2:3"; + /** + * Whether to expand the prompt with MagicPrompt functionality. Default value: `true` + */ + expand_prompt?: boolean; + /** + * Seed for the random number generator + */ + seed?: number; + /** + * The style of the generated image Default value: `"auto"` + */ + style?: "auto" | "general" | "realistic" | "design" | "render_3D" | "anime"; + /** + * A negative prompt to avoid in the generated image Default value: `""` + */ + negative_prompt?: string; +}; +export type IdeogramV2Output = { + /** + * + */ + images: Array; + /** + * Seed used for the random number generator + */ + seed: number; +}; +export type IdeogramV2RemixInput = { + /** + * The prompt to remix the image with + */ + prompt: string; + /** + * The image URL to remix + */ + image_url: string | Blob | File; + /** + * The aspect ratio of the generated image Default value: `"1:1"` + */ + aspect_ratio?: + | "10:16" + | "16:10" + | "9:16" + | "16:9" + | "4:3" + | "3:4" + | "1:1" + | "1:3" + | "3:1" + | "3:2" + | "2:3"; + /** + * Strength of the input image in the remix Default value: `0.8` + */ + strength?: number; + /** + * Whether to expand the prompt with MagicPrompt functionality. Default value: `true` + */ + expand_prompt?: boolean; + /** + * Seed for the random number generator + */ + seed?: number; + /** + * The style of the generated image Default value: `"auto"` + */ + style?: "auto" | "general" | "realistic" | "design" | "render_3D" | "anime"; +}; +export type IdeogramV2RemixOutput = { + /** + * + */ + images: Array; + /** + * Seed used for the random number generator + */ + seed: number; +}; +export type IdeogramV2TurboEditInput = { + /** + * The prompt to fill the masked part of the image. + */ + prompt: string; + /** + * The image URL to generate an image from. Needs to match the dimensions of the mask. + */ + image_url: string | Blob | File; + /** + * The mask URL to inpaint the image. Needs to match the dimensions of the input image. + */ + mask_url: string | Blob | File; + /** + * Seed for the random number generator + */ + seed?: number; + /** + * The style of the generated image Default value: `"auto"` + */ + style?: "auto" | "general" | "realistic" | "design" | "render_3D" | "anime"; + /** + * Whether to expand the prompt with MagicPrompt functionality. Default value: `true` + */ + expand_prompt?: boolean; +}; +export type IdeogramV2TurboEditOutput = { + /** + * + */ + images: Array; + /** + * Seed used for the random number generator + */ + seed: number; +}; +export type IdeogramV2TurboInput = { + /** + * + */ + prompt: string; + /** + * The aspect ratio of the generated image Default value: `"1:1"` + */ + aspect_ratio?: + | "10:16" + | "16:10" + | "9:16" + | "16:9" + | "4:3" + | "3:4" + | "1:1" + | "1:3" + | "3:1" + | "3:2" + | "2:3"; + /** + * Whether to expand the prompt with MagicPrompt functionality. Default value: `true` + */ + expand_prompt?: boolean; + /** + * Seed for the random number generator + */ + seed?: number; + /** + * The style of the generated image Default value: `"auto"` + */ + style?: "auto" | "general" | "realistic" | "design" | "render_3D" | "anime"; + /** + * A negative prompt to avoid in the generated image Default value: `""` + */ + negative_prompt?: string; +}; +export type IdeogramV2TurboOutput = { + /** + * + */ + images: Array; + /** + * Seed used for the random number generator + */ + seed: number; +}; +export type IdeogramV2TurboRemixInput = { + /** + * The prompt to remix the image with + */ + prompt: string; + /** + * The image URL to remix + */ + image_url: string | Blob | File; + /** + * The aspect ratio of the generated image Default value: `"1:1"` + */ + aspect_ratio?: + | "10:16" + | "16:10" + | "9:16" + | "16:9" + | "4:3" + | "3:4" + | "1:1" + | "1:3" + | "3:1" + | "3:2" + | "2:3"; + /** + * Strength of the input image in the remix Default value: `0.8` + */ + strength?: number; + /** + * Whether to expand the prompt with MagicPrompt functionality. Default value: `true` + */ + expand_prompt?: boolean; + /** + * Seed for the random number generator + */ + seed?: number; + /** + * The style of the generated image Default value: `"auto"` + */ + style?: "auto" | "general" | "realistic" | "design" | "render_3D" | "anime"; +}; +export type IdeogramV2TurboRemixOutput = { + /** + * + */ + images: Array; + /** + * Seed used for the random number generator + */ + seed: number; +}; export type IllusionDiffusionInput = { /** * Input image url. @@ -14910,6 +15288,38 @@ export type LumaDreamMachineOutput = { */ video: File; }; +export type LumaPhotonFlashInput = { + /** + * + */ + prompt: string; + /** + * The aspect ratio of the generated video Default value: `"1:1"` + */ + aspect_ratio?: "16:9" | "9:16" | "1:1" | "4:3" | "3:4" | "21:9" | "9:21"; +}; +export type LumaPhotonFlashOutput = { + /** + * The generated image + */ + images: Array; +}; +export type LumaPhotonInput = { + /** + * + */ + prompt: string; + /** + * The aspect ratio of the generated video Default value: `"1:1"` + */ + aspect_ratio?: "16:9" | "9:16" | "1:1" | "4:3" | "3:4" | "21:9" | "9:21"; +}; +export type LumaPhotonOutput = { + /** + * The generated image + */ + images: Array; +}; export type MarigoldDepthMapInput = { /** * Input image url. @@ -16283,7 +16693,7 @@ export type RecraftV3Input = { /** * The ID of the custom style reference (optional) */ - style_id?: string | null; + style_id?: string; }; export type RecraftV3Output = { /** @@ -16327,6 +16737,47 @@ export type RemeshingInput = { */ preserve_uvs?: boolean; }; +export type RemixImageInput = { + /** + * The prompt to remix the image with + */ + prompt: string; + /** + * The image URL to remix + */ + image_url: string | Blob | File; + /** + * The aspect ratio of the generated image Default value: `"1:1"` + */ + aspect_ratio?: + | "10:16" + | "16:10" + | "9:16" + | "16:9" + | "4:3" + | "3:4" + | "1:1" + | "1:3" + | "3:1" + | "3:2" + | "2:3"; + /** + * Strength of the input image in the remix Default value: `0.8` + */ + strength?: number; + /** + * Whether to expand the prompt with MagicPrompt functionality. Default value: `true` + */ + expand_prompt?: boolean; + /** + * Seed for the random number generator + */ + seed?: number; + /** + * The style of the generated image Default value: `"auto"` + */ + style?: "auto" | "general" | "realistic" | "design" | "render_3D" | "anime"; +}; export type RemoveBackgroundInput = { /** * Input image url. @@ -16702,6 +17153,16 @@ export type Sam2ImageInput = { * Coordinates for boxes Default value: `` */ box_prompts?: Array; + /** + * If set to true, the function will wait for the image to be generated and uploaded + * before returning the response. This will increase the latency of the function but + * it allows you to get the image directly in the response without going through the CDN. + */ + sync_mode?: boolean; + /** + * The format of the generated image. Default value: `"png"` + */ + output_format?: "jpeg" | "png"; }; export type SAM2ImageInput = { /** @@ -16716,6 +17177,16 @@ export type SAM2ImageInput = { * Coordinates for boxes Default value: `` */ box_prompts?: Array; + /** + * If set to true, the function will wait for the image to be generated and uploaded + * before returning the response. This will increase the latency of the function but + * it allows you to get the image directly in the response without going through the CDN. + */ + sync_mode?: boolean; + /** + * The format of the generated image. Default value: `"png"` + */ + output_format?: "jpeg" | "png"; }; export type Sam2ImageOutput = { /** @@ -16805,6 +17276,84 @@ export type SamOutput = { */ image: Image; }; +export type SanaInput = { + /** + * The prompt to generate an image from. + */ + prompt: string; + /** + * The negative prompt to use. Use it to address details that you don't want + * in the image. This could be colors, objects, scenery and even the small details + * (e.g. moustache, blurry, low resolution). Default value: `""` + */ + negative_prompt?: string; + /** + * The size of the generated image. Default value: `[object Object]` + */ + image_size?: + | ImageSize + | "square_hd" + | "square" + | "portrait_4_3" + | "portrait_16_9" + | "landscape_4_3" + | "landscape_16_9"; + /** + * The number of inference steps to perform. Default value: `18` + */ + num_inference_steps?: number; + /** + * The same seed and the same prompt given to the same version of the model + * will output the same image every time. + */ + seed?: number; + /** + * The CFG (Classifier Free Guidance) scale is a measure of how close you want + * the model to stick to your prompt when looking for a related image to show you. Default value: `5` + */ + guidance_scale?: number; + /** + * If set to true, the function will wait for the image to be generated and uploaded + * before returning the response. This will increase the latency of the function but + * it allows you to get the image directly in the response without going through the CDN. + */ + sync_mode?: boolean; + /** + * The number of images to generate. Default value: `1` + */ + num_images?: number; + /** + * If set to true, the safety checker will be enabled. Default value: `true` + */ + enable_safety_checker?: boolean; + /** + * The format of the generated image. Default value: `"png"` + */ + output_format?: "jpeg" | "png"; +}; +export type SanaOutput = { + /** + * The generated image files info. + */ + images: Array; + /** + * + */ + timings: any; + /** + * Seed of the generated Image. It will be the same value of the one passed in the + * input or the randomly generated that was used in case none was passed. + */ + seed: number; + /** + * Whether the generated images contain NSFW concepts. + */ + has_nsfw_concepts: Array; + /** + * The prompt used for generating the image. + */ + prompt: string; +}; export type SchnellReduxInput = { /** * The URL of the image to generate an image from. @@ -17849,17 +18398,6 @@ export type StableDiffusionV35LargeInput = { * (e.g. moustache, blurry, low resolution). Default value: `""` */ negative_prompt?: string; - /** - * The size of the generated image. Default value: `landscape_4_3` - */ - image_size?: - | ImageSize - | "square_hd" - | "square" - | "portrait_4_3" - | "portrait_16_9" - | "landscape_4_3" - | "landscape_16_9"; /** * The number of inference steps to perform. Default value: `28` */ @@ -17892,6 +18430,30 @@ export type StableDiffusionV35LargeInput = { * The format of the generated image. Default value: `"jpeg"` */ output_format?: "jpeg" | "png"; + /** + * ControlNet for inference. + */ + controlnet?: ControlNet; + /** + * The size of the generated image. Defaults to landscape_4_3 if no controlnet has been passed, otherwise defaults to the size of the controlnet conditioning image. + */ + image_size?: + | ImageSize + | "square_hd" + | "square" + | "portrait_4_3" + | "portrait_16_9" + | "landscape_4_3" + | "landscape_16_9"; + /** + * The LoRAs to use for the image generation. You can use any number of LoRAs + * and they will be merged together to generate the final image. Default value: `` + */ + loras?: Array; + /** + * IP-Adapter to use during inference. + */ + ip_adapter?: IPAdapter; }; export type StableDiffusionV35LargeOutput = { /** @@ -19753,6 +20315,10 @@ export type EndpointTypeMap = { input: MinimaxVideoImageToVideoInput; output: MinimaxVideoImageToVideoOutput; }; + "fal-ai/hyper3d/rodin": { + input: Hyper3dRodinInput; + output: Hyper3dRodinOutput; + }; "fal-ai/aura-flow": { input: AuraFlowInput; output: AuraFlowOutput; @@ -19777,6 +20343,10 @@ export type EndpointTypeMap = { input: FluxSchnellInput; output: FluxSchnellOutput; }; + "fal-ai/flux-subject": { + input: FluxSubjectInput; + output: FluxSubjectOutput; + }; "fal-ai/flux/schnell/redux": { input: FluxSchnellReduxInput; output: FluxSchnellReduxOutput; @@ -19825,6 +20395,10 @@ export type EndpointTypeMap = { input: FluxProNewInput; output: FluxProNewOutput; }; + "fal-ai/sana": { + input: SanaInput; + output: SanaOutput; + }; "fal-ai/omnigen-v1": { input: OmnigenV1Input; output: OmnigenV1Output; @@ -19841,9 +20415,29 @@ export type EndpointTypeMap = { input: RecraftV3CreateStyleInput; output: RecraftV3CreateStyleOutput; }; - "fal-ai/flux-realism": { - input: FluxRealismInput; - output: FluxRealismOutput; + "fal-ai/ideogram/v2": { + input: IdeogramV2Input; + output: IdeogramV2Output; + }; + "fal-ai/ideogram/v2/edit": { + input: IdeogramV2EditInput; + output: IdeogramV2EditOutput; + }; + "fal-ai/ideogram/v2/remix": { + input: IdeogramV2RemixInput; + output: IdeogramV2RemixOutput; + }; + "fal-ai/ideogram/v2/turbo": { + input: IdeogramV2TurboInput; + output: IdeogramV2TurboOutput; + }; + "fal-ai/ideogram/v2/turbo/edit": { + input: IdeogramV2TurboEditInput; + output: IdeogramV2TurboEditOutput; + }; + "fal-ai/ideogram/v2/turbo/remix": { + input: IdeogramV2TurboRemixInput; + output: IdeogramV2TurboRemixOutput; }; "fal-ai/flux-lora-fill": { input: FluxLoraFillInput; @@ -19925,6 +20519,10 @@ export type EndpointTypeMap = { input: MochiV1Input; output: MochiV1Output; }; + "fal-ai/hunyuan-video": { + input: HunyuanVideoInput; + output: HunyuanVideoOutput; + }; "fal-ai/luma-dream-machine": { input: LumaDreamMachineInput; output: LumaDreamMachineOutput; @@ -19933,6 +20531,14 @@ export type EndpointTypeMap = { input: LumaDreamMachineImageToVideoInput; output: LumaDreamMachineImageToVideoOutput; }; + "fal-ai/luma-photon": { + input: LumaPhotonInput; + output: LumaPhotonOutput; + }; + "fal-ai/luma-photon/flash": { + input: LumaPhotonFlashInput; + output: LumaPhotonFlashOutput; + }; "fal-ai/kling-video/v1/standard/text-to-video": { input: KlingVideoV1StandardTextToVideoInput; output: KlingVideoV1StandardTextToVideoOutput;