Write alt text
write_alt_textAsk AI for the alt text and a suggested file name of a finished image, for example one compressed with alt_text false or whose alt text failed. A written one can be asked again in another language. It counts one against the account's daily AI alt texts, unless an image with the same bytes already has one in that language. Then call get_image until alt_text.status is no longer pending.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The image's id. | |
| alt_text_language | No | The language to write the alt text in, as a language tag. English ("en") by default. The suggested file name follows it for languages written in the Latin alphabet and is in English otherwise. | |
| use_suggested_name | No | 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. Off by default. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The image's id. | |
| hint | No | What to do next, when the status alone does not say. | |
| name | No | The name the optimized copy downloads under. | |
| status | No | ||
| scan_id | No | The page scan that found it, if one did. | |
| alt_text | No | The AI alt text, or null when none was asked for. | |
| original | No | ||
| settings | No | ||
| optimized | No | Null until the image has finished. | |
| share_url | No | Its public page, once shared. | |
| created_at | No | ||
| source_url | No | The address it was fetched from: its address on the scanned page, or the url it was sent as. Null for a file. | |
| updated_at | No | ||
| saved_bytes | No | Negative when the optimized copy is larger. | |
| saved_percent | No |