Bildbeschreibung Generator API-Dokumentation (V2)

Einführung & Anwendungsfälle

Die Bildbeschreibung Generator API ermöglicht es Ihnen, KI-gestützte Bildbeschreibungsfunktionen in Ihre Anwendungen zu integrieren. Unsere API verwendet fortschrittliche KI-Modelle zur Analyse von Bildern und Generierung detaillierter Beschreibungen.

Häufige Anwendungsfälle

Generierung detaillierter Bildbeschreibungen
Extraktion von Text und Informationen aus Bildern
Analyse von Bildinhalt und Kontext
Erstellung von Charakterbeschreibungen für kreatives Schreiben
Generierung von Bildunterschriften für Content-Management

API-Schlüssel

Um unsere API zu nutzen, benötigen Sie API-Anmeldeinformationen (API-Schlüssel und Secret). Sie können Ihre API-Schlüssel im Dashboard verwalten.

API-Schlüssel verwalten →

API-Endpunkt

POST https://imagedescriber.online/api/openapi-v2/describe-image

Integrationsanleitung

Anfrage-Header

Header-Name	Erforderlich	Beschreibung
content-type	Ja	Muss multipart/form-data sein
authorization	Ja	Muss Bearer ${SECRET_KEY} sein ${SECRET_KEY} ist Ihr API-Schlüssel.

Anfrage-Parameter

Parameter	Typ	Erforderlich	Beschreibung
image	string oder file	Ja	Bild zur Generierung der Beschreibung. Unterstützt drei Eingabeformate: 1. Bild-URL, beginnend mit http:// oder https://. 2. Base64-kodiertes Bild, im Format: data:image/jpeg;base64,/9j/4AAQSkZJR... (Hinweis: andere Bildtypen wie PNG sind ebenfalls möglich, MIME-Typ entsprechend anpassen) 3. Dateiobjekt: Ein Dateiobjekt, das das Modellbild repräsentiert.
prompt	string	Ja	Benutzerdefinierter Prompt für die Bildanalyse
lang	string	Nein	Antwortsprache (en/zh/de/es/fr/ja/ko/fi/nl/pt/tr/ru), Standard: en

Antwortformat

Feld	Typ	Beschreibung
code	number	Antwort-Statuscode. 200 für Erfolg
data	object	Antwortobjekt, vorhanden wenn code 200 ist
data.content	string	Die generierte Beschreibung für das Bild
msg	string	Antwortnachricht, liefert zusätzliche Informationen
succeed	boolean	Zeigt an, ob die Anfrage erfolgreich war

Beispielantwort

{
    "code": 200,
    "data": {
        "content": "Detaillierte Beschreibung des Bildes im Markdown-Format..."
    },
    "succeed": true,
    "msg": "Erfolg"
}

Fehlercodes

Code	Nachricht	Beschreibung
200	OK	Anfrage erfolgreich
500	SERVER_ERROR	Interner Serverfehler
10003	INSUFFICIENT_CREDITS	Unzureichende Credits
10004	INVALID_PARAM	Ungültige Parameter
10005	HARMFUL_CONTENT	Schädlicher Inhalt erkannt
30001	INVALID_API_KEY	Ungültiger API-Schlüssel
30002	INVALID_SIGNATURE	Ungültige Anfrage-Signatur

Code-Beispiele

Curl-Beispiel mit Bild-URL

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image="https://persistent.imagedescriber.online/image-describer-examples/000.jpg"' \
--form 'prompt="Beschreiben Sie kurz den Inhalt des Bildes"' \
--form 'lang="de"'

Curl-Beispiel mit lokaler Bilddatei

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image=@"/PATH/TO/YOUR/IMAGE.jpg"' \
--form 'prompt="Beschreiben Sie kurz den Inhalt des Bildes"' \
--form 'lang="de"'

Curl-Beispiel mit Base64-Bild

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image="data:image/jpeg;base64,/9j……/9k="' \
--form 'prompt="Beschreiben Sie kurz den Inhalt des Bildes"' \
--form 'lang="de"'

Node.js-Beispiel

async function callDescribeImageApi() {
  const apiKey = 'YOUR_API_KEY'; // Ersetzen Sie dies durch Ihren tatsächlichen API-Schlüssel

  const formData = new FormData();
  formData.append('image', ...); // Unterstützt URL, Bilddatei, Base64-kodiertes Bild
  formData.append('prompt', 'Beschreiben Sie kurz den Inhalt des Bildes');
  formData.append('lang', 'de'); // Antwortsprache-Code

  const apiEndpoint = 'https://imagedescriber.online/api/openapi-v2/describe-image';
  try {
    const response = await fetch(apiEndpoint, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${apiKey}`,
      },
      body: formData,
    });

    if (!response.ok) {
      const errorData = await response.json();
      throw new Error(`HTTP error ${response.status}: ${errorData.msg || 'Unbekannter Fehler'}`);
    }

    const data = await response.json();
    return { content: data.data.content, error: null };

  } catch (error) {
    console.error('Fehler bei der Bildbeschreibung:', error);
    return { content: null, error: error.message };
  }
}

Python-Beispiel

import requests
import base64

async def call_describe_image_api():
    api_key = 'YOUR_API_KEY'  # Ersetzen Sie dies durch Ihren tatsächlichen API-Schlüssel

    form_data = {
        'image': 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...',  # Beispiel Base64-Bild. Ersetzen Sie dies durch Ihre tatsächlichen Bilddaten. Unterstützt URL, Datei und Base64.
        'prompt': 'Beschreiben Sie kurz den Inhalt des Bildes',
        'lang': 'de' # Antwortsprache-Code
    }

    api_endpoint = 'https://imagedescriber.online/api/openapi-v2/describe-image'
    try:
        headers = {
            'Authorization': f'Bearer {api_key}',
        }

        response = requests.post(api_endpoint, files=form_data, headers=headers) # Verwenden Sie files= für multipart/form-data
        response.raise_for_status()  # Löst eine Ausnahme für Fehlerstatuscodes aus (4xx oder 5xx)

        data = response.json()
        return {'content': data.get('data', {}).get('content'), 'error': None}

    except requests.exceptions.RequestException as e:
        print(f'Fehler bei der Bildbeschreibung: {e}')
        return {'content': None, 'error': str(e)}

Preise

API-Aufrufe verbrauchen Credits von Ihrem Konto. Sie können Credits auf unserer Preisseite erwerben.

Preise ansehen →

Hilfe & Support

Wenn Sie Fragen haben oder Unterstützung benötigen, zögern Sie nicht, unser Support-Team zu kontaktieren.

E-Mail: [email protected]