ACME API Documentation logo

Generate Alt Text

Create AI-generated alt text for your images

POSThttps://api.acme.com/api/generate/altText
Available on Premium, Business, Enterprise plans.Max Pack required

Create AI-generated alt text for your images. Choose the language to write the alt text and keywords to include in the alt text.

Header Parameters

Authorizationstringrequired
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY

Body Parameters

urlstringrequired

Image URL of the image to create the alt text. Must start with https://. Supports JPEG, PNG, GIF, WEBP, and BMP.

keywordsarray

String array of keywords or phrases to be considered when generating the alt text. Typically only one or two of the keywords from the array will be used in the alt text.

langstring

Language to output the alt text. Use one of the available language codes.

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"url": "https://img.acme.com/012/gb.jpg"}' \
-X POST https://api.acme.com/api/generate/altText
{
    "status": "success",
    "altText": "A ghostbusters vehicle driving through a field.",
    "url": "https://img.acme.com/012/gb.jpg"
}