# Generate Alt Text — AltText.ai

> Generates a descriptive alt text for a given image. See the documentation

- Key: `alttext_ai-generate-alt-text`
- Type: Action (Write)
- Version: 0.1.6
- App: AltText.ai (`alttext_ai`) — https://pipedream.com/apps/alttext-ai.md
- This page (HTML): https://pipedream.com/apps/alttext-ai/actions/generate-alt-text
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/alttext_ai/actions/generate-alt-text/generate-alt-text.mjs

## Description

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

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `imageData` | `string` | No | The image data in base64 format |
| `imageFilePath` | `string` | No | The image to process. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myImage.jpg) |
| `keywords` | `string[]` | No | 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. |
| `negativeKeywords` | `string[]` | No | 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. |
| `keywordSource` | `string` | No | 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` | `string` | No | The language for the generated alt text. |
| `syncDir` | `dir` | No | SyncDir |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "alttext_ai",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "alttext_ai-generate-alt-text",
  arguments: {
    imageData: "Image Data",
    imageFilePath: "Image File Path or URL",
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "alttext_ai-generate-alt-text",
    "configured_props": {
      "alttext_ai": { "authProvisionId": "apn_xxxxxxx" },
      "imageData": "Image Data",
      "imageFilePath": "Image File Path or URL"
    }
  }'
```

---

- App: https://pipedream.com/apps/alttext-ai.md · All apps: https://pipedream.com/apps