Zurück zur Startseite

KI Alt-Text Generator API-Dokumentation - Automatisch Alt-Text für Bilder generieren

Überblick

Die KI Alt-Text Generator API ist ein leistungsstarker Dienst, der entwickelt wurde, um automatisch beschreibenden Alt-Text für Bilder zu generieren. Durch den Einsatz fortschrittlicher KI analysiert diese API Ihre Bilder und erstellt aussagekräftige, kontextrelevante Alt-Texte, die für Barrierefreiheit und SEO entscheidend sind. Die Verwendung eines Alt-Text Generators für Bilder wie diesem stellt sicher, dass Ihre visuellen Inhalte von Suchmaschinen verstanden werden. Zudem sparen Sie Stunden an manueller Arbeit und steigern Ihre Produktivität.

Anwendungsszenarien

Die KI Alt-Text Generator API ist ideal für eine Vielzahl von Anwendungen, bei denen die Erstellung von Alt-Text für Bilder unerlässlich ist:

API-Schlüssel

Um auf die KI Alt-Text Generator API zuzugreifen, müssen Sie zunächst einen gültigen API-Schlüssel erhalten. Dieser Schlüssel dient zur Authentifizierung Ihrer Anfragen und gewährleistet einen sicheren Zugriff auf die API.

Einen API-Schlüssel erhalten

  1. API-Schlüssel-Verwaltungsseite aufrufen: Melden Sie sich im System an und klicken Sie auf Ihren Benutzer-Avatar in der oberen rechten Ecke. Klicken Sie im Dropdown-Menü auf "API-Schlüssel beantragen", um die API-Schlüssel-Verwaltungsseite zu öffnen.
API für KI Alt-Text Generator
  1. Neuen Schlüssel erstellen: Klicken Sie auf "Neuen Schlüssel erstellen", geben Sie im Pop-up-Dialog einen Namen für Ihren Schlüssel ein und klicken Sie dann auf "Erstellen".
API-Schlüssel für KI Alt-Text Generator
  1. Schlüssel kopieren und speichern: Beachten Sie, dass der Schlüssel nur einmal vollständig angezeigt wird. Klicken Sie auf das Kopieren-Symbol, um den Schlüssel in Ihre Zwischenablage zu kopieren, und klicken Sie dann auf "Bestätigen", um den Dialog zu schließen.

Wichtig: Teilen Sie Ihren Schlüssel nicht mit anderen und legen Sie ihn nicht im Browser, im clientseitigen Code oder an einem anderen unsicheren Ort offen. Bewahren Sie Ihren Schlüssel sicher auf, um unbefugten Zugriff zu verhindern.

API-Endpunkt

POST https://api.imagedescriber.app/api/v1/generate_alt_text

Anfrageparameter

Request Headers

HeaderTypErforderlichBeschreibung
content-typestringJa`application/json`
authorizationstringJa`Bearer ${api_key}`, wobei `${api_key}` Ihr API-Schlüssel ist.

Request Body

Die KI Alt-Text Generator API akzeptiert die folgende Anfragestruktur:

{
  "image": "data:image/jpeg;base64,{image_base64_data}",
  "lang": "en"
}
ParameterTypErforderlichBeschreibung
imagestringJa

Die Base64-kodierten Daten des Bildes. Unterstützte Bildformate sind in den Details zu Bildformaten aufgeführt.

langstringNeinDer Sprachcode für den zurückgegebenen Alt-Text. Standard ist `en` (Englisch). Unterstützte Sprachcodes sind unten aufgeführt.

Unterstützte Sprachen

CodeSprache
enEnglisch (Standard)
deDeutsch
zhChinesisch
frFranzösisch
esSpanisch
jaJapanisch
koKoreanisch
itItalienisch
ptPortugiesisch
arArabisch
nlNiederländisch
plPolnisch

Anfragebeispiel (cURL)

curl --location 'https://api.imagedescriber.app/api/v1/generate_alt_text' \
--header 'content-type: application/json' \
--header 'authorization: Bearer your_api_key' \
--data '{
    "image":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQE...",
    "lang":"de"
}'

Anfragebeispiel (Python)

import requests
import base64

def image_to_base64(image_path):
    """Bild in Base64-Kodierung umwandeln"""
    with open(image_path, "rb") as image_file:
        encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
    return encoded_string

