Skip to main content
Gan.AI logo
  • Category: media generation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: GAN_AI
  • Version: 20261101_00

Tools

Slug: GAN_AI_GET_AVATAR_VIDEO_INFERENCE_DETAILSRetrieve status and metadata for an avatar video inference by its inference UUID, including the generated video URL when available.

Input Parameters

string
required
The unique identifier (UUID) of the avatar video inference to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GAN_AI_GET_PHOTO_AVATAR_DETAILSRetrieve details for a photo avatar by ID, including its processing status, metadata, and image URL when available.

Input Parameters

string
required
UUID of the photo avatar to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GAN_AI_GET_PHOTO_AVATAR_INFERENCE_DETAILSRetrieve 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

Include downloadable video link when true (default: false).
string
required
The photo avatar inference ID to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GAN_AI_LIST_AVATAR_VIDEOSList 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

integer
Pagination offset (number of items to skip). Default is 0.
integer
Maximum number of items to return. Default is 10.
array
Filter by one or more inference statuses.
string
UUID of the avatar to filter by.
string
Filter by avatar title.
string
ISO 8601 end timestamp for filtering.
string
ISO 8601 start timestamp for filtering.
string
Filter by inference/video title.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GAN_AI_LIST_PHOTO_AVATAR_INFERENCESList 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

integer
Pagination offset (number of items to skip).
integer
Maximum number of items to return.
string
Filter by inference title.
array
Filter by one or more inference statuses.
string
ISO 8601 end of the creation time window, e.g., ‘2023-01-07T23:59:59Z’.
string
ISO 8601 start of the creation time window, e.g., ‘2023-01-01T00:00:00Z’.
string
UUID of the photo avatar to filter by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GAN_AI_LIST_PHOTO_AVATARSList 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GAN_AI_LOGINTool 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

string
required
User’s email address.
string
required
User’s password.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GAN_AI_TTSConvert 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

string
required
The text content to convert to speech. Must be between 40 and 500 characters for optimal synthesis quality.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not