Skip to main content

​
Welcome

The GistMag API provides powerful AI-driven services for:
  • Alt Text Generation: Generate accurate, descriptive alt text for images
  • Text-to-Speech: Convert text to natural-sounding speech with advanced features
  • Batch Processing: Process multiple items efficiently
  • Usage Management: Track and manage your API usage

​
Base URL

All API requests should be made to: 
https://api.gistmag.co.uk

​
Authentication

All API endpoints require authentication using an API key. Include your API key in the request body or as a query parameter.
API keys can be created and managed in your Dashboard.

​
Response Format

All API responses are returned in JSON format, except for audio endpoints which return audio files.

​
Success Response

{
  "alt_text": "A beautiful sunset over the ocean",
  "confidence": 0.95
}

​
Error Response

{
  "error": "Invalid API key",
  "message": "The provided API key is not valid"
}

​
Rate Limits

API rate limits are based on your subscription tier:
  • Free Tier: 100 requests/day
  • Pro Tier: 10,000 requests/day
  • Enterprise: Custom limits
Rate limit information is included in response headers: 
X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 9995
X-RateLimit-Reset: 1640995200

​
Status Codes

The API uses standard HTTP status codes:
  • 200 - Success
  • 400 - Bad Request (invalid parameters)
  • 401 - Unauthorized (invalid API key)
  • 429 - Too Many Requests (rate limit exceeded)
  • 500 - Internal Server Error
  • 503 - Service Unavailable

​
Support

Need help? Contact us at support@gistmag.co.uk or visit our Dashboard.