View as Markdown
JoggAI icon

JoggAI ACTION

Create Avatar Video

Creates an avatar video using JoggAI API. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's JoggAI account once, then configure and run Create Avatar Video from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "joggai-create-avatar-video",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    joggai: { authProvisionId: "apn_xxxxxxx" },
    screenStyle: 10,
    avatarType: "Avatar Type",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Avatar Video inputs
Property Type Description
screenStyle Screen Style integer
Style of the screen.
Required
avatarType Avatar Type string
Source type of the avatar.
Required
avatarId Avatar ID integer
ID of the avatar.
Required Dynamic
voiceType Voice Type string
Source type of the voice.
Required
voiceId Voice ID string
ID of the voice.
Required Dynamic
script Script string
Script content for the avatar to speak. Must provide either script or Audio URL.
Optional
audioUrl Audio URL string
Url for Audio, either script or audio_url must be provided, but not both.
Optional
aspectRatio Aspect Ratio string
Aspect ratio of the output video.
Required
caption Caption boolean
Whether to add caption to the video.
Optional
videoName Video Name string
If you want to specify the name of the generated video, please use this parameter.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
joggai-create-avatar-video
Version
0.0.2
App
JoggAI
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes