Generate Alt Text

Generate alt text for a single image

POST /generate

Generate Alt Text

cURL

curl --request POST \
  --url https://api.example.com/generate \
  --header 'Content-Type: application/json' \
  --data '
{
  "image_url": "<string>",
  "api_key": "<string>",
  "mode": "<string>"
}
'

200

{
  "alt_text": "<string>",
  "confidence": 123,
  "credits_used": 123,
  "error": "<string>",
  "message": "<string>"
}

Overview

Generate accurate, descriptive alt text for a single image using advanced AI models.

Request Body

image_url · string · required

The URL of the image to generate alt text for

api_key · string · required

Your GistMag API key

mode · string · default: "short"

The length of alt text to generate. Options: short, long, seo

Example Request

curl -X POST https://api.gistmag.co.uk/generate \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://example.com/sunset.jpg",
    "api_key": "your_api_key_here",
    "mode": "short"
  }'

Response

alt_text · string

The generated alt text description

confidence · number

Confidence score (0-1) of the generated alt text

credits_used · number

Number of credits consumed for this request

Example Response

{
  "alt_text": "A beautiful sunset over the ocean with orange and pink hues",
  "confidence": 0.95,
  "credits_used": 1
}

Error Responses

error · string

Error type

message · string

Detailed error message

Common Errors

• 400 Bad Request: Invalid image URL or missing required parameters
• 401 Unauthorized: Invalid or missing API key
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error: Server error processing the request