Generate Alt Text with AltText.ai API on New S3 Event from AWS API

Pipedream makes it easy to connect APIs for AltText.ai, AWS and 2,400+ other apps remarkably fast.

Trigger workflow on

New S3 Event from the AWS API

Next, do this

Generate Alt Text with the AltText.ai 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 AWS trigger and AltText.ai action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New S3 Event trigger
1. Connect your AWS account
2. Select a AWS Region
3. Select a S3 Bucket Name
4. Select one or more Event Types
Configure the Generate Alt Text action
1. Connect your AltText.ai account
2. Optional- Configure Image Data
3. Optional- Configure Image URL
4. Optional- Configure Image File Path
5. Optional- Configure Keywords
6. Optional- Configure Negative Keywords
7. Optional- Configure Keyword Source
8. Optional- Select a Language
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 S3 Event on AWS

Description:Emit new S3 events for a given bucket

Version:0.1.2

Key:aws-s3-new-event

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import base from "../common/s3.mjs";

export default {
  ...base,
  type: "source",
  key: "aws-s3-new-event",
  name: "New S3 Event",
  description: "Emit new S3 events for a given bucket",
  version: "0.1.2",
  dedupe: "unique",
  props: {
    ...base.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to watch",
      options: [
        // See the AWS docs for more information about the supported events emitted by S3: https://amzn.to/3AtmKy1
        "s3:ObjectCreated:Put",
        "s3:ObjectCreated:Post",
        "s3:ObjectCreated:Copy",
        "s3:ObjectCreated:CompleteMultipartUpload",
        "s3:ObjectRemoved:Delete",
        "s3:ObjectRemoved:DeleteMarkerCreated",
        "s3:ObjectRestore:Post",
        "s3:ObjectRestore:Completed",
        "s3:ReducedRedundancyLostObject",
        "s3:Replication:OperationFailedReplication",
        "s3:Replication:OperationMissedThreshold",
        "s3:Replication:OperationReplicatedAfterThreshold",
        "s3:Replication:OperationNotTracked",
      ],
    },
  },
  methods: {
    ...base.methods,
    getEvents() {
      return this.eventTypes;
    },
    generateMeta(data) {
      const { "x-amz-request-id": id } = data.responseElements;
      const { key } = data.s3.object;
      const {
        eventTime: isoTimestamp,
        eventName,
      } = data;
      return {
        id,
        summary: `'${eventName}' for '${key}'`,
        ts: Date.parse(isoTimestamp),
      };
    },
  },
};

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
AWS	`aws`	`app`	This component uses the AWS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
AWS Region	`region`	`string`	Select a value from the drop down menu.
S3 Bucket Name	`bucket`	`string`	Select a value from the drop down menu.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu:`s3:ObjectCreated:Puts3:ObjectCreated:Posts3:ObjectCreated:Copys3:ObjectCreated:CompleteMultipartUploads3:ObjectRemoved:Deletes3:ObjectRemoved:DeleteMarkerCreateds3:ObjectRestore:Posts3:ObjectRestore:Completeds3:ReducedRedundancyLostObjects3:Replication:OperationFailedReplications3:Replication:OperationMissedThresholds3:Replication:OperationReplicatedAfterThresholds3:Replication:OperationNotTracked`

Trigger Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Generate Alt Text on AltText.ai

