Skip to main content
POST
Generieren Sie ein Bild für das verbundene Konto. Es gelten dieselben Medienkontingente und Schutzmaßnahmen wie in der Web-App. Speichern Sie die zurückgegebene generationId und verwenden Sie images_download, um das Bild abzurufen. Verwenden Sie requestId erneut, wenn Sie dieselbe Anfrage wiederholen.

Authentifizierung und Berechtigungen

string
erforderlich
Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt. OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
Erforderliche Berechtigungen: images:write. Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.

Parameter

string
An der Transportschnittstelle optional: Bei fehlender Angabe fügt der Server vor der Validierung eine Kennung ein. Geben Sie eine eigene stabile UUID v4 an, um eine verlorene Antwort sicher wiederherstellen zu können.Format: “uuid”. Muster: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
string
erforderlich
Textwert.Mindestlänge: 10. Höchstlänge: 1200.
string
Textwert.Zulässige Werte: “square”, “landscape”, “portrait”. Standardwert: “square”.
string
Objektschlüssel eines hochgeladenen JPG-, PNG- oder WebP-Bildes unter uploads/{yourUserId}/. Remote-URLs werden nicht akzeptiert.Mindestlänge: 1. Höchstlänge: 512.
Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.

Idempotenz

Verwenden Sie für jede Mutation eine UUID v4 in requestId oder im HTTP-Header Idempotency-Key. Verwenden Sie nach einem Netzwerkfehler dieselbe Kennung und identische Argumente erneut. Wenn Sie beides angeben, müssen die Werte übereinstimmen. Die Wiederholung einer gespeicherten Anfrage führt die Operation nicht erneut aus und verbraucht keinen weiteren monatlichen Aufruf. Fehlgeschlagene oder unterbrochene Anfragen werden nicht automatisch neu gestartet. Jede Mutation kann HTTP 202 zurückgeben, wenn bei einem Wiederholungsversuch dieselbe Anfrage noch läuft, auch wenn ihre erste Ausführung normalerweise synchron erfolgt. Wenn die Ausführung abgeschlossen ist, resultStored aber false ist, gibt ein Wiederholungsversuch HTTP 200 mit dem gespeicherten Anfragestatus anstelle des ursprünglichen Ergebnisses zurück. Rufen Sie die Ausgabe über die für ihren Bereich vorgesehene Verlaufs-, Ergebnis- oder Downloadaktion ab.

Anfragebeispiele

Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.

Antwort

Diese Operation gibt während der Ausführung HTTP 202 zurück. Speichern Sie requestId und fragen Sie action_request_get mit dieser Kennung und dem ursprünglichen Operationsnamen ab. Die Abfragestatus sind running, completed, failed und interrupted. Ein abgeschlossenes Ergebnis kann auf einen separaten Medienauftrag verweisen; verwenden Sie anschließend die für die Operation vorgesehene Status- oder Ausgabeaktion. Endgültige Generierungsmetadaten, die der Handler nach Abschluss der Bildgenerierung zurückgibt. Bildbytes, previewDataUrl und eine Download-URL sind nicht enthalten.

Ergebnisfelder

Diese Anfrage wiederherstellen und abfragen

Verwenden Sie auch nach einem Verbindungsabbruch dieselbe Kennung. Wenn resultStored den Wert false hat, rufen Sie die Ausgabe über die entsprechende Verlaufs-, Ergebnis- oder Downloadaktion ab. Starten Sie niemals eine zweite Generierung, nur um den Fortschritt zu prüfen.
HTTP 200

Hinweise zur Operation

  • Erfordert images:write. Führende und nachfolgende Leerzeichen werden aus dem Prompt entfernt, und er muss 10–1200 Zeichen enthalten; vor der Generierung wird er außerdem normalisiert. aspectRatio hat den Standardwert square und akzeptiert auch landscape oder portrait. Es wird höchstens ein referenceImageKey akzeptiert.
  • Dies ist eine lang laufende Aktion. Die anfängliche API/MCP-Antwort meldet normalerweise running; fragen Sie action_request_get mit operation images_generate und derselben requestId regelmäßig ab, um das hier gezeigte endgültige Ergebnis zu erhalten.
  • Verwendet das normale tägliche Bildgenerierungskontingent des Kontos. Für das Konto generierte Bilder laufen sieben Tage nach der Erstellung ab; laden Sie das Ergebnis vor expiresAt herunter.
  • Diese Aktion verwendet die eigenen Erstellungen und Uploads des verbundenen Nutzers, auch wenn die Zugangsdaten im Teamkontext verbunden sind.
  • Referenzschlüssel müssen auf abgeschlossene Uploads unter uploads/{yourUserId}/ verweisen und auf .jpg, .jpeg, .png oder .webp enden. Entfernte URLs, Schlüssel anderer Nutzer, Pfad-Traversal-Segmente, umgekehrte Schrägstriche, Prozent-Escapes, Abfragezeichenfolgen, Fragmente und Steuerzeichen werden abgelehnt.
  • Jede Referenz muss nicht leer sein, darf höchstens 8 MiB (8,388,608 Bytes) groß sein, muss sich als der durch ihre Erweiterung angegebene Bildtyp dekodieren lassen und auf jeder Seite 128–4096 Pixel messen. Auch die Anzahl der dekodierten Pixel ist begrenzt. Eine hochgeladene Referenz bleibt wiederverwendbar; diese Generierungsaktionen verbrauchen oder löschen die hochgeladene Datei nicht.
  • Verwenden Sie eine UUID v4 als requestId oder den HTTP-Header Idempotency-Key und verwenden Sie denselben Wert bei Wiederholungsversuchen mit identischen Eingaben erneut. Die Integrationsebene zeichnet jede Änderung auf und gibt ihren aufgezeichneten Status oder ihr Ergebnis zurück, ohne sie erneut auszuführen. Eine fehlgeschlagene oder unterbrochene Anfrage wird nicht automatisch wiederholt.
  • Für diesen Benutzer darf jeweils nur ein Bild generiert werden. Verwenden Sie images_list und images_get, um den Erstellungsstatus zu prüfen, und images_download für PNG-Bytes. Die Generierungskennung ist eine opake Zeichenfolge; ersetzen Sie sie nicht durch requestId.

Nutzung

Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.

Fehler