Images

Write an image's alt text

Asks AI for the alt text and suggested file name of a finished image: one sent with alt_text off, compressed before alt text existed, whose alt text failed, or skipped on a day that was used up. A written one can be asked again in another language. It counts one against your daily AI alt texts, unless an image with the same bytes already has one in that language, which is copied at once and costs nothing. The answer is the image; poll it until alt_text.status is no longer pending. While one is being written, asking again changes nothing.

post/images/{id}/alt-text

Request

  • Base URL: https://www.iminify.com/api/v1
  • URL: https://www.iminify.com/api/v1/images/{id}/alt-text
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The image's id.

Request body

alt_text_language'en' | 'es' | 'fr' | 'de' | 'it' | 'pt' | 'nl' | 'pl' | 'sv' | 'tr' | 'ru' | 'uk' | 'ar' | 'fa' | 'he' | 'hi' | 'id' | 'vi' | 'th' | 'ja' | 'ko' | 'zh-Hans' | 'zh-Hant'

The language to write the alt text in, as one of these tags: en (English), es (Spanish), fr (French), de (German), it (Italian), pt (Portuguese), nl (Dutch), pl (Polish), sv (Swedish), tr (Turkish), ru (Russian), uk (Ukrainian), ar (Arabic), fa (Persian), he (Hebrew), hi (Hindi), id (Indonesian), vi (Vietnamese), th (Thai), ja (Japanese), ko (Korean), zh-Hans (Simplified Chinese), zh-Hant (Traditional Chinese). The suggested file name follows it when the language is written in the Latin alphabet, and is in English otherwise.

use_suggested_nameboolean

Rename the optimized copy to the suggested file name as soon as the alt text arrives, unless it already has a new name by then: yours, or an earlier suggestion.

Response

Queued. Location points at the new record.

Changes

No recorded changes to this operation across all 1 revision of this API.