# AltText.ai

AltText.ai is a service that automatically generates alt text for images, enhancing accessibility and SEO.

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Tools:** 5
- **Triggers:** 0
- **Slug:** `ALTTEXT_AI`
- **Version:** 20260211_00

## Tools

### Get Account

**Slug:** `ALTTEXT_AI_ALT_TEXT_AI_GET_ACCOUNT`

Tool to retrieve account settings and usage information. Use when you need to check your AltText.ai account configuration and usage limits before generating alt text.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Create Images

**Slug:** `ALTTEXT_AI_CREATE_BULK_IMAGES`

Tool to bulk upload and process a CSV file of image URLs for alt text generation. Use when you need to process multiple images at once (up to 100,000 URLs). Invalid rows are returned in row_errors for debugging.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV file containing image URLs to process. FileUploadable object where 'name' is the filename (e.g., 'images.csv'). The CSV should have a 'url' column with image URLs. Maximum 100000 rows. |
| `email` | string | No | Optional email address to receive results of the bulk upload when processing is complete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Image

**Slug:** `ALTTEXT_AI_CREATE_IMAGE`

Tool to add an image and generate alt text. Supports both URL and base64-encoded file upload. Use when you need to generate alt text for images, with options for custom prompts, keywords, multiple languages, and ecommerce data. Rate limited to 4 calls per second.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Language code(s) for alt text generation. Use comma-separated values for multiple languages (e.g., 'en,es,fr'). Default is 'en'. |
| `ecomm` | object | No | Ecommerce data for product images. |
| `image` | object | Yes | Image data object containing URL or base64-encoded data. Either url or raw field must be provided. |
| `keywords` | array | No | Keywords or phrases for SEO-optimized alt text. Maximum 6 items. |
| `max_chars` | integer | No | Maximum length of generated alt text. Must be between 80 and 500 characters. |
| `overwrite` | boolean | No | Force regeneration of alt text for existing image. Default false. |
| `async_mode` | boolean | No | Whether to add the image in the background. If true, returns immediately with processing status. Default false. |
| `gpt_prompt` | string | No | ChatGPT prompt to apply to generated alt text. Use {{AltText}} macro to reference the initial alt text. |
| `model_name` | string ("describe-detailed" | "describe-regular" | "describe-factual" | "succinct-describe-factual" | "describe-terse") | No | Available language models for alt text generation. |
| `webhook_url` | string | No | Alternative webhook URL for this operation to receive async notifications |
| `timeout_secs` | integer | No | Maximum timeout in seconds for alt text generation. Must be between 5 and 30 seconds. Default is 12. |
| `keyword_source` | string | No | Text source for extracting keywords if keywords array is blank |
| `negative_keywords` | array | No | Keywords to remove from generated alt text. Maximum 6 items. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Image by Asset ID

**Slug:** `ALTTEXT_AI_DELETE_IMAGE_BY_ASSET_ID`

Tool to delete an image from your library by its asset ID. Use when you need to remove a specific image permanently from your AltText.ai account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asset_id` | string | Yes | The asset ID of the image to delete from your library. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account

**Slug:** `ALTTEXT_AI_GET_ACCOUNT`

Tool to retrieve account settings and usage information. Use when you need to check your AltText.ai account configuration and usage limits before generating alt text.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Image by Asset ID

**Slug:** `ALTTEXT_AI_GET_IMAGE_BY_ASSET_ID`

Tool to retrieve detailed information about a specific image using its asset ID. Use when you need to fetch alt text, metadata, or status of a previously processed image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asset_id` | string | Yes | The unique asset ID of the image to retrieve. This is returned when creating or listing images. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Images

**Slug:** `ALTTEXT_AI_GET_IMAGES`

Tool to retrieve a paginated list of images in your library, including their alt text and metadata. Use when you need to browse or filter images programmatically after authentication.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Exact URL to filter images by. Must match the stored image URL exactly; no wildcards. |
| `page` | integer | No | Page number to retrieve, starting at 1. |
| `limit` | integer | No | Number of images per page (max 100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Scrape Page for Images

**Slug:** `ALTTEXT_AI_SCRAPE_PAGE`

Tool to scrape a web page or HTML document and queue all images for alt text generation. Images are processed asynchronously. Does not execute JavaScript. Use when you need to batch-process images from a website or HTML content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Language code(s) for alt text generation. Use comma-separated values for multiple languages (e.g., 'en,es'). |
| `keywords` | array | No | Keywords for SEO-optimized alt text. Maximum 6 items. Must be in English. |
| `page_scrape` | object | Yes | Page scrape configuration containing URL or HTML to process. |
| `include_existing` | boolean | No | If true, process images that already have alt text. Defaults to false if not specified. |
| `negative_keywords` | array | No | Keywords to exclude from generated alt text. Maximum 6 items. Must be in English. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Images

**Slug:** `ALTTEXT_AI_SEARCH_IMAGES`

Search for images in your AltText.ai library by keywords. Searches through your previously processed images to find matches based on URLs, alt text content, and metadata. Useful for finding specific images in large libraries. Returns paginated results with alt text and metadata. Note: This searches your own image library, not a public image database. Images must be added via the Create Image endpoint before they can be searched.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for paginated results, starting at 1. |
| `query` | string | Yes | Search keywords or phrase to find images in your library. Searches against image URLs, alt text content, and associated metadata. |
| `per_page` | integer | No | Number of results to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Account

**Slug:** `ALTTEXT_AI_UPDATE_ACCOUNT`

Tool to update account settings (e.g., webhook_url, name). Use after confirming current account details to modify settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account` | object | Yes | Account settings to update, nested object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Image by Asset ID

**Slug:** `ALTTEXT_AI_UPDATE_IMAGE_BY_ASSET_ID`

Tool to update an image with new data including asset ID, alt text, and metadata. Use when you need to modify existing image information. Note: You cannot update the URL of an existing image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Language code(s) for the updated alt text. |
| `image` | object | Yes | Image data to update. Note: You cannot update the URL of an existing image. |
| `asset_id` | string | Yes | The asset ID of the image to update. |
| `overwrite` | boolean | No | Whether to overwrite existing alt text. Default false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
