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

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `GAN_AI`
- **Version:** 20260211_00

## Tools

### Get Avatar Video Inference Details

**Slug:** `GAN_AI_GET_AVATAR_VIDEO_INFERENCE_DETAILS`

Tool to retrieve detailed status and metadata for a specific avatar video inference. Use when you have an inference_id and need to check its processing status and access video URLs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inference_id` | string | Yes | The unique identifier (UUID) of the avatar video inference to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Photo Avatar Details

**Slug:** `GAN_AI_GET_PHOTO_AVATAR_DETAILS`

Tool to retrieve detailed information for a specific photo avatar by ID. Use when you need to check photo avatar processing status and access its metadata and image URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `photo_avatar_id` | string | Yes | UUID of the photo avatar to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get photo avatar inference details

**Slug:** `GAN_AI_GET_PHOTO_AVATAR_INFERENCE_DETAILS`

Tool to fetch photo avatar inference details. Use after obtaining a valid inference ID to retrieve detailed information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `downloadable_link` | boolean | No | Include downloadable video link when true (default: false). |
| `photo_avatar_inference_id` | string | Yes | The photo avatar inference ID to fetch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List avatar video inferences

**Slug:** `GAN_AI_LIST_AVATAR_VIDEOS`

Tool to list avatar video inferences. Use when you need to retrieve generated avatar videos with optional filtering by avatar ID, title, status, or date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Pagination offset (number of items to skip). Default is 0. |
| `limit` | integer | No | Maximum number of items to return. Default is 10. |
| `status` | array | No | Filter by one or more inference statuses. |
| `avatar_id` | string | No | UUID of the avatar to filter by. |
| `avatar_title` | string | No | Filter by avatar title. |
| `end_datetime` | string | No | ISO 8601 end timestamp for filtering. |
| `start_datetime` | string | No | ISO 8601 start timestamp for filtering. |
| `inference_title` | string | No | Filter by inference/video title. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List photo avatar inferences

**Slug:** `GAN_AI_LIST_PHOTO_AVATAR_INFERENCES`

Tool to list photo avatar inferences. Use when you need to retrieve inference videos with optional filtering by avatar, title, status, or date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Pagination offset (number of items to skip). |
| `limit` | integer | No | Maximum number of items to return. |
| `title` | string | No | Filter by inference title. |
| `status` | array | No | Filter by one or more inference statuses. |
| `end_datetime` | string | No | ISO 8601 end of the creation time window, e.g., '2023-01-07T23:59:59Z'. |
| `start_datetime` | string | No | ISO 8601 start of the creation time window, e.g., '2023-01-01T00:00:00Z'. |
| `photo_avatar_id` | string | No | UUID of the photo avatar to filter by. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Photo Avatars

**Slug:** `GAN_AI_LIST_PHOTO_AVATARS`

Tool to list avatars. Use when you need a paginated collection of avatars with filters. Example: "List the first 10 published avatars created after 2023-01-01".

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of records to skip for pagination (offset). Default is 0. |
| `limit` | integer | No | Maximum number of records to return. Default is 10. |
| `title` | string | No | Filter by avatar title (exact match). |
| `status` | array | No | Filter by one or more statuses; common values include: consent_pending, processing, consent_failed, failed, published, deleted, draft. |
| `end_datetime` | string | No | ISO 8601 end timestamp for filtering (inclusive). |
| `start_datetime` | string | No | ISO 8601 start timestamp for filtering (inclusive). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | User's email address. |
| `password` | string | Yes | User's password. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The text content to convert to speech. Must be between 40 and 500 characters for optimal synthesis quality. |
| `voice_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |