Batch Generate Alt Text

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

import requests

url = "https://api.example.com/batch"

payload = {
    "api_key": "<string>",
    "images": [{}],
    "images.image_url": "<string>",
    "images.mode": "<string>",
    "images.language": "<string>",
    "images.source": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    api_key: '<string>',
    images: [{}],
    'images.image_url': '<string>',
    'images.mode': '<string>',
    'images.language': '<string>',
    'images.source': '<string>'
  })
};

fetch('https://api.example.com/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'api_key' => '<string>',
    'images' => [
        [
                
        ]
    ],
    'images.image_url' => '<string>',
    'images.mode' => '<string>',
    'images.language' => '<string>',
    'images.source' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/batch"

	payload := strings.NewReader("{\n  \"api_key\": \"<string>\",\n  \"images\": [\n    {}\n  ],\n  \"images.image_url\": \"<string>\",\n  \"images.mode\": \"<string>\",\n  \"images.language\": \"<string>\",\n  \"images.source\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/batch")
  .header("Content-Type", "application/json")
  .body("{\n  \"api_key\": \"<string>\",\n  \"images\": [\n    {}\n  ],\n  \"images.image_url\": \"<string>\",\n  \"images.mode\": \"<string>\",\n  \"images.language\": \"<string>\",\n  \"images.source\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"api_key\": \"<string>\",\n  \"images\": [\n    {}\n  ],\n  \"images.image_url\": \"<string>\",\n  \"images.mode\": \"<string>\",\n  \"images.language\": \"<string>\",\n  \"images.source\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "results": [
    {}
  ],
  "results[].alt_text": "<string>",
  "results[].short_alt_text": "<string>",
  "results[].long_alt_text": "<string>",
  "results[].seo_alt_text": "<string>",
  "results[].image_url": "<string>",
  "results[].generated_at": "<string>",
  "total": 123,
  "successful": 123,
  "failed": 123
}

POST

batch

Batch Generate Alt Text

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

import requests

url = "https://api.example.com/batch"

payload = {
    "api_key": "<string>",
    "images": [{}],
    "images.image_url": "<string>",
    "images.mode": "<string>",
    "images.language": "<string>",
    "images.source": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    api_key: '<string>',
    images: [{}],
    'images.image_url': '<string>',
    'images.mode': '<string>',
    'images.language': '<string>',
    'images.source': '<string>'
  })
};

fetch('https://api.example.com/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'api_key' => '<string>',
    'images' => [
        [
                
        ]
    ],
    'images.image_url' => '<string>',
    'images.mode' => '<string>',
    'images.language' => '<string>',
    'images.source' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/batch"

	payload := strings.NewReader("{\n  \"api_key\": \"<string>\",\n  \"images\": [\n    {}\n  ],\n  \"images.image_url\": \"<string>\",\n  \"images.mode\": \"<string>\",\n  \"images.language\": \"<string>\",\n  \"images.source\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/batch")
  .header("Content-Type", "application/json")
  .body("{\n  \"api_key\": \"<string>\",\n  \"images\": [\n    {}\n  ],\n  \"images.image_url\": \"<string>\",\n  \"images.mode\": \"<string>\",\n  \"images.language\": \"<string>\",\n  \"images.source\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"api_key\": \"<string>\",\n  \"images\": [\n    {}\n  ],\n  \"images.image_url\": \"<string>\",\n  \"images.mode\": \"<string>\",\n  \"images.language\": \"<string>\",\n  \"images.source\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "results": [
    {}
  ],
  "results[].alt_text": "<string>",
  "results[].short_alt_text": "<string>",
  "results[].long_alt_text": "<string>",
  "results[].seo_alt_text": "<string>",
  "results[].image_url": "<string>",
  "results[].generated_at": "<string>",
  "total": 123,
  "successful": 123,
  "failed": 123
}

Overview

Process multiple images efficiently in a single API call. This is ideal for bulk processing or when you need to generate alt text for multiple images at once.

Request Body

string

required

Your GistMag API key

array<object>

required

Array of image objects to process. Each object must contain at least image_url.

string

required

The URL of the image

string

default:"short"

The length of alt text for this specific image. Options: short, long, seo

string

Language code for this specific image (default: en)

string

Source identifier for tracking (web, api, extension, wordpress, shopify, batch)

Example Request

curl -X POST https://api.gistmag.co.uk/batch \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "your_api_key_here",
    "images": [
      {
        "image_url": "https://example.com/image1.jpg",
        "mode": "short"
      },
      {
        "image_url": "https://example.com/image2.jpg",
        "mode": "long"
      },
      {
        "image_url": "https://example.com/image3.jpg",
        "mode": "seo"
      }
    ]
  }'

Response

array

Array of alt text responses for each image

string

The generated alt text based on the selected mode

string

Short version of alt text (if mode was short or all modes requested)

string

Long version of alt text (if mode was long or all modes requested)

string

SEO-optimized version of alt text (if mode was seo or all modes requested)

string

The original image URL

string

ISO timestamp of when the alt text was generated

number

Total number of images processed

number

Number of successfully processed images

number

Number of images that failed to process

Example Response

{
  "results": [
    {
      "alt_text": "A beautiful sunset over the ocean",
      "short_alt_text": "Sunset over ocean",
      "long_alt_text": "A beautiful sunset over the ocean with orange and pink hues reflecting on the water",
      "seo_alt_text": "Sunset over ocean - beach photography - nature scene",
      "image_url": "https://example.com/image1.jpg",
      "generated_at": "2024-01-15T10:30:00Z"
    },
    {
      "alt_text": "A detailed description of a mountain landscape with snow-capped peaks and a clear blue sky",
      "image_url": "https://example.com/image2.jpg",
      "generated_at": "2024-01-15T10:30:05Z"
    },
    {
      "alt_text": "A city street at night with neon lights",
      "image_url": "https://example.com/image3.jpg",
      "generated_at": "2024-01-15T10:30:10Z"
    }
  ],
  "total": 3,
  "successful": 3,
  "failed": 0
}

Rate Limits

Batch requests count as multiple individual requests for rate limiting purposes. Each image in the batch consumes one credit and counts toward your rate limit.

Batch processing is more efficient than making multiple individual requests, but still counts toward your usage limits.

Generate Alt Text (ATG)Text-to-Speech Overview

Overview

Alt Text Generation

Text-to-Speech

Blog Meta Generator

Site Audit

Indexing

Management

Batch Generate Alt Text

Overview

Request Body

Example Request

Response

Example Response

Rate Limits

​Overview

​Request Body

​Example Request

​Response

​Example Response

​Rate Limits

Overview

Request Body

Example Request

Response

Example Response

Rate Limits