Create AI Avatar Photo with JoggAI API on New Bot Event Created from Botpress API

Pipedream makes it easy to connect APIs for JoggAI, Botpress and 2,700+ other apps remarkably fast.

Trigger workflow on

New Bot Event Created from the Botpress API

Next, do this

Create AI Avatar Photo with the JoggAI 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 Botpress trigger and JoggAI action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Bot Event Created trigger
1. Connect your Botpress account
2. Configure Polling Schedule
3. Select a Event Type
Configure the Create AI Avatar Photo action
1. Connect your JoggAI account
2. Select a Age
3. Select a Aspect Ratio
4. Select a Avatar Style
5. Select a Gender
6. Select a Model
7. Optional- Configure Appearance
8. Optional- Configure Background
9. Optional- Select a Ethnicity
10. Optional- Configure Image URL
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 Bot Event Created on Botpress

Description:Emit new event from bot is created. [See the documentation](https://botpress.com/docs/api-documentation/#list-events)

Version:0.0.1

Key:botpress-new-bot-event-created

View on GitHub

Botpress Overview#

Botpress is a powerful, open-source chatbot platform that enables developers to create intelligent, conversational bots. With its natural language understanding (NLU) capabilities, users can design bots that can interpret human language and respond appropriately. Utilizing the Botpress API on Pipedream allows you to automate interactions, analyze chat data, and integrate with various other services to enhance the functionality of your bots.

Trigger Code#

import common from "../common/polling.mjs";

export default {
  ...common,
  key: "botpress-new-bot-event-created",
  name: "New Bot Event Created",
  description: "Emit new event from bot is created. [See the documentation](https://botpress.com/docs/api-documentation/#list-events)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    type: {
      type: "string",
      label: "Event Type",
      description: "The type of event to poll for",
      options: [
        "state_expired",
        "message_created",
        "task_update",
        "schedulev1",
        "botpublished",
        "botready",
        "resumeprocessing",
        "hitlAgent",
        "webchat:conversationStarted",
        "webchat:trigger",
      ],
    },
  },
  methods: {
    ...common.methods,
    getResourceName() {
      return "events";
    },
    getResourcesFn() {
      return this.app.listEvents;
    },
    getResourcesFnArgs() {
      return {
        params: {
          type: this.type,
        },
      };
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Event: ${resource.type}`,
        ts: Date.parse(resource.createdAt),
      };
    },
  },
};

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
Botpress	`app`	`app`	This component uses the Botpress app.
Polling Schedule	`timer`	`$.interface.timer`	How often to poll the API
Event Type	`type`	`string`	Select a value from the drop down menu:`state_expiredmessage_createdtask_updateschedulev1botpublishedbotreadyresumeprocessinghitlAgentwebchat:conversationStartedwebchat:trigger`

Trigger Authentication#

Botpress uses API keys for authentication. When you connect your Botpress account, Pipedream securely stores the keys so you can easily authenticate to Botpress APIs in both code and no-code steps.

About Botpress#

Automate complex conversations, tasks, and workflows — reliably.

Action#

Create AI Avatar Photo on JoggAI

Description:Creates an AI avatar photo using JoggAI API. [See the documentation](https://docs.jogg.ai/api-reference/Avatar/GenerateAIAvatarPhoto)

Version:0.0.1

Key:joggai-create-ai-avatar-photo

View on GitHub

Action Code#

import {
  AGE_OPTIONS,
  ASPECT_RATIO_OPTIONS,
  AVATAR_STYLE_OPTIONS,
  ETHNICITY_OPTIONS,
  GENDER_OPTIONS,
  MODEL_OPTIONS,
} from "../../common/constants.mjs";
import { checkResponse } from "../../common/utils.mjs";
import joggai from "../../joggai.app.mjs";

export default {
  key: "joggai-create-ai-avatar-photo",
  name: "Create AI Avatar Photo",
  description: "Creates an AI avatar photo using JoggAI API. [See the documentation](https://docs.jogg.ai/api-reference/Avatar/GenerateAIAvatarPhoto)",
  version: "0.0.1",
  type: "action",
  props: {
    joggai,
    age: {
      type: "string",
      label: "Age",
      description: "Age of the avatar.",
      options: AGE_OPTIONS,
    },
    aspectRatio: {
      type: "string",
      label: "Aspect Ratio",
      description: "Aspect ratio of the avatar.",
      options: ASPECT_RATIO_OPTIONS,
    },
    avatarStyle: {
      type: "string",
      label: "Avatar Style",
      description: "Style of the avatar.",
      options: AVATAR_STYLE_OPTIONS,
    },
    gender: {
      type: "string",
      label: "Gender",
      description: "Gender of the avatar.",
      options: GENDER_OPTIONS,
    },
    model: {
      type: "string",
      label: "Model",
      description: "Model of the avatar.",
      options: MODEL_OPTIONS,
    },
    appearance: {
      type: "string",
      label: "Appearance",
      description: "Appearance of the avatar.",
      optional: true,
    },
    background: {
      type: "string",
      label: "Background",
      description: "Background of the avatar.",
      optional: true,
    },
    ethnicity: {
      type: "string",
      label: "Ethnicity",
      description: "Ethnicity of the avatar.",
      options: ETHNICITY_OPTIONS,
      optional: true,
    },
    imageUrl: {
      type: "string",
      label: "Image URL",
      description: "URL of the image to use for the avatar.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.joggai.createAIAvatarPhoto({
      $,
      data: {
        age: this.age,
        aspect_ratio: this.aspectRatio && parseInt(this.aspectRatio),
        avatar_style: this.avatarStyle,
        gender: this.gender,
        model: this.model,
        appearance: this.appearance,
        background: this.background,
        image_url: this.imageUrl,
        ethnicity: this.ethnicity,
      },
    });

    checkResponse(response);

    $.export("$summary", "AI avatar photo created successfully");
    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
JoggAI	`joggai`	`app`	This component uses the JoggAI app.
Age	`age`	`string`	Select a value from the drop down menu:`TeenagerYoung adultAdultElderly`
Aspect Ratio	`aspectRatio`	`string`	Select a value from the drop down menu:`{ "label": "Portrait [9:16]", "value": "0" }{ "label": "Landscape [16:9]", "value": "1" }`
Avatar Style	`avatarStyle`	`string`	Select a value from the drop down menu:`ProfessionalSocial`
Gender	`gender`	`string`	Select a value from the drop down menu:`MaleFemale`
Model	`model`	`string`	Select a value from the drop down menu:`classicmodern`
Appearance	`appearance`	`string`	Appearance of the avatar.
Background	`background`	`string`	Background of the avatar.
Ethnicity	`ethnicity`	`string`	Select a value from the drop down menu:`EuropeanAfricanSouth AfricanEast AsianMiddle EasternSouth AmericanNorth American`
Image URL	`imageUrl`	`string`	URL of the image to use for the avatar.