← Back to Home

🔌 API Documentation

Alt-Words AI RESTful API for generating SEO-optimized image alt text.

📑 Table of Contents

🔐 Authentication

API requests can be made without authentication for free tier (100 images/month). For higher limits, include your API key:

Authorization: Bearer YOUR_API_KEY

Generate Alt Text

POST https://api.altwordsai.com/api/generate

Generate SEO-optimized alt text for a single image.

Request Body

ParameterTypeDescription
image_url *stringURL of the image
languagestringOutput language: en, zh, ja, ko, es, fr, de (default: en)
stylestringseo | descriptive | simple (default: seo)
tierstringfree | standard | quality | premium (default: free)

Example Request

curl -X POST https://api.altwordsai.com/api/generate \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://example.com/photo.jpg",
    "language": "en",
    "style": "seo"
  }'

Example Response

{
  "alt_text": "Professional laptop on wooden desk with code editor open",
  "cached": false,
  "language": "en",
  "style": "seo",
  "tier": "free",
  "model": "gemini-2.0-flash-lite-001"
}

Batch Generate

POST https://api.altwordsai.com/api/batch

Generate alt text for multiple images (max 10 per request).

Request Body

{
  "images": [
    "https://example.com/image1.jpg",
    "https://example.com/image2.jpg"
  ],
  "language": "en",
  "style": "seo",
  "tier": "standard"
}

Site Scanner FREE

POST https://api.altwordsai.com/api/scan

Scan a website for images and check alt text status. Completely free!

Request Body

ParameterTypeDescription
url *stringWebsite URL to scan
maxImagesnumberMax images to return (default: 50)

Example Response

{
  "success": true,
  "summary": {
    "total_images": 25,
    "with_alt": 20,
    "without_alt": 5,
    "seo_score": 80,
    "seo_grade": "B"
  },
  "images": [...],
  "recommendations": [...],
  "cost_estimate": {
    "images_needing_alt": 5,
    "total_estimate": "$0.0005"
  }
}

Generate for Scan Results

POST https://api.altwordsai.com/api/scan/generate

Generate alt text for images from scan results (max 20 per request).

{
  "images": ["https://example.com/img1.jpg", "https://example.com/img2.jpg"],
  "language": "zh",
  "style": "seo"
}

Check Usage

GET https://api.altwordsai.com/api/usage

Check your daily usage and remaining quota.

{
  "date": "2026-02-06",
  "used": 45,
  "limit": 100,
  "remaining": 55
}

💰 Pricing

TierModelCost per ImageBest For
freeLlama 3.2 Vision~$0.00005Testing, low volume
standardGemini Flash Lite~$0.0001Production use
qualityGemini 2.5 Flash~$0.0003Higher quality
premiumGPT-4o-mini~$0.001Best quality

Questions? Contact us at support@altwordsai.com