def generate_alt_text(api_key, image_path, lang="de"):
    """Alt-Text für ein Bild mit der KI Alt-Text Generator API generieren"""
    url = "https://api.imagedescriber.app/api/v1/generate_alt_text"
    headers = {
        "content-type": "application/json",
        "authorization": f"Bearer {api_key}"
    }

    image_base64_data = image_to_base64(image_path)
    payload = {
        "image": f"data:image/jpeg;base64,{image_base64_data}",
        "lang": lang
    }

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

    if response.status_code == 200:
        result = response.json()
        alt_text_data = result["data"]["alt_text"]
        print("Generierte Beschreibung:", alt_text_data["description"])
        print("Generierte Alt-Texte:", alt_text_data["alt"])
        print("Verbleibende Credits:", result["data"]["credits"]["remaining"])
    else:
        print(f"Fehler: {response.status_code}")
        print(response.text)

# Anwendungsbeispiel
api_key = "your_api_key"
image_path = "your_image.jpg"

generate_alt_text(api_key, image_path)

Anfragebeispiel (Next.js)

import fs from 'fs';

// Serverseitige Implementierung
const buffer = await fs.readFileSync("/temp/test.jpg");
const base64Image = buffer.toString('base64');
const imageData = `data:image/jpeg;base64,${base64Image}`;

// Clientseitige Implementierung
const file: File = /* file aus Input- oder Drop-Event */;
const arrayBuffer = await file.arrayBuffer();
const bytes = new Uint8Array(arrayBuffer);
const base64Image = btoa(String.fromCharCode.apply(null, bytes as any));
const imageData = `data:${file.type};base64,${base64Image}`;

const body = {
  "image": imageData,
  "lang": "de"
};

const response = await fetch('https://api.imagedescriber.app/api/v1/generate_alt_text', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {your_api_key}'
  },
  body: JSON.stringify(body),
});

const result = await response.json();
console.log('Generierte Beschreibung:', result.data.alt_text.description);
console.log('Generierte Alt-Texte:', result.data.alt_text.alt);

Antwort

Response Body (JSON-Antwort)

Der Alt-Text Generator für Bilder gibt eine Antwort zurück, die eine detaillierte Beschreibung und ein Array mit Alt-Text-Optionen enthält.

{
  "code": 0,
  "message": "success",
  "request_id": "unique_request_id_string",
  "data": {
    "alt_text": {
      "description": "Detaillierte Bildbeschreibung",
      "alt": [
        "alt1",
        "alt2",
        "..."
      ]
    },
    "credits": {
      "amount": "Für diesen Aufruf verbrauchte Credits",
      "remaining": "Nach diesem Aufruf verbleibende Gesamt-Credits"
    }
  }
}
FeldTypBeschreibung
codenumberStatuscode, `0` bedeutet Erfolg, ein anderer Wert einen Fehler.
messagestringStatusmeldung, beschreibt den Status der Anfrage.
request_idstringEindeutige Anfrage-ID zur Nachverfolgung und Fehlerbehebung.
dataobjectEnthält die Antwortdaten.
data.alt_textobjectEnthält die generierte Beschreibung und den Alt-Text.
data.alt_text.descriptionstringEine detaillierte Beschreibung des Bildinhalts.
data.alt_text.altarrayEin Array von generierten Alt-Text-Strings für das Bild.
data.creditsobjectInformationen zum Credit-Verbrauch und verbleibenden Guthaben.
data.credits.amountnumberAnzahl der bei diesem API-Aufruf verbrauchten Credits.
data.credits.remainingnumberGesamtzahl der nach diesem Aufruf in Ihrem Konto verbleibenden Credits.

Anfragelimits

Um die Stabilität und Fairness des Dienstes zu gewährleisten, ist jeder API-Schlüssel auf 30 Anfragen pro Minute (1800 Anfragen pro Stunde) begrenzt. Anfragen, die dieses Limit überschreiten, werden mit dem Fehlercode 1004 abgelehnt.

Credit-System

Wie erhalte ich mehr Credits?

Besuchen Sie die Seite zum Aufladen von Credits, um Credit-Pakete zu erwerben und mehr API-Aufrufe zu ermöglichen. Wir bieten verschiedene Pakete an, um den Bedürfnissen unterschiedlicher Nutzer gerecht zu werden.

Fehlerbehandlung

Die folgende Tabelle listet gängige Fehlercodes, ihre Bedeutung und Lösungen auf:

