Generate a sticker

POSThttps://api.vidmoat.com/v1/ai/stickers

Bearer tokenScope ai.image20 creditsTry it in the playground

Generate a cut-out sticker with a transparent background (a PNG, or an SVG when the vector fallback is used). Creator and Studio.

Body#

promptstringrequired
Up to 300 characters.
styleenumdefault cartoon
Look. Unknown values become cartoon.
One of cartoon, kawaii, retro, neon, 3d, minimal

Response#

Returns 200.

Response fields#

urlstring
The sticker.
kindenum
File type.
One of png, svg
creditsobject
{ charged, remaining }: what this call cost and the balance after it.
hintstring
What to do with it.

Errors#

Besides the errors any request can get (authentication, rate limits):

Status	Code	When
402	`plan_required`	The plan has no stickers.
402	`insufficient_credits`	The balance cannot cover the call. Nothing ran. `remaining` is the balance.
422	`prompt_rejected`	The prompt failed the safety check. Nothing was charged. `field` names the field.
502	`provider_error`	The generation provider failed. The charge is refunded.

curl

curl -X POST https://api.vidmoat.com/v1/ai/stickers \
  -H "Authorization: Bearer $VIDMOAT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"a winking crab"}'

Response 200

{
  "url": "https://api.vidmoat.com/uploads/sticker-1.png",
  "kind": "png",
  "credits": { "charged": 20, "remaining": 4420 },
  "hint": "Use `url` as an addClip `src` with type: \"image\"."
}