> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Gan.AI

> Gan.AI provides advanced APIs for text-to-speech, voice cloning, and video personalization, enabling developers to integrate natural and expressive speech synthesis into their applications.

![Gan.AI logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/gan_ai.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=20611f798cb9ac02ce72ea47709fd756)

* **Category:** media generation
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 8
* **Triggers:** 0
* **Slug:** `GAN_AI`
* **Version:** 20261101\_00

## Tools

> [accordion] Get Avatar Video Inference Details
>
> **Slug:** `GAN_AI_GET_AVATAR_VIDEO_INFERENCE_DETAILS`
>
> Retrieve status and metadata for an avatar video inference by its inference UUID, including the generated video URL when available.
>
> #### Input Parameters
>
> **inference\_id** `string` *required*
>
> The unique identifier (UUID) of the avatar video inference to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Photo Avatar Details
>
> **Slug:** `GAN_AI_GET_PHOTO_AVATAR_DETAILS`
>
> Retrieve details for a photo avatar by ID, including its processing status, metadata, and image URL when available.
>
> #### Input Parameters
>
> **photo\_avatar\_id** `string` *required*
>
> UUID of the photo avatar to retrieve details for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get photo avatar inference details
>
> **Slug:** `GAN_AI_GET_PHOTO_AVATAR_INFERENCE_DETAILS`
>
> Retrieve details for a photo avatar inference by its inference UUID. Use it to check the inference status and access its generated video or request a downloadable link when available.
>
> #### Input Parameters
>
> **downloadable\_link** `boolean`
>
> Include downloadable video link when true (default: false).
>
> **photo\_avatar\_inference\_id** `string` *required*
>
> The photo avatar inference ID to fetch.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List avatar video inferences
>
> **Slug:** `GAN_AI_LIST_AVATAR_VIDEOS`
>
> List avatar video inferences, with optional filters for avatar ID, avatar or video title, status, and creation date range. Use offset and limit to paginate the results.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Pagination offset (number of items to skip). Default is 0.
>
> **limit** `integer`
>
> Maximum number of items to return. Default is 10.
>
> **status** `array`
>
> Filter by one or more inference statuses.
>
> **avatar\_id** `string`
>
> UUID of the avatar to filter by.
>
> **avatar\_title** `string`
>
> Filter by avatar title.
>
> **end\_datetime** `string`
>
> ISO 8601 end timestamp for filtering.
>
> **start\_datetime** `string`
>
> ISO 8601 start timestamp for filtering.
>
> **inference\_title** `string`
>
> Filter by inference/video title.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List photo avatar inferences
>
> **Slug:** `GAN_AI_LIST_PHOTO_AVATAR_INFERENCES`
>
> List photo avatar inferences using a GanOS API key, with optional filters by avatar, title, status, and creation date range. Use offset and limit to paginate inference results.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Pagination offset (number of items to skip).
>
> **limit** `integer`
>
> Maximum number of items to return.
>
> **title** `string`
>
> Filter by inference title.
>
> **status** `array`
>
> Filter by one or more inference statuses.
>
> **end\_datetime** `string`
>
> ISO 8601 end of the creation time window, e.g., '2023-01-07T23:59:59Z'.
>
> **start\_datetime** `string`
>
> ISO 8601 start of the creation time window, e.g., '2023-01-01T00:00:00Z'.
>
> **photo\_avatar\_id** `string`
>
> UUID of the photo avatar to filter by.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Photo Avatars
>
> **Slug:** `GAN_AI_LIST_PHOTO_AVATARS`
>
> List avatars using a GanOS API key, with optional filters by title, status, and creation date range. Use offset and limit to paginate the collection.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip for pagination (offset). Default is 0.
>
> **limit** `integer`
>
> Maximum number of records to return. Default is 10.
>
> **title** `string`
>
> Filter by avatar title (exact match).
>
> **status** `array`
>
> Filter by one or more statuses; common values include: consent\_pending, processing, consent\_failed, failed, published, deleted, draft.
>
> **end\_datetime** `string`
>
> ISO 8601 end timestamp for filtering (inclusive).
>
> **start\_datetime** `string`
>
> ISO 8601 start timestamp for filtering (inclusive).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Login
>
> **Slug:** `GAN_AI_LOGIN`
>
> Tool to authenticate a user and retrieve access and refresh tokens. Use when you need to login before calling other GAN.AI API actions.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> User's email address.
>
> **password** `string` *required*
>
> User's password.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] GAN AI Text-to-Speech
>
> **Slug:** `GAN_AI_TTS`
>
> Convert text to speech using GAN.AI's Text-to-Speech API. This tool synthesizes speech from text using a specified voice. The voice\_id must be obtained from the GAN.AI Get Voices endpoint or from your GAN.AI dashboard. Returns audio in WAV format.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> The text content to convert to speech. Must be between 40 and 500 characters for optimal synthesis quality.
>
> **voice\_id** `string` *required*
>
> Unique identifier (UUID) of the voice to use for speech synthesis. Obtain valid voice IDs from the GAN.AI Get Voices endpoint or dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
