Skip to main content
POST
Genereer een afbeelding voor het verbonden account. Gebruikt dezelfde medialimieten en waarborgen als de webapp. Bewaar de geretourneerde generationId en gebruik images_download om de afbeelding op te halen. Gebruik requestId opnieuw wanneer je dezelfde aanvraag opnieuw probeert.

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: images: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.
string
Tekstwaarde.Toegestane waarden: “square”, “landscape”, “portrait”. Standaardwaarde: “square”.
string
Een geüploade JPG-, PNG- of WebP-objectsleutel onder uploads/{yourUserId}/. Externe URL’s worden niet geaccepteerd.Minimale lengte: 1. Maximale lengte: 512.
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 generatiemetadata die de handler retourneert nadat de afbeelding is gegenereerd. Bevat geen afbeeldingsbytes, previewDataUrl of download-URL.

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 images: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. aspectRatio is standaard square en accepteert ook landscape of portrait. Er wordt maximaal één referenceImageKey geaccepteerd.
  • Dit is een langdurige actie. De eerste API/MCP-respons meldt normaal gesproken running; vraag action_request_get op met operation images_generate en dezelfde requestId om het hier getoonde definitieve resultaat te verkrijgen.
  • Gebruikt het normale dagelijkse quotum voor afbeeldingsgeneratie van het account. Gegenereerde accountafbeeldingen 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.
  • Voor deze gebruiker kan slechts één afbeelding tegelijk worden gegenereerd. Gebruik images_list en images_get om de aanmaakstatus te controleren en images_download voor PNG-bytes. De generatie-ID is een ondoorzichtige tekenreeks; vervang deze niet door 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