FehlercodeBeschreibungLösung
1002Nicht autorisiertBitte überprüfen Sie, ob Ihr `authorization`-Header korrekt gesetzt ist.
1003Ungültiger API-SchlüsselBitte überprüfen Sie, ob Ihr API-Schlüssel korrekt ist, oder fordern Sie einen neuen an.
1004Zu viele AnfragenBitte reduzieren Sie Ihre Anfragefrequenz, maximal 30 Anfragen pro Minute.
1005Ungültige ParameterBitte überprüfen Sie, ob Ihre Anfrageparameter den Spezifikationen entsprechen.
2002Unzureichende Credits
2003Inhalt vom Filter blockiertBitte ändern Sie Ihr Bild, um sicherzustellen, dass der Inhalt den Vorschriften entspricht.
2004Ungültiges Bildformat

Bitte verwenden Sie ein unterstütztes Bildformat, siehe Details zu Bildformaten.

2005Bild-Upload fehlgeschlagenBitte überprüfen Sie, ob Ihre Bilddaten gültig sind, oder versuchen Sie es später erneut.
2006Fehler beim Parsen der KI-Antwort in das erwartete JSON-Format.
5050Interner ServerfehlerBitte kontaktieren Sie unseren technischen Support und geben Sie die `request_id` an.

Details zu Bildformaten

Aktuell unterstützte Bildformate sind: JPG, JPEG, PNG, WebP. Die maximale Bildgröße beträgt 4 MB.

Best Practices für die Generierung von Alt-Text

  • Hohe Auflösung: Verwenden Sie klare, hochauflösende Bilder für einen präziseren Alt-Text Generator für Bilder.
  • Gute Beleuchtung: Gut beleuchtete Bilder führen zu genaueren und beschreibenderen Alt-Texten.
  • Klares Motiv: Bilder mit deutlichen Motiven und Objekten erzeugen relevantere Alt-Texte.
  • Unterstützte Formate: Halten Sie sich für optimale Ergebnisse an die unterstützten Formate (JPG, PNG, WebP).

Anwendungsfälle und Integrationsbeispiele

SEO-Verbesserung

Nutzen Sie die KI Alt-Text Generator API, um automatisch Alt-Text für Bilder auf Ihrer Website zu generieren:

// Bild-SEO mit KI-generiertem Alt-Text verbessern
const enhanceImageSEO = async (imageElement, apiKey) => {
  const canvas = document.createElement('canvas');
  const ctx = canvas.getContext('2d');
  canvas.width = imageElement.width;
  canvas.height = imageElement.height;
  ctx.drawImage(imageElement, 0, 0);

  const base64Image = canvas.toDataURL('image/jpeg');

  const response = await fetch('/api/v1/generate_alt_text', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${apiKey}`
    },
    body: JSON.stringify({ image: base64Image })
  });

  const result = await response.json();
  const { alt } = result.data.alt_text;

  // Alt-Attribut des Bildes für SEO und Barrierefreiheit aktualisieren
  if (alt && alt.length > 0) {
    imageElement.alt = alt[0];
  }
};

Integration in Content-Management-Systeme

Integrieren Sie den Alt-Text Generator für Bilder in Ihren CMS-Workflow:

# Stapelverarbeitung von Bildern in einem Content-Management-System
import os
import requests
from pathlib import Path

def bulk_generate_alt_text(directory_path, api_key):
    """Verarbeitet alle Bilder in einem Verzeichnis, um Alt-Texte zu generieren"""
    image_extensions = ['.jpg', '.jpeg', '.png', '.webp']

    for image_path in Path(directory_path).iterdir():
        if image_path.suffix.lower() in image_extensions:
            try:
                # Alt-Text für jedes Bild generieren
                result = generate_alt_text(api_key, str(image_path))

                # Metadaten in einer Begleitdatei speichern
                metadata_path = image_path.with_suffix('.json')
                with open(metadata_path, 'w') as f:
                    json.dump(result['data']['alt_text'], f, indent=2)

                print(f"Verarbeitet: {image_path.name}")

            except Exception as e:
                print(f"Fehler bei der Verarbeitung von {image_path.name}: {e}")

# Anwendung
bulk_generate_alt_text("/pfad/zu/den/bildern", "your_api_key")

Kontakt

Wenn Sie Fragen oder Anregungen zu unserer KI Alt-Text Generator API haben, können Sie uns gerne über die folgenden Kanäle kontaktieren:

Beginnen Sie jetzt mit der Nutzung der KI Alt-Text Generator API und erschließen Sie das Potenzial automatisierter Bild-Barrierefreiheit und SEO!