Skip to main content
POST
Bereiten Sie den Upload einer JPG-, PNG- oder WebP-Referenz mit bis zu 8 MiB vor. Verwenden Sie images_upload_sign_parts, um PUT-URLs abzurufen, laden Sie die Bytes hoch und rufen Sie dann images_upload_complete auf. Verwenden Sie dessen fileKey bei der Generierung.

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
Der Bilddateiname mit einer zu contentType passenden Erweiterung.Mindestlänge: 1. Höchstlänge: 250. Muster: \.(?:jpe?g|png|webp)$.
string
erforderlich
Textwert.Zulässige Werte: “image/jpeg”, “image/png”, “image/webp”.
integer
erforderlich
Exakte Dateigröße in Bytes, bis zu 8 MiB.Minimum: 1. Maximum: 8388608.
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

Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder. Eine neue mehrteilige Upload-Sitzung für Bildreferenzen, der zukünftige Objektschlüssel, die Teilgröße in Bytes und die maximale Anzahl paralleler Uploads. Dies lädt keine Bildbytes hoch und macht key nicht für die Generierung bereit.

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; ein zusätzlicher Upload-Scope ist nicht erforderlich.
  • Leerraum am Anfang und Ende von filename wird entfernt; der Wert muss 1–250 Zeichen enthalten und auf .jpg, .jpeg, .png oder .webp enden. Die Erweiterung muss mit contentType übereinstimmen: image/jpeg, image/png oder image/webp. fileSize ist die exakte ganzzahlige Byteanzahl von 1 bis 8,388,608.
  • Die gemeinsame Uploadimplementierung gibt für diese Referenzen partSize 5 MiB (5,242,880 Bytes) zurück. Eine Datei mit höchstens 5 MiB verwendet einen Teil; eine größere Datei mit bis zu 8 MiB verwendet zwei. Fordern Sie PUT-URLs mit images_upload_sign_parts an, laden Sie die Bytes hoch und rufen Sie anschließend images_upload_complete auf.
  • Verwenden Sie den beim Abschluss zurückgegebenen fileKey als referenceImageKey in images_generate. Das initialize-Ergebnis verwendet key, nicht fileKey. Übergeben Sie key nicht vor dem Abschluss an die Generierung.
  • Die Upload-Sitzung in der Produktionsumgebung läuft nach 24 Stunden ab. Signierte Teil-URLs laufen nach einer Stunde ab. Abschluss und Abbruch entfernen die aktive Sitzung; sign-parts und complete geben dann Upload not found zurück. Keine der beiden Antworten enthält ein expiresAt-Feld.
  • Diese Aktion verwendet die eigenen Erstellungen und Uploads des verbundenen Nutzers, auch wenn die Zugangsdaten im Teamkontext verbunden sind.
  • 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.
  • Der Dateiname im Objektschlüssel wird bereinigt und kann gekürzt werden. Bewahren Sie den exakt zurückgegebenen key und uploadId auf; konstruieren Sie diese nicht selbst. Die Bildbytes werden während der Generierung geprüft, zusätzlich zur Prüfung der angegebenen Größe und des Typs beim Upload.

Nutzung

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

Fehler