Generate Video with SpiritMe API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for SpiritMe, Schedule and 2,200+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Generate Video with the SpiritMe API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and SpiritMe action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Generate Video action
1. Connect your SpiritMe account
2. Configure Name
3. Optional- Select a Avatar
4. Optional- Select a Voice
5. Optional- Configure Text
6. Optional- Select a Audio File
7. Optional- Select a Media File
8. Optional- Select a View Type
9. Optional- Configure Auto Emotions Markup
10. Optional- Configure Wait For Completion
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Generate Video on SpiritMe

Description:Generates a new video using specific voice and avatar props. [See the documentation](https://api.spiritme.tech/api/swagger/#/videos/videos_create)

Version:0.0.1

Key:spiritme-generate-video

View on GitHub

Action Code#

import spiritme from "../../spiritme.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "spiritme-generate-video",
  name: "Generate Video",
  description: "Generates a new video using specific voice and avatar props. [See the documentation](https://api.spiritme.tech/api/swagger/#/videos/videos_create)",
  version: "0.0.1",
  type: "action",
  props: {
    spiritme,
    name: {
      type: "string",
      label: "Name",
      description: "Name of the video",
    },
    avatar: {
      propDefinition: [
        spiritme,
        "avatar",
      ],
    },
    voice: {
      propDefinition: [
        spiritme,
        "voice",
      ],
    },
    text: {
      type: "string",
      label: "Text",
      description: "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: true,
    },
    audioFile: {
      propDefinition: [
        spiritme,
        "file",
        () => ({
          type: [
            "audio",
          ],
        }),
      ],
      label: "Audio File",
      description: "Identifier of an audio file. Either text or audio file is required.",
    },
    media: {
      propDefinition: [
        spiritme,
        "file",
        () => ({
          type: [
            "image",
            "video",
          ],
        }),
      ],
      label: "Media File",
      description: "Identifier of an image or video file. One of avatar or media is required.",
    },
    viewType: {
      type: "string",
      label: "View Type",
      description: "Content as is or content in circle. Supported only for avatars.",
      optional: true,
      options: [
        "rectangular",
        "circular",
      ],
    },
    autoEmotionsMarkup: {
      type: "boolean",
      label: "Auto Emotions Markup",
      description: "Add emotions automatically by AI",
      optional: true,
    },
    waitForCompletion: {
      type: "boolean",
      label: "Wait For Completion",
      description: "Set to `true` to poll the API in 3-second intervals until the video is completed",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      spiritme,
      name,
      avatar,
      voice,
      text,
      audioFile,
      media,
      viewType,
      autoEmotionsMarkup,
      waitForCompletion,
    } = this;

    if (!avatar && !media) {
      throw new ConfigurationError("One of `Avatar` or `Media File` is required");
    }

    if (!text && !audioFile) {
      throw new ConfigurationError("One of `Text` or `Audio File` is required");
    }

    let response = await spiritme.generateVideo({
      $,
      data: {
        name,
        slides: [
          {
            audio_source: {
              text,
              voice: voice
                ? {
                  id: voice,
                }
                : undefined,
              file: audioFile
                ? {
                  id: audioFile,
                }
                : undefined,
            },
            layers: [
              {
                avatar: avatar
                  ? {
                    id: avatar,
                  }
                  : undefined,
                media: media
                  ? {
                    id: media,
                  }
                  : undefined,
                view_type: viewType,
              },
            ],
          },
        ],
        auto_emotions_markup: autoEmotionsMarkup,
      },
    });

    if (waitForCompletion) {
      const timer = (ms) => new Promise((res) => setTimeout(res, ms));
      while (response.status !== "success") {
        response = await spiritme.getVideo({
          videoId: response.id,
        });
        await timer(3000);
      }
    }

    $.export("$summary", `Generated video with ID: ${response.id}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
SpiritMe	`spiritme`	`app`	This component uses the SpiritMe app.
Name	`name`	`string`	Name of the video
Avatar	`avatar`	`string`	Select a value from the drop down menu.
Voice	`voice`	`string`	Select a value from the drop down menu.
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.
Audio File	`audioFile`	`string`	Select a value from the drop down menu.
Media File	`media`	`string`	Select a value from the drop down menu.
View Type	`viewType`	`string`	Select a value from the drop down menu:`rectangularcircular`
Auto Emotions Markup	`autoEmotionsMarkup`	`boolean`	Add emotions automatically by AI
Wait For Completion	`waitForCompletion`	`boolean`	Set to `true` to poll the API in 3-second intervals until the video is completed