Documentation

Alt Audit Documentation

Complete guide to integrating Alt Audit into your workflow with WordPress plugin setup, API integration, and best practices.

Getting Started

Quick Start

Get up and running with Alt Audit in under 5 minutes:

  1. Create your free account (25 credits included)
  2. Install the WordPress plugin or get your API key
  3. Start generating perfect alt text automatically

Account Setup

Your Alt Audit account comes with everything you need to get started:

  • 25 free credits - No credit card required
  • WordPress plugin access - Available immediately
  • API access - Generate tokens from your dashboard
  • Usage analytics - Track your accessibility improvements

How Credits Work

Understanding the credit system:

  • 1 1 credit = 1 image processed - Simple and transparent
  • ✓ Credits reset monthly for subscription plans
  • ∞ One-time credit packs never expire

WordPress Plugin Setup

Download Plugin

Download the latest version of the Alt Audit WordPress plugin from WordPress.org:

Download from WordPress.org

Compatible with WordPress 6.2+ • PHP 7.4+

Installation Steps

Step 1: Install the Plugin

  1. Download the alt-audit.zip file
  2. Go to your WordPress admin dashboard
  3. Navigate to Plugins > Add New
  4. Click "Upload Plugin" and select the zip file
  5. Click "Install Now" and then "Activate"

Step 2: Connect Your Account

  1. Go to Settings > Alt Audit in your WordPress admin
  2. Enter your Alt Audit email address
  3. Click "Connect Account"
  4. Follow the verification process (check your email)
  5. Your API key will be automatically configured

Step 3: Configure Settings

Customize the plugin behavior:

  • Auto-generate on upload - Automatically process new images
  • Process existing images - Bulk process your media library
  • Smart detection - Only process public-facing images

Plugin Features

Automatic Processing

  • • Alt text generated on image upload
  • • Works with media library uploads
  • • Compatible with page builders
  • • Supports drag-and-drop uploads

Bulk Processing

  • • Process existing media library
  • • Filter by date range
  • • Skip images with existing alt text
  • • Progress tracking and reporting

Smart Detection

  • • Identifies public vs private images
  • • Skips admin/backend images
  • • Optimizes credit usage
  • • Customizable detection rules

Usage Tracking

  • • Credit usage dashboard
  • • Processing history
  • • Image processing status
  • • Monthly usage reports

Troubleshooting

WordPress Plugin Issues

Plugin activation fails

  • Ensure WordPress version 5.0 or higher
  • Check PHP version (7.4+ required)
  • Verify write permissions in wp-content/plugins/
  • Deactivate conflicting plugins temporarily

Images not processing automatically

  • Check API connection in Settings > Alt Audit
  • Verify you have credits remaining
  • Ensure "Auto-generate" is enabled
  • Check if images are publicly accessible

Bulk processing stuck

  • Refresh the page and check progress
  • Reduce batch size in settings
  • Check server timeout limits
  • Contact support if issue persists

API Integration Issues

Authentication errors

  • Verify API token is correct and active
  • Check Authorization header format
  • Regenerate API token if necessary
  • Ensure token has sufficient permissions

Image URL issues

  • Ensure image URLs are publicly accessible
  • Check for HTTPS requirements
  • Verify image format (JPG, PNG, GIF, WebP)
  • Confirm image size limits (max 10MB)

Rate limiting

  • Implement exponential backoff
  • Check rate limit headers in response
  • Consider upgrading plan for higher limits
  • Batch requests when possible

Need More Help?

Can't find the solution you're looking for?

Contact Support

Best Practices

Alt Text Quality

✅ Good Practices

  • • Keep descriptions concise but descriptive
  • • Focus on image purpose and context
  • • Include relevant keywords naturally
  • • Review AI-generated text for accuracy
  • • Consider the surrounding content

❌ Avoid These

  • • Starting with "Image of..." or "Picture of..."
  • • Overly lengthy descriptions
  • • Keyword stuffing
  • • Describing obvious visual elements only
  • • Using generic placeholder text

Credit Optimization

  • 1 Enable smart detection to avoid processing admin/backend images
  • 2 Review existing alt text before bulk processing to avoid duplicates
  • 3 Use selective processing for images that truly need alt text
  • 4 Monitor usage through the dashboard to track credit consumption

SEO Optimization

Keyword Integration

Alt Audit automatically includes relevant keywords, but you can enhance SEO by:

  • Reviewing generated alt text for brand keywords
  • Adding location-specific terms when relevant
  • Including product names and model numbers
  • Ensuring consistency with page content

Accessibility Compliance

Ensure your alt text meets accessibility standards:

  • Keep descriptions under 125 characters when possible
  • Focus on the image's purpose, not just appearance
  • Use empty alt text (alt="") for decorative images
  • Test with screen readers when possible

Still have questions? We're here to help!

Contact Support