IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

FirebaseAI

class FirebaseAI

Entry point for all Firebase AI functionality.

Summary

Public companion functions
`FirebaseAI`	`getInstance(app: FirebaseApp)` The `FirebaseAI` instance for the provided `FirebaseApp` using the Google AI Backend.
`FirebaseAI`	`getInstance(app: FirebaseApp, backend: GenerativeBackend)` Returns the `FirebaseAI` instance for the provided `FirebaseApp` and `backend`.
`FirebaseAI`	`getInstance( app: FirebaseApp, backend: GenerativeBackend, useLimitedUseAppCheckTokens: Boolean )` Returns the `FirebaseAI` instance for the provided `FirebaseApp` and `backend`.

Public companion properties
`FirebaseAI`	`instance` The `FirebaseAI` instance for the default `FirebaseApp` using the Google AI Backend.

Public functions
`GenerativeModel`	`generativeModel( modelName: String, generationConfig: GenerationConfig?, safetySettings: List<SafetySetting>?, tools: List<Tool>?, toolConfig: ToolConfig?, systemInstruction: Content?, requestOptions: RequestOptions )` Instantiates a new `GenerativeModel` given the provided parameters.
`ImagenModel`	`imagenModel( modelName: String, generationConfig: ImagenGenerationConfig?, safetySettings: ImagenSafetySettings?, requestOptions: RequestOptions )` Instantiates a new `ImagenModel` given the provided parameters.
`LiveGenerativeModel`	`@PublicPreviewAPI liveModel( modelName: String, generationConfig: LiveGenerationConfig?, tools: List<Tool>?, systemInstruction: Content?, requestOptions: RequestOptions )` Instantiates a new `LiveGenerationConfig` given the provided parameters.
`TemplateGenerativeModel`	`@PublicPreviewAPI templateGenerativeModel(requestOptions: RequestOptions)` Instantiates a new `TemplateGenerativeModel` given the provided parameters.
`TemplateImagenModel`	`@PublicPreviewAPI templateImagenModel(requestOptions: RequestOptions)` Instantiates a new `TemplateImagenModel` given the provided parameters.

Public companion functions

getInstance

fun getInstance(app: FirebaseApp): FirebaseAI

The FirebaseAI instance for the provided FirebaseApp using the Google AI Backend.

getInstance

fun getInstance(app: FirebaseApp = Firebase.app, backend: GenerativeBackend): FirebaseAI

Returns the FirebaseAI instance for the provided FirebaseApp and backend.

Parameters
`backend: GenerativeBackend`	the backend reference to make generative AI requests to.

getInstance

fun getInstance(
    app: FirebaseApp = Firebase.app,
    backend: GenerativeBackend,
    useLimitedUseAppCheckTokens: Boolean
): FirebaseAI

Returns the FirebaseAI instance for the provided FirebaseApp and backend.

Parameters

backend: GenerativeBackend

the backend reference to make generative AI requests to.

useLimitedUseAppCheckTokens: Boolean

when sending tokens to the backend, this option enables the usage of App Check's limited-use tokens instead of the standard cached tokens. Learn more about limited-use tokens, including their nuances, when to use them, and best practices for integrating them into your app.

This flag is set to false by default.

Public companion properties

instance

val instance: FirebaseAI

The FirebaseAI instance for the default FirebaseApp using the Google AI Backend.

Public functions

generativeModel

fun generativeModel(
    modelName: String,
    generationConfig: GenerationConfig? = null,
    safetySettings: List<SafetySetting>? = null,
    tools: List<Tool>? = null,
    toolConfig: ToolConfig? = null,
    systemInstruction: Content? = null,
    requestOptions: RequestOptions = RequestOptions()
): GenerativeModel

Instantiates a new GenerativeModel given the provided parameters.

Parameters
`modelName: String`	The name of the model to use. See the documentation for a list of supported models.
`generationConfig: GenerationConfig? = null`	The configuration parameters to use for content generation.
`safetySettings: List<SafetySetting>? = null`	The safety bounds the model will abide to during content generation.
`tools: List<Tool>? = null`	A list of `Tool`s the model may use to generate content.
`toolConfig: ToolConfig? = null`	The `ToolConfig` that defines how the model handles the tools provided.
`systemInstruction: Content? = null`	`Content` instructions that direct the model to behave a certain way. Currently only text content is supported.
`requestOptions: RequestOptions = RequestOptions()`	Configuration options for sending requests to the backend.

Returns
`GenerativeModel`	The initialized `GenerativeModel` instance.

imagenModel

fun imagenModel(
    modelName: String,
    generationConfig: ImagenGenerationConfig? = null,
    safetySettings: ImagenSafetySettings? = null,
    requestOptions: RequestOptions = RequestOptions()
): ImagenModel

Instantiates a new ImagenModel given the provided parameters.

Parameters
`modelName: String`	The name of the model to use. See the documentation for a list of supported models.
`generationConfig: ImagenGenerationConfig? = null`	The configuration parameters to use for image generation.
`safetySettings: ImagenSafetySettings? = null`	The safety bounds the model will abide by during image generation.
`requestOptions: RequestOptions = RequestOptions()`	Configuration options for sending requests to the backend.

Returns
`ImagenModel`	The initialized `ImagenModel` instance.

liveModel

@PublicPreviewAPI
fun liveModel(
    modelName: String,
    generationConfig: LiveGenerationConfig? = null,
    tools: List<Tool>? = null,
    systemInstruction: Content? = null,
    requestOptions: RequestOptions = RequestOptions()
): LiveGenerativeModel

Instantiates a new LiveGenerationConfig given the provided parameters.

Parameters
`modelName: String`	The name of the model to use. See the documentation for a list of supported models.
`generationConfig: LiveGenerationConfig? = null`	The configuration parameters to use for content generation.
`tools: List<Tool>? = null`	A list of `Tool`s the model may use to generate content.
`systemInstruction: Content? = null`	`Content` instructions that direct the model to behave a certain way. Currently only text content is supported.
`requestOptions: RequestOptions = RequestOptions()`	Configuration options for sending requests to the backend.

Returns
`LiveGenerativeModel`	The initialized `LiveGenerativeModel` instance.

templateGenerativeModel

@PublicPreviewAPI
fun templateGenerativeModel(requestOptions: RequestOptions = RequestOptions()): TemplateGenerativeModel

Instantiates a new TemplateGenerativeModel given the provided parameters.

Parameters
`requestOptions: RequestOptions = RequestOptions()`	Configuration options for sending requests to the backend.

Returns
`TemplateGenerativeModel`	The initialized `TemplateGenerativeModel` instance.

templateImagenModel

@PublicPreviewAPI
fun templateImagenModel(requestOptions: RequestOptions = RequestOptions()): TemplateImagenModel

Instantiates a new TemplateImagenModel given the provided parameters.

Parameters
`requestOptions: RequestOptions = RequestOptions()`	Configuration options for sending requests to the backend.

Returns
`TemplateImagenModel`	The initialized `TemplateImagenModel` instance.