View as Markdown
AltText.ai icon

AltText.ai ACTION

Generate Alt Text

Generates a descriptive alt text for a given image. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's AltText.ai account once, then configure and run Generate Alt Text 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: "alttext_ai-generate-alt-text",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    alttext_ai: { authProvisionId: "apn_xxxxxxx" },
    imageData: "Image Data",
    imageFilePath: "Image File Path or URL",
  },
})

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.

Generate Alt Text inputs
Property Type Description
imageData Image Data string
The image data in base64 format
Optional
imageFilePath Image File Path or URL string
The image to process. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myImage.jpg)
Optional
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.
Optional
negativeKeywords Negative Keywords 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.
Optional
keywordSource Keyword Source 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.
Optional
language Language string
The language for the generated alt text.
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
alttext_ai-generate-alt-text
Version
0.1.6
App
AltText.ai
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes