View as Markdown
SpiritMe icon

SpiritMe ACTION

Generate Video

Generates a new video using specific voice and avatar props. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SpiritMe account once, then configure and run Generate 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: "spiritme-generate-video",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    spiritme: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    avatar: "Avatar",
  },
})

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.

Generate Video inputs
Property Type Description
name Name string
Name of the video
Required
avatar Avatar string
The identifier for the avatar to be used. One of avatar or media is required.
Optional Dynamic
voice Voice string
The identifier of the voice to be used
Optional Dynamic
text Text string
The text to use for the video. Example: Hello everyone! I am a virtual avatar from Spiritme. Use tags <emotion name="emotion_name"> text </emotion> to add emotions to the generated video. The list of supported emotions are neutral, semismile, smile, happiness, sadness, and surprise. Either text or audio file is required.
Optional
audioFile Audio File string
Identifier of an audio file. Either text or audio file is required.
Optional Dynamic
media Media File string
Identifier of an image or video file. One of avatar or media is required.
Optional Dynamic
viewType View Type string
Content as is or content in circle. Supported only for avatars.
Optional
autoEmotionsMarkup Auto Emotions Markup boolean
Add emotions automatically by AI
Optional
waitForCompletion Wait For Completion boolean
Set to true to poll the API in 3-second intervals until the video is completed
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
spiritme-generate-video
Version
0.0.3
App
SpiritMe
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes