← AltTextify

Submit Image to Alttextify with AltTextify API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Submit Image to Alttextify with the AltTextify API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Submit Image to Alttextify with the AltTextify API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Submit Image to Alttextify action
    1. Connect your AltTextify account
    2. Configure alert
    3. Configure Async
    4. Configure Image
    5. Configure Language
    6. Configure Max Characters
    7. Optional- Configure Asset ID
    8. Optional- Configure Keywords
    9. Configure Ecommerce Run OCR
    10. Optional- Configure Ecommerce Product Name
    11. Optional- Configure Ecommerce Product Brand
    12. Optional- Configure Ecommerce Product Color
    13. Optional- Configure Ecommerce Product Size
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Submit Image to Alttextify with AltTextify API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + AltTextify
 
Try it
Submit Image to Alttextify with AltTextify API on New Submission from Typeform API
Typeform + AltTextify
 
Try it
Submit Image to Alttextify with AltTextify API on New Submission (Instant) from Jotform API
Jotform + AltTextify
 
Try it
Submit Image to Alttextify with AltTextify API on New Scheduled Tasks from Pipedream API
Pipedream + AltTextify
 
Try it
Submit Image to Alttextify with AltTextify API on New Download Counts from npm API
npm + AltTextify
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Submit Image to Alttextify on AltTextify
Description:Upload or submit an image to Alttextify for alt text generation. [See the documentation](https://apidoc.alttextify.net/#api-Image-UploadRawImage)
Version:0.0.1
Key:alttextify-submit-image

Code

import { getFileStreamAndMetadata } from "@pipedream/platform";
import alttextify from "../../alttextify.app.mjs";

export default {
  key: "alttextify-submit-image",
  name: "Submit Image to Alttextify",
  description: "Upload or submit an image to Alttextify for alt text generation. [See the documentation](https://apidoc.alttextify.net/#api-Image-UploadRawImage)",
  version: "0.0.1",
  type: "action",
  props: {
    alttextify,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Supported formats: JPEG, PNG, GIF, WEBP, BMP\nMaximum file size: 16 MB\nMinimum dimensions: 50 x 50 (smaller images may not be able to generate alt text).",
    },
    async: {
      type: "boolean",
      label: "Async",
      description: "Whether to add the image in the background or immediately (synchronously). If async is set to true, the API response will always be successful with an empty response body.",
      default: false,
    },
    image: {
      type: "string",
      label: "Image",
      description: "The URL of the file or path to the file saved to the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
    },
    lang: {
      type: "string",
      label: "Language",
      description: "The language for the alt text. Supported language codes are accepted. If not provided, the account's default language is used.",
      default: "en",
    },
    maxChars: {
      type: "integer",
      label: "Max Characters",
      description: "Maximum length of the generated alt text.",
    },
    assetId: {
      type: "string",
      label: "Asset ID",
      description: "The unique identifier for the asset.",
      optional: true,
    },
    keywords: {
      type: "string[]",
      label: "Keywords",
      description: "List of keywords/phrases for SEO-optimized alt text. Only one or two will be used per alt text, but all are considered. Keywords must be in English, even for alt text in other languages.",
      optional: true,
    },
    ecommerceRunOCR: {
      type: "boolean",
      label: "Ecommerce Run OCR",
      description: "Flag to indicate if OCR should be run on the product.",
    },
    ecommerceProductName: {
      type: "string",
      label: "Ecommerce Product Name",
      description: "The name of the product in the image.",
      optional: true,
    },
    ecommerceProductBrand: {
      type: "string",
      label: "Ecommerce Product Brand",
      description: "The brand of the product in the image.",
      optional: true,
    },
    ecommerceProductColor: {
      type: "string",
      label: "Ecommerce Product Color",
      description: "The color of the product in the image.",
      optional: true,
    },
    ecommerceProductSize: {
      type: "string",
      label: "Ecommerce Product Size",
      description: "The size of the product in the image.",
      optional: true,
    },
  },
  methods: {
    async streamToBase64(stream) {
      return new Promise((resolve, reject) => {
        const chunks = [];

        stream.on("data", (chunk) => {
          chunks.push(chunk);
        });

        stream.on("end", () => {
          const buffer = Buffer.concat(chunks);
          resolve(buffer.toString("base64"));
        });

        stream.on("error", (err) => {
          reject(err);
        });
      });
    },
  },
  async run({ $ }) {
    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(this.image);
    const base64String = await this.streamToBase64(stream);

    const response = await this.alttextify.uploadImage({
      $,
      data: {
        async: this.async,
        image: `data:${metadata.contentType};base64,${base64String}`,
        lang: this.lang,
        maxChars: this.maxChars,
        assetId: this.assetId,
        keywords: this.keywords,
        ecommerce: {
          run_ocr: this.ecommerceRunOCR,
          product: {
            name: this.ecommerceProductName,
            brand: this.ecommerceProductBrand,
            color: this.ecommerceProductColor,
            size: this.ecommerceProductSize,
          },
        },
      },

    });

    $.export("$summary", `Successfully submitted image to Alttextify for alt text generation with Asset ID: ${response.asset_id}`);
    return response;
  },
};

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.
LabelPropTypeDescription
AltTextifyalttextifyappThis component uses the AltTextify app.
Asyncasyncboolean

Whether to add the image in the background or immediately (synchronously). If async is set to true, the API response will always be successful with an empty response body.

Imageimagestring

The URL of the file or path to the file saved to the /tmp directory. See the documentation on working with files

Languagelangstring

The language for the alt text. Supported language codes are accepted. If not provided, the account's default language is used.

Max CharactersmaxCharsinteger

Maximum length of the generated alt text.

Asset IDassetIdstring

The unique identifier for the asset.

Keywordskeywordsstring[]

List of keywords/phrases for SEO-optimized alt text. Only one or two will be used per alt text, but all are considered. Keywords must be in English, even for alt text in other languages.

Ecommerce Run OCRecommerceRunOCRboolean

Flag to indicate if OCR should be run on the product.

Ecommerce Product NameecommerceProductNamestring

The name of the product in the image.

Ecommerce Product BrandecommerceProductBrandstring

The brand of the product in the image.

Ecommerce Product ColorecommerceProductColorstring

The color of the product in the image.

Ecommerce Product SizeecommerceProductSizestring

The size of the product in the image.

Authentication

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

About AltTextify

AI Driven Alt Text Generation for Your Images

More Ways to Use AltTextify

Triggers

New Alt Text Generated from the AltTextify API

Emit new event when new alt text is generated for an image. See the documentation

 
Try it

Actions

Delete Image Alt Text with the AltTextify API

Delete the generated alt text for a specific image using the asset ID. See the documentation

 
Try it
Retrieve Alt Text by Asset ID with the AltTextify API

Retrieve alt text for a previously submitted image using the asset ID. See the documentation

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Cloud-based customer relationship management (CRM) platform that helps businesses manage sales, marketing, customer support, and other business activities, ultimately aiming to improve customer relationships and streamline operations.
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
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.