Generate snacks
generate_snacksKick off an ASYNC snack generation job for a brand. SPENDS CREDITS (18–26 — call estimate_snack_cost first). Requires a brandId: call list_brands first, or create_brand if the brand doesn't exist yet. Returns immediately with a jobId; then poll get_job. GENERATION TAKES AT LEAST ~2 MINUTES (typically 2–3 min) — set the user's expectations and don't poll as if it'll be instant. Pass render=true if you want viewable MP4/PNG assets shown inline in chat; without render the result is a layered manifest you open via the dashboard viewUrl. Credits are refunded automatically if generation fails.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| render | No | Also render PNGs/MP4s server-side (+3 credits) | |
| brandId | Yes | Brand UUID to generate snacks for | |
| exclude | No | Snack types to skip; excluding 'ai-ugc' saves 5 credits | |
| callbackUrl | No | Reserved for forthcoming webhook delivery | |
| influencerId | No | Influencer Vault UUID to source person-facing assets from. The influencer must belong to your account and either be linked to this brand or be account-wide. Its character sheet becomes the AI-UGC actor, and its static stills / swapped b-roll feed slides and text-wall. | |
| influencerMode | No | How to use the vault when influencerId is set. 'prefer' (default) uses vault assets first and falls back to the global library per slot; 'require' refuses global fallback for influencer-aware slots (a slot may be skipped if the vault can't fill it). Ignored when influencerId is absent. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | ||
| render | No | ||
| status | Yes | ||
| exclude | No | ||
| pollUrl | Yes | ||
| offeringId | No | ||
| influencerId | No | ||
| influencerMode | No | ||
| creditsReserved | Yes | ||
| snackTypeSequence | No |