Generate Video with SpiritMe API on New Direct Message (Instant) from Slack API

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

Trigger workflow on

New Direct Message (Instant) from the Slack 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 Slack 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 New Direct Message (Instant) trigger
1. Connect your Slack account
2. Configure slackApphook
3. Optional- Configure Ignore Bots
4. Optional- Configure Ignore Messages from Yourself
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#

New Direct Message (Instant) on Slack

Description:Emit new event when a message was posted in a direct message channel

Version:1.0.20

Key:slack-new-direct-message

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. Once you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "slack-new-direct-message",
  name: "New Direct Message (Instant)",
  version: "1.0.20",
  description: "Emit new event when a message was posted in a direct message channel",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return [
          "message.im",
        ];
      },
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreSelf: {
      type: "boolean",
      label: "Ignore Messages from Yourself",
      description: "Ignores messages sent to yourself",
      default: false,
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New direct message received";
    },
    processEvent(event) {
      if ((this.ignoreSelf && event.user == this.slack.mySlackId())
        || ((this.ignoreBot) && (event.subtype === "bot_message" || event.bot_id))
        || (event.subtype === "message_changed")) {
        return;
      }
      return event;
    },
  },
  sampleEmit,
};

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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`slackApphook`	`$.interface.apphook`
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore Messages from Yourself	`ignoreSelf`	`boolean`	Ignores messages sent to yourself

Trigger Authentication#

Slack uses OAuth authentication. When you connect your Slack account, Pipedream will open a popup window where you can sign into Slack and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Slack API.

Pipedream requests the following authorization scopes when you connect your account:

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.profile:writeusers.profile:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

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

Generate Video with SpiritMe API on New Direct Message (Instant) from Slack API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular