Skip to main content
POST
Genereer een miniatuur van 1280×720 voor het verbonden account, met de medialimieten van de webapp. Gebruik requestId opnieuw wanneer je dezelfde aanvraag opnieuw probeert; gebruik thumbnails_download om het resultaat op te halen.

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
Tekstwaarde.Minimale lengte: 10. Maximale lengte: 1200.
array
Lijst met waarden. Zie het volledige invoerschema voor de structuur van de items.Maximaal aantal items: 3. Standaardwaarde: [].
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

Deze bewerking retourneert HTTP 202 zolang deze wordt uitgevoerd. Bewaar requestId en controleer action_request_get met die identificatie en de oorspronkelijke bewerkingsnaam. De mogelijke statussen zijn running, completed, failed en interrupted. Een voltooid resultaat kan naar een afzonderlijke mediataak verwijzen; ga dan verder met de status- of uitvoeractie van die bewerking. Definitieve metadata van de miniatuur, geretourneerd nadat de generatie is voltooid. De uitvoer is 1280 × 720 pixels; afbeeldingsbytes, previewDataUrl en overdrachtstokens zijn niet inbegrepen.

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. Witruimte aan het begin en einde van de prompt wordt verwijderd en de prompt moet 10–1200 tekens bevatten; vóór generatie wordt de prompt ook genormaliseerd. referenceImageKeys is standaard [] en accepteert maximaal drie sleutels.
  • Dit is een langdurige actie. Het eerste API/MCP-antwoord vermeldt normaal running; peil action_request_get met operation thumbnails_generate en dezelfde requestId om het hier getoonde eindresultaat te verkrijgen.
  • Gebruikt de normale dagelijkse limiet van het account voor miniatuurgeneratie. Nieuwe accountminiaturen verlopen zeven dagen na aanmaak; download het resultaat vóór expiresAt.
  • Deze actie gebruikt de eigen creaties en uploads van de gekoppelde gebruiker, ook wanneer het toegangsmiddel in een teamcontext is gekoppeld.
  • Referentiesleutels moeten verwijzen naar voltooide uploads onder uploads/{yourUserId}/ en eindigen op .jpg, .jpeg, .png of .webp. Externe URL’s, sleutels van andere gebruikers, padtraversalsegmenten, backslashes, procentcoderingen, querystrings, fragmenten en besturingstekens worden geweigerd.
  • Elke referentie moet niet-leeg zijn, maximaal 8 MiB (8,388,608 bytes) groot zijn, kunnen worden gedecodeerd als het afbeeldingstype dat de extensie aangeeft en aan elke zijde 128–4096 pixels meten. Ook het aantal gedecodeerde pixels is begrensd. Een geüploade referentie blijft herbruikbaar; deze generatieacties verbruiken of verwijderen het geüploade bestand niet.
  • 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.
  • Een voltooide aanvraag kan de bestaande miniatuur retourneren. Een eerder mislukte of onderbroken integratieaanvraag wordt niet automatisch opnieuw uitgevoerd. Controleer de aanvraagstatus en thumbnails_list voordat je een nieuwe aanvraag start.
  • Gebruik thumbnails_get of thumbnails_list voor metadata en thumbnails_download voor WebP-bytes. De generatie-ID is een ondoorzichtige tekenreeks, niet requestId.

Verbruik

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

Fouten