Snacks

Ads on demand

Async. Make ads from a store, service or app URL, then poll GET /api/v1/jobs/{id}. Pro and Scale plans. Ad types and pricing: Ads on Demand.

post/api/v1/snacks/on-demand

Request

  • Base URL: https://www.vidguy.ai
  • URL: https://www.vidguy.ai/api/v1/snacks/on-demand
  • Auth: HTTP bearer

Request body

shopUrlstring

Store, product page, service site or app listing to make ads from.

typesstring[]

Ad types to make. Omit for the default pack.

countinteger

Number of ads (1-5).

promptstring

Creative steer for every ad (theme, audience, genre, look).

language'en' | 'es' | 'fr' | 'de' | 'it' | 'pt' | 'nl' | 'pl' | 'sq' | 'tr' | 'ru' | 'ar' | 'hi' | 'id' | 'vi' | 'th' | 'ja' | 'ko' | 'zh'

Language of the ads (ISO 639-1). Default en.

adAspectRatio'4:5' | '1:1' | '9:16'

Static-ad frame. Default 4:5.

adFormatsstring[]

Static-ad layouts to use, in order.

animationStyle'claymation' | 'pixar_3d' | 'felt_stop_motion' | 'cartoon_2d'

Animated-ad look.

presenterImageUrlstring uri

Ads only: a photo of the person (or character) to feature instead of a stock presenter. Talking ads film them, animated and music ads draw them in the film's style, and each static ad decides how to show them. At least 256px on the short side.

websiteUrlstring

Website mode (Scale): a snack pack from a website.

dexScreenerUrlstring

Token mode (Scale): a snack pack from a DexScreener pair.

renderboolean

Render PNG / MP4 files (+1 credit for ads, +3 for snack packs).

namestring

Example request

{
  "shopUrl": "https://drinkolipop.com",
  "types": [
    "music-ad"
  ],
  "prompt": "Halloween party theme",
  "language": "es",
  "presenterImageUrl": "https://example.com/presenter.jpg"
}

Response

Ad job accepted.

jobIdstring required
offeringId'snack_generation' required
status'queued' | 'processing' | 'awaiting_selection' | 'completed' | 'failed' | 'cancelled' required
pollUrlstring required
creditsReservedinteger required
renderboolean
typesstring[]
countinteger
snackTypeSequencestring[]
source'shop' | 'website' | 'token'

Example response

{
  "creditsReserved": 76,
  "render": true,
  "types": [
    "music-ad"
  ],
  "count": 1,
  "snackTypeSequence": [
    "music-ad"
  ],
  "source": "shop"
}

Changes

No recorded changes to this operation across all 1 revision of this API.