Skip to content

documentation.mdx

Latest commit

 

History

History
115 lines (83 loc) · 3.66 KB

documentation.mdx

File metadata and controls

115 lines (83 loc) · 3.66 KB
Raw
title Documentation
description Welcome to Alt Magic documentation - Learn how to use our AI-powered alt text generation service

Documentation

Welcome to Alt Magic documentation! Learn how to use our AI-powered service to generate descriptive, SEO-optimized alt text for your images.

🚀 Getting Started

What is Alt Magic?

Alt Magic is an AI-powered service that automatically generates descriptive alt text for images. Our service uses advanced AI models with automatic fallback to ensure reliable alt text generation for accessibility and SEO.

Key Benefits

  • 🤖 AI-Powered: Uses Gemini API with automatic OpenAI fallback
  • 💳 Credit-Based: Pay only for what you use
  • ⚡ Fast: Generate alt text in seconds
  • 🌍 Multi-Language: Support for 200+ languages
  • 🔒 Secure: API key authentication with rate limiting

📚 What You'll Learn

Getting Started

  • Quick Start Guide - Get up and running in minutes
  • API Key Generation - Create your first API key
  • First API Call - Make your first request

Core Concepts

  • API Keys - Learn about API key security and usage
  • Rate Limits - Understand usage limits and best practices
  • Error Handling - Handle errors gracefully in your applications
  • Language Support - Generate alt text in 200+ languages

Advanced Topics

  • SDK Integration - Use our official SDKs
  • Best Practices - Optimize your implementation
  • Troubleshooting - Common issues and solutions

🌍 Language Support

The Alt Magic API supports 200+ languages for generating alt text in your preferred language.

Popular Languages:

  • English (en) - Default language (fallback when no language specified)
  • Spanish (es) - Español
  • French (fr) - Français
  • German (de) - Deutsch
  • Chinese (zh-CN, zh-TW) - 中文
  • Japanese (ja) - 日本語
  • Korean (ko) - 한국어
  • Arabic (ar) - العربية
  • Hindi (hi) - हिन्दी
  • Portuguese (pt, pt-BR) - Português

View complete language list →

🎯 Use Cases

E-commerce

  • Product image descriptions
  • Category page optimization
  • Search result enhancement

Content Marketing

  • Blog post images
  • Social media content
  • Newsletter graphics

Accessibility

  • Screen reader support
  • WCAG compliance
  • Inclusive design

SEO Optimization

  • Image search optimization
  • Alt text for better rankings
  • Contextual descriptions

🔧 Quick Start

  1. Generate your API key - Create your first API key
  2. Read the API introduction - Understand the basics
  3. Try the alt text endpoint - Generate your first alt text
  4. Review error handling in the introduction for robust integration

💰 Pricing

  • 1 Credit = 1 Alt Text Generation
  • No Monthly Fees - pay only for what you use
  • Bulk Discounts available for high-volume users

Plans

Plan Credits Price Rate Limit
Starter 100 $9.99 100/min
Pro 1,000 $49.99 500/min
Enterprise Custom Custom Custom

🆘 Need Help?

  • Support: advait@altmagic.pro
  • Documentation: Browse the sections below
  • API Reference: Check the API Reference tab for detailed endpoint documentation

📖 Next Steps

Ready to dive in? Start with our Quick Start Guide to generate your first API key and make your first API call.

Alt Magic - Making images accessible, one alt text at a time.