Skip to main content
POST
Schließen Sie einen Referenzbildupload Ihres Kontos mit den Teilenummern und ETags aus den PUT-Anfragen ab. Prüft die gespeicherte Dateigröße. Verwenden Sie den zurückgegebenen fileKey als Referenz für die 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
Die von der upload_initialize-Aktion dieser Domäne zurückgegebene uploadId.Format: “uuid”. Muster: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.
array
erforderlich
Liste von Werten. Die Struktur der Elemente finden Sie im vollständigen Eingabeschema.Mindestanzahl an Elementen: 1. Höchstanzahl an Elementen: 2.
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. Der abgeschlossene eigene Referenzschlüssel und seine Lese-URL werden erst zurückgegeben, wenn die gespeicherte Bytelänge genau der angegebenen Dateigröße entspricht. Verwenden Sie in den Generierungsargumenten fileKey, nicht readUrl.

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.
  • uploadId ist die UUID aus initialize. parts enthält genau die von der Sitzung benötigten 1–2 Teile. Jeder Teil hat eine ganzzahlige partNumber von 1 bis 2 und eine etag-Zeichenfolge mit 1–256 Zeichen aus seiner erfolgreichen PUT-Antwort.
  • Alle Teilnummern müssen vorhanden und eindeutig sein. Die Teile werden vor dem Abschluss sortiert; ETags werden zu Werten in Anführungszeichen normalisiert. Sie können die vom Speicher zurückgegebenen ETag-Anführungszeichen beibehalten.
  • Die tatsächliche Bytelänge des abgeschlossenen Objekts wird mit fileSize und der Obergrenze von 8 MiB verglichen. Bei fehlender, abweichender oder zu großer Länge werden das Objekt und die aktive Sitzung entfernt und UPLOAD_SIZE_MISMATCH zurückgegeben.
  • Übergeben Sie fileKey als referenceImageKey in images_generate. Abgeschlossene Referenzdateien können für nachfolgende Bild- oder Thumbnail-Generierungen desselben Benutzers wiederverwendet werden; die Generierung verbraucht die Referenz nicht.
  • Nur ein Upload des verbundenen Benutzers kann signiert, abgeschlossen oder abgebrochen werden. Diese Aliase akzeptieren nur JPG-, PNG- und WebP-Sitzungen mit höchstens 8 MiB, auch wenn die Sitzung über eine andere Uploadfamilie erstellt wurde.
  • 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.
  • 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 Abschluss schließt die mehrteilige Sitzung. Wiederholen Sie den Abschluss mit der ursprünglichen requestId, um das aufgezeichnete Ergebnis abzurufen; eine neue Abschlussanfrage für diese geschlossene uploadId gibt Upload not found zurück. Diese Aktion gibt keinen Ablaufzeitpunkt für die Aufbewahrung der Referenz zurück.

Nutzung

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

Fehler