Snacks

Create a snack pack

Async — kicks off a snack generation job for a brand. Returns a jobId immediately. Optionally renders the snacks server-side when render: true (+3 credits, URLs in result.renderedAssets[]).

post/api/v1/snacks

Request

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

Request body

brandIdstring uuid required
namestring
callbackUrlstring uri
renderboolean

When true, also render PNGs/MP4s server-side. Adds +3 credits. URLs land in result.renderedAssets[].

excludestring[]

Snack types to skip. Still supported with types; exclusions are subtracted after the allow-list is applied.

typesstring[]

Positive snack-type allow-list. Use with count for packs like 5 greenscreen memes or 5 slide carousels.

countinteger

Total snacks to request. When types has one value, all requested snacks use that type.

contextstring

Per-request creative steer woven into the snack copy and asset selection.

promptstring

Alias for context.

Example request

{
  "brandId": "b7f3a8b2-1234-5678-9abc-def012345678",
  "count": 5
}

Response

Snack job accepted.

jobIdstring required
offeringId'snack_generation' required
status'queued' | 'processing' | 'awaiting_selection' | 'completed' | 'failed' | 'cancelled' required
pollUrlstring required
instanceIdstring nullable
creditsReservedinteger required
renderboolean
excludestring[]
typesstring[]
countinteger
snackTypeSequencestring[]

Changes

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