Skip to main content
Glama
Sign In

VideoGen

by io.github.dg314
OverviewDiscussionsAdmin

Generate avatar

generate_avatar

Generate a talking-head avatar video from an ACTOR entity and an uploaded audio file. Pass actorEntityId and optionally set avatarQuality. Typically takes a few minutes (longer for longer audio). Tell the user that wait up front. Returns toolExecutionId; get_tool_execution provides status and results with the avatar video file and download URL.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "actorEntityId": "<actorEntityId>",
      "audioFileId": "<audioFileId>"
    },
    "name": "generate_avatar"
  }
}

Input Schema

NameRequiredDescriptionDefault
audioFileIdYesSpeech recording for the actor to lip-sync. Use fileId from an audio upload, list_files, or a succeeded text_to_speech result.
actorEntityIdYesId of a built-in stock actor or an ACTOR entity (vg_enti_...) with an image reference.
avatarQualityNoAvatar generation quality tier. Applies when actorEntityId is provided. Omit to use workspace settings.

Output Schema

NameRequiredDescriptionDefault
errorNoError details when status is failed; otherwise null.
statusNoJob status: pending, running, succeeded, failed, or cancelled.
resultsNoGenerated results with download URLs when succeeded.
toolTypeNoTool name (e.g. GENERATE_IMAGE).
attemptIndexNoCurrent or latest attempt index.
toolExecutionIdYesTool execution id (vg_tool_...).
progressPercentageNoCompletion progress 0-100 (present after polling).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed33 schema fields changed
    • changedOutput schema / properties / error / anyOf
      Previous value: -[
-  {
-    "additionalProperties": {},
-    "properties": {
-      "code": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Machine-readable error code."
-      },
-      "internalErrorCode": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Opaque code for support."
-      },
-      "message": {
-        "description": "Human-readable error description.",
-        "type": "string"
-      },
-      "requirement": {
-        "anyOf": [
-          {
-            "additionalProperties": {},
-            "properties": {
-              "details": {
-                "additionalProperties": {
-                  "type": "string"
-                },
-                "propertyNames": {
-                  "type": "string"
-                },
-                "type": "object"
-              },
-              "type": {
-                "description": "Requirement type (e.g. purchase_add_on).",
-                "type": "string"
-              }
-            },
-            "required": [
-              "type"
-            ],
-            "type": "object"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "What is needed to resolve the error, when applicable."
-      }
-    },
-    "required": [
-      "message"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "properties": {
+      "code": {
+        "description": "Machine-readable error code.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "internalErrorCode": {
+        "description": "Opaque code for support.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "message": {
+        "description": "Human-readable error description.",
+        "type": "string"
+      },
+      "requirement": {
+        "anyOf": [
+          {
+            "additionalProperties": {},
+            "properties": {
+              "details": {
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "propertyNames": {
+                  "type": "string"
+                },
+                "type": "object"
+              },
+              "type": {
+                "description": "Requirement type (e.g. purchase_add_on).",
+                "type": "string"
+              }
+            },
+            "required": [
+              "type"
+            ],
+            "type": "object"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "What is needed to resolve the error, when applicable."
+      }
+    },
+    "required": [
+      "message"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
    • removedOutput schema / properties / results / items / properties / downloadUrl / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / downloadUrl / type
      Added value: +[
+  "string",
+  "null"
+]
    • removedOutput schema / properties / results / items / properties / downloadUrlExpiresAt / anyOf
      Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / downloadUrlExpiresAt / type
      Added value: +[
+  "number",
+  "null"
+]
    • removedOutput schema / properties / results / items / properties / file / properties / description / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / file / properties / description / type
      Added value: +[
+  "string",
+  "null"
+]
    • changedOutput schema / properties / results / items / properties / file / properties / downloadSource / anyOf
      Previous value: -[
-  {
-    "additionalProperties": {},
-    "description": "A file rendition source (thumbnail, preview, download, …).",
-    "properties": {
-      "expiresAt": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Unix expiry for url."
-      },
-      "fileBytes": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition size in bytes."
-      },
-      "height": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition height in pixels."
-      },
-      "status": {
-        "description": "Rendition status.",
-        "enum": [
-          "pending",
-          "ready",
-          "failed",
-          "skipped"
-        ],
-        "type": "string"
-      },
-      "url": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Signed URL when status is ready."
-      },
-      "width": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition width in pixels."
-      }
-    },
-    "required": [
-      "status"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "description": "A file rendition source (thumbnail, preview, download, …).",
+    "properties": {
+      "expiresAt": {
+        "description": "Unix expiry for url.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "fileBytes": {
+        "description": "Rendition size in bytes.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "height": {
+        "description": "Rendition height in pixels.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "status": {
+        "description": "Rendition status.",
+        "enum": [
+          "pending",
+          "ready",
+          "failed",
+          "skipped"
+        ],
+        "type": "string"
+      },
+      "url": {
+        "description": "Signed URL when status is ready.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "width": {
+        "description": "Rendition width in pixels.",
+        "type": [
+          "number",
+          "null"
+        ]
+      }
+    },
+    "required": [
+      "status"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
    • removedOutput schema / properties / results / items / properties / file / properties / downloadUrl / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / file / properties / downloadUrl / type
      Added value: +[
+  "string",
+  "null"
+]
    • removedOutput schema / properties / results / items / properties / file / properties / downloadUrlExpiresAt / anyOf
      Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / file / properties / downloadUrlExpiresAt / type
      Added value: +[
+  "number",
+  "null"
+]
    • removedOutput schema / properties / results / items / properties / file / properties / durationSeconds / anyOf
      Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / file / properties / durationSeconds / type
      Added value: +[
+  "number",
+  "null"
+]
    • changedOutput schema / properties / results / items / properties / file / properties / hlsSource / anyOf
      Previous value: -[
-  {
-    "additionalProperties": {},
-    "description": "A file rendition source (thumbnail, preview, download, …).",
-    "properties": {
-      "expiresAt": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Unix expiry for url."
-      },
-      "fileBytes": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition size in bytes."
-      },
-      "height": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition height in pixels."
-      },
-      "status": {
-        "description": "Rendition status.",
-        "enum": [
-          "pending",
-          "ready",
-          "failed",
-          "skipped"
-        ],
-        "type": "string"
-      },
-      "url": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Signed URL when status is ready."
-      },
-      "width": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition width in pixels."
-      }
-    },
-    "required": [
-      "status"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "description": "A file rendition source (thumbnail, preview, download, …).",
+    "properties": {
+      "expiresAt": {
+        "description": "Unix expiry for url.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "fileBytes": {
+        "description": "Rendition size in bytes.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "height": {
+        "description": "Rendition height in pixels.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "status": {
+        "description": "Rendition status.",
+        "enum": [
+          "pending",
+          "ready",
+          "failed",
+          "skipped"
+        ],
+        "type": "string"
+      },
+      "url": {
+        "description": "Signed URL when status is ready.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "width": {
+        "description": "Rendition width in pixels.",
+        "type": [
+          "number",
+          "null"
+        ]
+      }
+    },
+    "required": [
+      "status"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
    • changedOutput schema / properties / results / items / properties / file / properties / previewSource / anyOf
      Previous value: -[
-  {
-    "additionalProperties": {},
-    "description": "A file rendition source (thumbnail, preview, download, …).",
-    "properties": {
-      "expiresAt": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Unix expiry for url."
-      },
-      "fileBytes": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition size in bytes."
-      },
-      "height": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition height in pixels."
-      },
-      "status": {
-        "description": "Rendition status.",
-        "enum": [
-          "pending",
-          "ready",
-          "failed",
-          "skipped"
-        ],
-        "type": "string"
-      },
-      "url": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Signed URL when status is ready."
-      },
-      "width": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition width in pixels."
-      }
-    },
-    "required": [
-      "status"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "description": "A file rendition source (thumbnail, preview, download, …).",
+    "properties": {
+      "expiresAt": {
+        "description": "Unix expiry for url.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "fileBytes": {
+        "description": "Rendition size in bytes.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "height": {
+        "description": "Rendition height in pixels.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "status": {
+        "description": "Rendition status.",
+        "enum": [
+          "pending",
+          "ready",
+          "failed",
+          "skipped"
+        ],
+        "type": "string"
+      },
+      "url": {
+        "description": "Signed URL when status is ready.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "width": {
+        "description": "Rendition width in pixels.",
+        "type": [
+          "number",
+          "null"
+        ]
+      }
+    },
+    "required": [
+      "status"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
    • removedOutput schema / properties / results / items / properties / file / properties / publicHlsUrl / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / file / properties / publicHlsUrl / type
      Added value: +[
+  "string",
+  "null"
+]
    • removedOutput schema / properties / results / items / properties / file / properties / publicPlaybackId / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / file / properties / publicPlaybackId / type
      Added value: +[
+  "string",
+  "null"
+]
    • changedOutput schema / properties / results / items / properties / file / properties / thumbnailSource / anyOf
      Previous value: -[
-  {
-    "additionalProperties": {},
-    "description": "A file rendition source (thumbnail, preview, download, …).",
-    "properties": {
-      "expiresAt": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Unix expiry for url."
-      },
-      "fileBytes": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition size in bytes."
-      },
-      "height": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition height in pixels."
-      },
-      "status": {
-        "description": "Rendition status.",
-        "enum": [
-          "pending",
-          "ready",
-          "failed",
-          "skipped"
-        ],
-        "type": "string"
-      },
-      "url": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Signed URL when status is ready."
-      },
-      "width": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Rendition width in pixels."
-      }
-    },
-    "required": [
-      "status"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "description": "A file rendition source (thumbnail, preview, download, …).",
+    "properties": {
+      "expiresAt": {
+        "description": "Unix expiry for url.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "fileBytes": {
+        "description": "Rendition size in bytes.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "height": {
+        "description": "Rendition height in pixels.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "status": {
+        "description": "Rendition status.",
+        "enum": [
+          "pending",
+          "ready",
+          "failed",
+          "skipped"
+        ],
+        "type": "string"
+      },
+      "url": {
+        "description": "Signed URL when status is ready.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "width": {
+        "description": "Rendition width in pixels.",
+        "type": [
+          "number",
+          "null"
+        ]
+      }
+    },
+    "required": [
+      "status"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
    • removedOutput schema / properties / results / items / properties / file / properties / thumbnailUrl / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / file / properties / thumbnailUrl / type
      Added value: +[
+  "string",
+  "null"
+]
    • removedOutput schema / properties / results / items / properties / file / properties / thumbnailUrlExpiresAt / anyOf
      Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / file / properties / thumbnailUrlExpiresAt / type
      Added value: +[
+  "number",
+  "null"
+]
    • removedOutput schema / properties / results / items / properties / file / properties / transcriptText / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / file / properties / transcriptText / type
      Added value: +[
+  "string",
+  "null"
+]
    • removedOutput schema / properties / results / items / properties / file / properties / type / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / file / properties / type / type
      Added value: +[
+  "string",
+  "null"
+]
    • removedOutput schema / properties / results / items / properties / thumbnailUrl / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / thumbnailUrl / type
      Added value: +[
+  "string",
+  "null"
+]
    • removedOutput schema / properties / results / items / properties / thumbnailUrlExpiresAt / anyOf
      Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / results / items / properties / thumbnailUrlExpiresAt / type
      Added value: +[
+  "number",
+  "null"
+]
  2. Changed1 schema field changed
    • changedInput schema / properties / audioFileId / description
      Previous value: -"Audio file id for the avatar to lip-sync."New value: +"Speech recording for the actor to lip-sync. Use fileId from an audio upload, list_files, or a succeeded text_to_speech result."
  3. First observed

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations, the description discloses key behavior: generation is slow, can take longer for longer audio, and the user should be told about the wait up front. It also explains the async workflow, returning toolExecutionId and directing the agent to get_tool_execution for status and the downloadable result.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the purpose, then covers prerequisites, expected duration, user communication, and result retrieval. Every sentence serves a distinct operational purpose without unnecessary wording.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an asynchronous generative tool with a full output schema, the description supplies the missing operational context: expected wait time, the need to inform the user, and how to poll via get_tool_execution. Nothing essential for correct invocation is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already explains actorEntityId, audioFileId, and avatarQuality in detail. The description repeats actorEntityId and avatarQuality but adds little parameter meaning beyond the schema, which is the expected baseline when the schema is rich.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: generating a talking-head avatar video. It also names the required source types, an ACTOR entity and an uploaded audio file, which distinguishes it from sibling generation tools such as generate_video_clip or text_to_speech.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives clear usage context by saying to pass actorEntityId and optionally avatarQuality, and it sets the expectation that generation takes minutes. It does not explicitly name alternatives or when not to use this tool, so it falls short of full when/when-not guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All VideoGen toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources