NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Gan.AI connects to a Nagent workspace with an API key. Once it is connected, agents can call 8 Gan.AI actions, such as "Get Avatar Video Inference Details", "Get Photo Avatar Details" and "Get photo avatar inference details". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Gan.AI, with input parameters and output schema.
GAN_AI_GET_AVATAR_VIDEO_INFERENCE_DETAILSTool 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
The unique identifier (UUID) of the avatar video inference to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GAN_AI_GET_PHOTO_AVATAR_DETAILSTool 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
UUID of the photo avatar to retrieve details for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GAN_AI_GET_PHOTO_AVATAR_INFERENCE_DETAILSTool to fetch photo avatar inference details. Use after obtaining a valid inference ID to retrieve detailed information.
Input parameters
Include downloadable video link when true (default: false).
The photo avatar inference ID to fetch.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GAN_AI_LIST_AVATAR_VIDEOSTool 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
Pagination offset (number of items to skip). Default is 0.
Maximum number of items to return. Default is 10.
Filter by one or more inference statuses.
UUID of the avatar to filter by.
Filter by avatar title.
ISO 8601 end timestamp for filtering.
ISO 8601 start timestamp for filtering.
Filter by inference/video title.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GAN_AI_LIST_PHOTO_AVATAR_INFERENCESTool 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
Pagination offset (number of items to skip).
Maximum number of items to return.
Filter by inference title.
Filter by one or more inference statuses.
ISO 8601 end of the creation time window, e.g., '2023-01-07T23:59:59Z'.
ISO 8601 start of the creation time window, e.g., '2023-01-01T00:00:00Z'.
UUID of the photo avatar to filter by.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GAN_AI_LIST_PHOTO_AVATARSTool 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
Number of records to skip for pagination (offset). Default is 0.
Maximum number of records to return. Default is 10.
Filter by avatar title (exact match).
Filter by one or more statuses; common values include: consent_pending, processing, consent_failed, failed, published, deleted, draft.
ISO 8601 end timestamp for filtering (inclusive).
ISO 8601 start timestamp for filtering (inclusive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
User's email address.
User's password.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The text content to convert to speech. Must be between 40 and 500 characters for optimal synthesis quality.
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 8 Gan.AI actions on Nagent, including "Get Avatar Video Inference Details", "Get Photo Avatar Details" and "Get photo avatar inference details". Get Avatar Video Inference Details: Retrieve detailed status and metadata for a specific avatar video inference. Each action is listed on this page with its input parameters and its output.
Gan.AI connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Avatar Video Inference Details takes 1 required input: inference_id. It returns data, error and successful.