View as Markdown
AltTextify icon

AltTextify ACTION

Submit Image to Alttextify

Upload or submit an image to Alttextify for alt text generation. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's AltTextify account once, then configure and run Submit Image to Alttextify from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "alttextify-submit-image",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    alttextify: { authProvisionId: "apn_xxxxxxx" },
    async: true,
    image: "Image",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Submit Image to Alttextify inputs
Property Type Description
async Async boolean
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.
Required
image Image string
The URL of the file or path to the file saved to the /tmp directory. See the documentation on working with files
Required
lang Language string
The language for the alt text. Supported language codes are accepted. If not provided, the account's default language is used.
Required
maxChars Max Characters integer
Maximum length of the generated alt text.
Required
assetId Asset ID string
The unique identifier for the asset.
Optional
keywords Keywords string[]
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
ecommerceRunOCR Ecommerce Run OCR boolean
Flag to indicate if OCR should be run on the product.
Required
ecommerceProductName Ecommerce Product Name string
The name of the product in the image.
Optional
ecommerceProductBrand Ecommerce Product Brand string
The brand of the product in the image.
Optional
ecommerceProductColor Ecommerce Product Color string
The color of the product in the image.
Optional
ecommerceProductSize Ecommerce Product Size string
The size of the product in the image.
Optional
syncDir SyncDir dir
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
alttextify-submit-image
Version
0.0.5
App
AltTextify
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes