Skip to main content
POST
Bereid een upload van een JPG-, PNG- of WebP-referentie tot 8 MiB voor. Gebruik thumbnails_upload_sign_parts om PUT-URL’s op te halen, upload de bytes, roep vervolgens thumbnails_upload_complete aan en gebruik de bijbehorende fileKey bij het genereren.

Authenticatie en machtigingen

string
vereist
Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
Vereiste machtigingen: thumbnails:write. Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.

Parameters

string
Optioneel op transportniveau: als de identificatie ontbreekt, voegt de server deze vóór de validatie toe. Geef zelf een stabiele UUID v4 op om veilig te kunnen herstellen als een antwoord verloren gaat.Formaat: “uuid”. Patroon: ^[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
vereist
De bestandsnaam van de afbeelding, met een extensie die overeenkomt met contentType.Minimale lengte: 1. Maximale lengte: 250. Patroon: \.(?:jpe?g|png|webp)$.
string
vereist
Tekstwaarde.Toegestane waarden: “image/jpeg”, “image/png”, “image/webp”.
integer
vereist
Exacte bestandsgrootte in bytes, tot 8 MiB.Minimum: 1. Maximum: 8388608.
Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.

Idempotentie

Gebruik voor elke wijziging een UUID v4 in requestId of de HTTP-header Idempotency-Key. Gebruik na een netwerkfout dezelfde identificatie en identieke argumenten opnieuw. Als je beide opgeeft, moeten ze overeenkomen. Het opnieuw versturen van een opgeslagen aanvraag herhaalt de bewerking niet en verbruikt geen extra maandelijkse aanroep. Mislukte of onderbroken aanvragen worden niet automatisch opnieuw gestart. Elke wijziging kan HTTP 202 retourneren wanneer een nieuwe poging vaststelt dat dezelfde aanvraag nog loopt, ook wanneer de eerste uitvoering normaal synchroon is. Als de uitvoering is voltooid maar resultStored false is, retourneert een nieuwe poging HTTP 200 met de opgeslagen aanvraagstatus in plaats van het oorspronkelijke resultaat. Haal de uitvoer op via de geschiedenis-, resultaat- of downloadactie van het betreffende domein.

Voorbeeldaanvragen

Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.

Antwoord

Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Een nieuwe meerdelige uploadsessie voor afbeeldingsreferenties, de toekomstige objectsleutel, de deelgrootte in bytes en het maximale aantal parallelle uploads. Dit uploadt geen afbeeldingsbytes en maakt key niet gereed voor generatie.

Resultaatvelden

Deze aanvraag herstellen en controleren

Gebruik dezelfde identificatie, ook nadat de verbinding is verbroken. Als resultStored false is, haal je de uitvoer op via de bijbehorende geschiedenis-, resultaat- of downloadactie. Start nooit een tweede generatie alleen om de voortgang te controleren.
HTTP 200

Opmerkingen bij de bewerking

  • Vereist thumbnails:write; er is geen aanvullende uploadscope nodig.
  • Witruimte aan het begin en einde van filename wordt verwijderd. De waarde moet 1–250 tekens bevatten en eindigen op .jpg, .jpeg, .png of .webp. De extensie moet overeenkomen met contentType: image/jpeg, image/png of image/webp. fileSize is het exacte gehele aantal bytes, van 1 tot 8,388,608.
  • De gedeelde uploadimplementatie retourneert partSize 5 MiB (5,242,880 bytes) voor deze referenties. Een bestand van maximaal 5 MiB gebruikt één deel; een groter bestand tot 8 MiB gebruikt er twee. Vraag PUT-URL’s aan met thumbnails_upload_sign_parts, upload de bytes en roep vervolgens thumbnails_upload_complete aan.
  • Gebruik de fileKey die bij voltooiing wordt geretourneerd als een item in referenceImageKeys in thumbnails_generate. Het initialisatieresultaat gebruikt key, niet fileKey. Geef key niet door aan de generatie voordat de upload is voltooid.
  • De uploadsessie in productie verloopt na 24 uur. Ondertekende deel-URL’s verlopen na één uur. Voltooien en afbreken verwijderen de actieve sessie; sign-parts en complete retourneren daarna Upload not found. Geen van beide responsen bevat een expiresAt-veld.
  • Deze actie gebruikt de eigen creaties en uploads van de gekoppelde gebruiker, ook wanneer het toegangsmiddel in een teamcontext is gekoppeld.
  • Gebruik een UUID v4 als requestId of de HTTP-header Idempotency-Key en hergebruik deze met identieke invoer wanneer je opnieuw probeert. De integratielaag legt elke wijziging vast en retourneert de vastgelegde status of het resultaat zonder deze opnieuw uit te voeren. Een mislukte of onderbroken aanvraag wordt niet automatisch opnieuw geprobeerd.
  • De bestandsnaam in de objectsleutel wordt opgeschoond en kan worden ingekort. Bewaar de exact geretourneerde key en uploadId; stel deze niet zelf samen. Afbeeldingsbytes worden tijdens de generatie gevalideerd, naast de gedeclareerde grootte en het type tijdens de upload.

Verbruik

Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.

Fouten