Description:Generates a descriptive alt text for a given image. [See the documentation](https://alttext.ai/apidocs#tag/Images/operation/create-image)

Version:0.0.1

Key:alttext_ai-generate-alt-text

View on GitHub

AltText.ai Overview#

AltText.ai provides an API that leverages artificial intelligence to generate alternative text (alt text) for images, which is crucial for web accessibility and SEO. With AltText.ai, you can automate the process of creating descriptive, keyword-rich, and meaningful alt text for images on websites, blogs, or online stores. In Pipedream, you can create workflows that trigger on various events to send images to the AltText.ai API and receive alt text, which you can then store or apply to your content management system automatically.

Action Code#

import alttextAi from "../../alttext_ai.app.mjs";
import fs from "fs";
import { LANGUAGE_OPTIONS } from "../../commons/constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "alttext_ai-generate-alt-text",
  name: "Generate Alt Text",
  description:
    "Generates a descriptive alt text for a given image. [See the documentation](https://alttext.ai/apidocs#tag/Images/operation/create-image)",
  version: "0.0.1",
  type: "action",
  props: {
    alttextAi,
    imageData: {
      type: "string",
      label: "Image Data",
      description:
        "The image data in base64 format. Only one of `Image Data`, `Image File Path` or `Image URL` should be specified.",
      optional: true,
    },
    imageUrl: {
      type: "string",
      label: "Image URL",
      description:
        "The public URL to an image. Only one of `Image URL`, `Image Data` or `Image File Path` should be specified.",
      optional: true,
    },
    imageFilePath: {
      type: "string",
      label: "Image File Path",
      description:
        "The path to an image file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#the-tmp-directory). Only one of `Image File Path`, `Image URL` or `Image Data` should be specified.",
      optional: true,
    },
    keywords: {
      type: "string[]",
      label: "Keywords",
      description:
        "Keywords / phrases to be considered when generating the alt text. Keywords must be in English, even if requesting alt text in another language. Max 6 items.",
      optional: true,
    },
    negativeKeywords: {
      type: "string[]",
      label: "Negative Keywords",
      description:
        "Negative keywords / phrases to be removed from any generated alt text. Negative keywords must be in English, even if requesting alt text in another language. Max 6 items.",
      optional: true,
    },
    keywordSource: {
      type: "string",
      label: "Keyword Source",
      description:
        "Text to use as the source of keywords for the alt text. Will only be used if `Keywords` is not provided. This text might be a product description, or a paragraph that describes the context of the images, etc. Max 1024 characters.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "The language for the generated alt text.",
      options: LANGUAGE_OPTIONS,
      default: "en",
      optional: true,
    },
  },
  async run({ $ }) {
    if (
      (!this.imageData && !this.imageFilePath && !this.imageUrl)
      || (this.imageData && this.imageFilePath)
      || (this.imageData && this.imageUrl)
      || (this.imageFilePath && this.imageUrl)
    ) {
      throw new ConfigurationError("Only one of `Image Data`, `Image File Path` or `Image URL` should be specified.");
    }

    const response = await this.alttextAi.generateAltText({
      $,
      data: {
        image: {
          url: this.imageUrl,
          raw:
            this.imageData ??
            (this.imageFilePath &&
              fs.readFileSync(
                this.imageFilePath.includes("tmp/")
                  ? this.imageFilePath
                  : `/tmp/${this.imageFilePath}`,
                {
                  encoding: "base64",
                },
              )),
        },
        keywords: this.keywords,
        negative_keywords: this.negativeKeywords,
        keyword_source: this.keywordSource,
        lang: this.language,
      },
    });

    $.export("$summary", "Generated alt text 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
AltText.ai	`alttextAi`	`app`	This component uses the AltText.ai app.
Image Data	`imageData`	`string`	The image data in base64 format. Only one of `Image Data`, `Image File Path` or `Image URL` should be specified.
Image URL	`imageUrl`	`string`	The public URL to an image. Only one of `Image URL`, `Image Data` or `Image File Path` should be specified.
Image File Path	`imageFilePath`	`string`	The path to an image file in the `/tmp` directory. See the documentation on working with files. Only one of `Image File Path`, `Image URL` or `Image Data` should be specified.
Keywords	`keywords`	`string[]`	Keywords / phrases to be considered when generating the alt text. Keywords must be in English, even if requesting alt text in another language. Max 6 items.
Negative Keywords	`negativeKeywords`	`string[]`	Negative keywords / phrases to be removed from any generated alt text. Negative keywords must be in English, even if requesting alt text in another language. Max 6 items.
Keyword Source	`keywordSource`	`string`	Text to use as the source of keywords for the alt text. Will only be used if `Keywords` is not provided. This text might be a product description, or a paragraph that describes the context of the images, etc. Max 1024 characters.
Language	`language`	`string`	Select a value from the drop down menu:`{ "label": "Afrikaans", "value": "af" }{ "label": "Albanian", "value": "sq" }{ "label": "Amharic", "value": "am" }{ "label": "Arabic", "value": "ar" }{ "label": "Armenian", "value": "hy" }{ "label": "Assamese", "value": "as" }{ "label": "Aymara", "value": "ay" }{ "label": "Azerbaijani", "value": "az" }{ "label": "Bambara", "value": "bm" }{ "label": "Basque", "value": "eu" }{ "label": "Belarusian", "value": "be" }{ "label": "Bengali", "value": "bn" }{ "label": "Bhojpuri", "value": "bho" }{ "label": "Bosnian", "value": "bs" }{ "label": "Bulgarian", "value": "bg" }{ "label": "Catalan", "value": "ca" }{ "label": "Cebuano", "value": "ceb" }{ "label": "Chinese (Simplified)", "value": "zh-CN" }{ "label": "Chinese (Traditional)", "value": "zh-TW" }{ "label": "Corsican", "value": "co" }{ "label": "Croatian", "value": "hr" }{ "label": "Czech", "value": "cs" }{ "label": "Danish", "value": "da" }{ "label": "Dhivehi", "value": "dv" }{ "label": "Dogri", "value": "doi" }{ "label": "Dutch", "value": "nl" }{ "label": "English", "value": "en" }{ "label": "Esperanto", "value": "eo" }{ "label": "Estonian", "value": "et" }{ "label": "Ewe", "value": "ee" }{ "label": "Filipino (Tagalog)", "value": "fil" }{ "label": "Finnish", "value": "fi" }{ "label": "French", "value": "fr" }{ "label": "Frisian", "value": "fy" }{ "label": "Galician", "value": "gl" }{ "label": "Georgian", "value": "ka" }{ "label": "German", "value": "de" }{ "label": "Greek", "value": "el" }{ "label": "Guarani", "value": "gn" }{ "label": "Gujarati", "value": "gu" }{ "label": "Haitian Creole", "value": "ht" }{ "label": "Hausa", "value": "ha" }{ "label": "Hawaiian", "value": "haw" }{ "label": "Hebrew", "value": "he" }{ "label": "Hindi", "value": "hi" }{ "label": "Hmong", "value": "hmn" }{ "label": "Hungarian", "value": "hu" }{ "label": "Icelandic", "value": "is" }{ "label": "Igbo", "value": "ig" }{ "label": "Ilocano", "value": "ilo" }{ "label": "Indonesian", "value": "id" }{ "label": "Irish", "value": "ga" }{ "label": "Italian", "value": "it" }{ "label": "Japanese", "value": "ja" }{ "label": "Javanese", "value": "jv" }{ "label": "Kannada", "value": "kn" }{ "label": "Kazakh", "value": "kk" }{ "label": "Khmer", "value": "km" }{ "label": "Kinyarwanda", "value": "rw" }{ "label": "Konkani", "value": "gom" }{ "label": "Korean", "value": "ko" }{ "label": "Krio", "value": "kri" }{ "label": "Kurdish", "value": "ku" }{ "label": "Kurdish (Sorani)", "value": "ckb" }{ "label": "Kyrgyz", "value": "ky" }{ "label": "Lao", "value": "lo" }{ "label": "Latin", "value": "la" }{ "label": "Latvian", "value": "lv" }{ "label": "Lingala", "value": "ln" }{ "label": "Lithuanian", "value": "lt" }{ "label": "Luganda", "value": "lg" }{ "label": "Luxembourgish", "value": "lb" }{ "label": "Macedonian", "value": "mk" }{ "label": "Maithili", "value": "mai" }{ "label": "Malagasy", "value": "mg" }{ "label": "Malay", "value": "ms" }{ "label": "Malayalam", "value": "ml" }{ "label": "Maltese", "value": "mt" }{ "label": "Maori", "value": "mi" }{ "label": "Marathi", "value": "mr" }{ "label": "Meiteilon (Manipuri)", "value": "mni-Mtei" }{ "label": "Mizo", "value": "lus" }{ "label": "Mongolian", "value": "mn" }{ "label": "Myanmar (Burmese)", "value": "my" }{ "label": "Nepali", "value": "ne" }{ "label": "Norwegian", "value": "no" }{ "label": "Nyanja (Chichewa)", "value": "ny" }{ "label": "Odia (Oriya)", "value": "or" }{ "label": "Oromo", "value": "om" }{ "label": "Pashto", "value": "ps" }{ "label": "Persian", "value": "fa" }{ "label": "Polish", "value": "pl" }{ "label": "Portuguese", "value": "pt" }{ "label": "Punjabi", "value": "pa" }{ "label": "Quechua", "value": "qu" }{ "label": "Romanian", "value": "ro" }{ "label": "Russian", "value": "ru" }{ "label": "Samoan", "value": "sm" }{ "label": "Sanskrit", "value": "sa" }{ "label": "ScotsGaelic", "value": "gd" }{ "label": "Sepedi", "value": "nso" }{ "label": "Serbian", "value": "sr" }{ "label": "Sesotho", "value": "st" }{ "label": "Shona", "value": "sn" }{ "label": "Sindhi", "value": "sd" }{ "label": "Sinhala (Sinhalese)", "value": "si" }{ "label": "Slovak", "value": "sk" }{ "label": "Slovenian", "value": "sl" }{ "label": "Somali", "value": "so" }{ "label": "Spanish", "value": "es" }{ "label": "Sundanese", "value": "su" }{ "label": "Swahili", "value": "sw" }{ "label": "Swedish", "value": "sv" }{ "label": "Tagalog (Filipino)", "value": "tl" }{ "label": "Tajik", "value": "tg" }{ "label": "Tamil", "value": "ta" }{ "label": "Tatar", "value": "tt" }{ "label": "Telugu", "value": "te" }{ "label": "Thai", "value": "th" }{ "label": "Tigrinya", "value": "ti" }{ "label": "Tsonga", "value": "ts" }{ "label": "Turkish", "value": "tr" }{ "label": "Turkmen", "value": "tk" }{ "label": "Twi (Akan)", "value": "ak" }{ "label": "Ukrainian", "value": "uk" }{ "label": "Urdu", "value": "ur" }{ "label": "Uyghur", "value": "ug" }{ "label": "Uzbek", "value": "uz" }{ "label": "Vietnamese", "value": "vi" }{ "label": "Welsh", "value": "cy" }{ "label": "Xhosa", "value": "xh" }{ "label": "Yiddish", "value": "yi" }{ "label": "Yoruba", "value": "yo" }{ "label": "Zulu", "value": "zu" }`

Action Authentication#

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

About AltText.ai#

Automatically generate alt text for images in over 130 languages. Improve SEO and site accessibility. Integrations for WordPress, Shopify, web, CMS, and more.

More Ways to Connect AltText.ai + AWS#

Other Popular Integrations#

Generate Alt Text with AltText.ai API on New Records Returned by CloudWatch Logs Insights Query from AWS API

AWS + AltText.ai

Generate Alt Text with AltText.ai API on New S3 Event from AWS API

Pipedream makes it easy to connect APIs for AltText.ai, AWS 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