Tool reference

Parameters

• querystringoptional

  Case-insensitive filter on the vibiz name or website (e.g. "acme" or "acme.com").

• limitintegeroptional

  Page size.

• cursorstringoptional

  `next_cursor` from the previous page.

Parameters

• platformstringrequired

  Ad platform: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest or twitter (X).

  Values: meta, google, tiktok, linkedin, pinterest, twitter

• actionstringrequired

  "list": ad accounts behind a social account. "connect_url": link to connect ads.

  Values: list, connect_url

• vibizstringoptional

  Brand slug from list_vibiz, e.g. "acme". Omit only when the connector is pinned to one brand.

• socialAccountIdstringoptional

  EXPECTS: social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id`. NOT a Meta platform ad account `act_…` id — that comes back from THIS tool as `accounts[].id`.

• publisher_platformstringoptional

  Meta only: where the campaign runs. Default facebook.

  Values: facebook, instagram

• redirectUrlstringoptional

  Custom URL to redirect the user back to after OAuth (same-token platforms only).

Parameters

• platformstringrequired

  Ad platform: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest or twitter (X).

  Values: meta, google, tiktok, linkedin, pinterest, twitter

• actionstringrequired

  "list": campaign metrics. "tree": campaign → ad sets → ads with budgets (slower).

  Values: list, tree

• vibizstringoptional

  Brand slug from list_vibiz, e.g. "acme". Omit only when the connector is pinned to one brand.

• publisher_platformstringoptional

  Meta only: where the campaign runs. Default facebook.

  Values: facebook, instagram

• statusstringoptional

  Only return items with this status.

  Values: active, paused, pending_review, rejected, completed, cancelled, error

• includeExternalbooleanoptional

  Default false: only campaigns/ads Vibiz created. Set true ONLY when the user asks about everything in the ad account, including campaigns built in Ads Manager.

• limitintegeroptional

  Max campaigns to return (default 20).

• fromDatestringoptional

  Start date, YYYY-MM-DD.

• toDatestringoptional

  End date, YYYY-MM-DD.

Parameters

• platformstringrequired

  Ad platform: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest or twitter (X).

  Values: meta, google, tiktok, linkedin, pinterest, twitter

• actionstringrequired

  "list": ads with metrics. "get": one ad. "analytics": one ad per day. get/analytics need adId.

  Values: list, get, analytics

• vibizstringoptional

  Brand slug from list_vibiz, e.g. "acme". Omit only when the connector is pinned to one brand.

• publisher_platformstringoptional

  Meta only: where the campaign runs. Default facebook.

  Values: facebook, instagram

• statusstringoptional

  Only return items with this status.

  Values: active, paused, pending_review, rejected, completed, cancelled, error

• includeExternalbooleanoptional

  Default false: only campaigns/ads Vibiz created. Set true ONLY when the user asks about everything in the ad account, including campaigns built in Ads Manager.

• campaignIdstringoptional

  EXPECTS: Meta platform campaign id (16-18 digit numeric, e.g. "23859876543210000"). NOT an internal campaign id. Get it from vibiz_ads_campaigns (action "list", platform "meta"), field platformCampaignId.

• fromDatestringoptional

  YYYY-MM-DD

• toDatestringoptional

  YYYY-MM-DD

• limitintegeroptional

  Max rows to return.

• adIdstringoptional

  Internal ad id — a 24-char hex Mongo ObjectId (e.g. "65a3f0c1d2e4b8e9f4a1c2d3"). You get this from vibiz_ads_creatives (action "list", platform "meta"), field id. NOT the Meta platform numeric id, NOT a Vibiz campaign_ad UUID.

• breakdownsarrayoptional

  Optional dimension keys (Meta: age | gender | country | publisher_platform | device_platform | region). Joined into a comma-separated 'breakdowns' query parameter server-side.

Parameters

• platformstringrequired

  Ad platform: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest or twitter (X).

  Values: meta, google, tiktok, linkedin, pinterest, twitter

• levelstringrequired

  "campaign" (Meta only) or "creative" (a single ad, any platform).

  Values: campaign, creative

• idstringrequired

  Platform campaign id, or the internal ad id from vibiz_ads_creatives.

• publisher_platformstringoptional

  Meta only: where the campaign runs. Default facebook.

  Values: facebook, instagram

• vibizstringoptional

  Brand slug from list_vibiz, e.g. "acme". Omit only when the connector is pinned to one brand.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• platformstringrequired

  Ad platform: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest or twitter (X).

  Values: meta, google, tiktok, linkedin, pinterest, twitter

• actionstringrequired

  "create": a new campaign. "boost_post": promote a published social post.

  Values: create, boost_post

• vibizstringoptional

  Brand slug from list_vibiz, e.g. "acme". Omit only when the connector is pinned to one brand.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

• adAccountIdstringoptional

  Meta ad account id ("act_…"). Omit for the selected account.

• namestringoptional

  Campaign name (max 255).

• goalstringoptional

  The ad-set optimization goal — pick the one that matches what the business actually wants, NOT 'traffic' by default. To drive SALES/PURCHASES (most ecommerce + paid offers) use 'conversions'.

  Values: engagement, traffic, awareness, video_views, lead_generation, conversions, app_promotion

• budgetAmountnumberoptional

  Daily budget in the ad account currency, Vibiz fee included unless budgetBasis is "net". $10/day minimum.

• budgetBasisstringoptional

  Default "gross": the budget is the total the founder pays and the Vibiz fee (20%, less at higher budgets) comes out of it, so Meta gets the rest. "net": Meta gets the full budget and the fee is added on top.

  Values: gross, net

• budgetTypestringoptional

  Only 'daily' can be staged in the studio.

  Values: daily, lifetime

• currencystringoptional
• headlinestringoptional
• bodystringoptional
• callToActionstringoptional

  Meta only.

  Values: LEARN_MORE, SHOP_NOW, SIGN_UP, BOOK_TRAVEL, CONTACT_US, DOWNLOAD, GET_OFFER, GET_QUOTE, SUBSCRIBE, WATCH_MORE

• linkUrlstringoptional
• imageUrlstringoptional
• videoobjectoptional
• creativeIdstringoptional

  A Vibiz creative instead of imageUrl/video.

• creativesarrayoptional

  Every ad of the new campaign: ONE call, one approval.

• campaignIdstringoptional

  With adSetId: the live campaign that owns the ad set.

• adSetIdstringoptional

  Stage the ad into this existing ad set (needs campaignId).

• countriesarrayoptional

  REQUIRED for good delivery — ISO-3166 alpha-2 country codes (e.g. ['ES'], ['MX'], ['US'], ['GB']). Do NOT leave empty: Meta defaults to the United States, which burns budget when the ad/business isn't US-facing.

• ageMinintegeroptional
• ageMaxintegeroptional
• interestsarrayoptional

  Optional interest targeting. Each `{id,name}` MUST come from `vibiz_meta_ads_targeting_search` (ads toolset) in this session. Never invent or reuse a remembered id — Meta rejects stale ids (subcode 1487079) and the launch fails.

• specialAdCategoriesarrayoptional
• audienceIdstringoptional

  A Meta custom audience to target.

• advantageAudienceintegeroptional
• budgetLevelstringoptional

  Values: campaign, adset

• pixelIdstringoptional
• conversionEventstringoptional
• urlTagsstringoptional

  The ads' Meta URL parameters as a query string, e.g. 'utm_source=fb&utm_campaign=spring'. Your keys are kept; Vibiz only adds the UTMs you leave out and its own creative id. UTMs already on linkUrl count as yours.

• postIdstringoptional

  EXPECTS: internal post id (24-char hex Mongo ObjectId, e.g. "65a3f0c1d2e4b8e9f4a1c2d3"). Get it from `vibiz_social_publish` response or `vibiz_social_list_posts[].id`. Provide ONE of `postId` or `platformPostId`.

• platformPostIdstringoptional

  EXPECTS: Meta platform post id (e.g. Instagram media id "12345_67890" or Facebook "123_456"). Get it from `vibiz_social_publish` response.platforms[].platformPostId or by polling the post once it has been published on the platform.

• accountIdstringoptional

  EXPECTS: social account id (24-char hex Mongo ObjectId) of the post owner. Get it from `vibiz_social_list_accounts[].id`. NOT the Meta ad account `act_…`.

• budgetobjectoptional
• scheduleobjectoptional
• targetingobjectoptional
• bidAmountnumberoptional

  Meta only.

• trackingobjectoptional

  Meta only.

• endDatestringoptional

  Required for lifetime budgets.

• longHeadlinestringoptional

  Display only — long-form headline (max 90 chars). Required for Google Display ads.

• imagesobjectoptional

  Responsive Display Ads — both `landscape` and `square` are required for Display campaigns.

• businessNamestringoptional

  Business display name shown alongside the ad (max 25 chars). Required for Google Display.

• campaignTypestringoptional

  Pick `display` for image responsive ads, `search` for keyword-targeted text ads.

  Values: display, search

• keywordsarrayoptional

  Search campaigns only — keyword list (one term per entry).

• additionalHeadlinesarrayoptional

  Extra headline variants for responsive Search ads. Google rotates them automatically.

• additionalDescriptionsarrayoptional

  Extra description variants for responsive Search ads. Google rotates them automatically.

• brandIdentityobjectoptional

  TikTok Brand Identity for ads-only accounts (no posting account connected). Omit to auto-fill from workspace branding (brand name + logo); Late caches the identity on the ads account after the first launch.

• boardIdstringoptional

  EXPECTS: Pinterest board id. Required — Pinterest ads must target a specific board.

Parameters

• platformstringrequired

  Ad platform: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest or twitter (X).

  Values: meta, google, tiktok, linkedin, pinterest, twitter

• levelstringrequired

  "campaign" or "creative" (a single ad).

  Values: campaign, creative

• idsarrayrequired

  Platform campaign ids (level campaign) or internal ad ids (level creative).

• publisher_platformstringoptional

  Meta only: where the campaign runs. Default facebook.

  Values: facebook, instagram

• vibizstringoptional

  Brand slug from list_vibiz, e.g. "acme". Omit only when the connector is pinned to one brand.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• checkOriginstringoptional

  Optional origin (e.g. https://www.example.com) to fetch and scan for the Vibiz tag. Proves the tag is on the page, not that events are accepted.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• addOriginsarrayoptional

  Origins to allow, e.g. ["https://www.example.com"].

• removeOriginsarrayoptional

  Origins to remove from the allow list (exact).

• metaPixelIdstringoptional

  Numeric Meta pixel id to send conversions to.

• forwardMetabooleanoptional

  Turn server-side conversion forwarding to Meta on/off.

• metaTestEventCodestringnulloptional

  Meta test event code (TEST12345). While set, forwarded events go to Test Events only. null leaves test mode.

• acknowledgeNativeTagbooleanoptional

  Proceed with forwarding although the page runs its own Meta pixel. Only after the user confirms they share eventIDs or removed the pixel.

Parameters

• vibizstringoptional

  Brand slug from list_vibiz, e.g. "acme". Omit only when the connector is pinned to one brand.

Parameters

• vibizstringoptional

  Same value as in the plan.

• formatstringrequired

  Same value as in the plan.

  Values: image, carousel, video, ugc, product_shot

• briefstringrequired

  Same value as in the plan.

• countintegeroptional

  Same value as in the plan.

• placementstringoptional

  Same value as in the plan.

• offer_idstringoptional

  Same value as in the plan.

• durationstringoptional

  Same value as in the plan.

  Values: 4s, 6s, 8s

• resolutionstringoptional

  Same value as in the plan.

  Values: 480p, 720p, 1080p

• extra_fieldsobjectoptional

  Same value as in the plan.

Parameters

• querystringrequired

  What the user wants, in their words, e.g. "reply to my instagram DMs".

• limitintegeroptional

  Max matches (default 5).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• imageUrlstringoptional

  Public http(s) URL of the image/video to upload. The server fetches and stores it. Best option for most clients.

• imageBase64stringoptional

  Base64-encoded file bytes (no data: prefix). Requires `contentType`. Small files only (≤ 3 MB); larger local files use the presigned mode (omit imageUrl and imageBase64).

• filenamestringoptional

  Original filename, used to derive the file extension. Example: "hero-shot.jpg". Optional when `imageUrl` is given.

• contentTypestringoptional

  MIME type. Required for `imageBase64` and the presigned mode; inferred from the response for `imageUrl`.

  Values: image/jpeg, image/png, image/webp, image/gif, video/mp4, video/quicktime

Parameters

• runIdstringrequired

  Trigger.dev run id from a vibiz_generate_* tool response.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

Parameters

• vibizstringoptional

  Brand slug from list_vibiz, e.g. "acme". Omit only when the connector is pinned to one brand.

• rangestringoptional

  "7d" for last week (default), "30d" for last month, "90d" for the quarter.

  Values: 7d, 30d, 90d

• platformsarrayoptional

  Ads platforms to include (default: all six; unconnected ones are skipped).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• platformstringoptional
• statusstringoptional

  Values: draft, queued, processing, succeeded, failed

• mediaTypestringoptional

  Values: image, video, any

• limitintegeroptional
• onlyFavoritesbooleanoptional
• currentVersionsOnlybooleanoptional
• displaybooleanoptional

  Set true when the user should see the inline creatives gallery in chat.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• campaignIdstringrequired

  Meta platform campaign id from vibiz_ads_campaigns (action "tree", platform "meta"), field platformCampaignId.

• adSetIdstringrequired

  Meta platform ad set id from vibiz_ads_campaigns (action "tree", platform "meta"), field adSets[].platformAdSetId`.

• linkUrlstringoptional

  Default destination URL when a creative omits linkUrl (usually the funnel / landing page).

• urlTagsstringoptional

  The ads' Meta URL parameters as a query string, e.g. 'utm_source=fb&utm_campaign=spring'. Your keys are kept; Vibiz only adds the UTMs you leave out and its own creative id. UTMs already on linkUrl count as yours.

• creativesarrayrequired
• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• dailyBudgetnumberrequired

  The amount as the founder stated it (major units).

• budgetCurrencystringoptional

  ISO currency of `dailyBudget`. Default USD.

• adAccountIdstringoptional

  Optional Meta ad account (act_…). Default: the workspace-selected account.

• inAccountCurrencybooleanoptional

  true when `dailyBudget` is already in the ad account's currency (a launch `budgetAmount`); `budgetCurrency` is then ignored.

• budgetTypestringoptional

  Budget cadence for the fee quote. Default daily.

  Values: daily, lifetime

• budgetBasisstringoptional

  Default "gross": the budget is the total the founder pays and the Vibiz fee (20%, less at higher budgets) comes out of it, so Meta gets the rest. "net": Meta gets the full budget and the fee is added on top.

  Values: gross, net

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• pixelIdstringrequired

  Meta pixel id (digits).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• socialAccountIdstringrequired

  EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or vibiz_ads_accounts (action "list", platform "meta") ancestor.

• adAccountIdstringrequired

  EXPECTS: Meta platform ad account id (string starting with "act_"). Get it from vibiz_ads_accounts (action "list", platform "meta"), field id.

• namestringrequired

  Human-readable pixel name shown in Meta Events Manager. Tip: include the workspace name so a user with multiple pixels can tell them apart (e.g. 'NeceSera — Main Site Pixel').

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• socialAccountIdstringrequired

  EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or vibiz_ads_accounts (action "list", platform "meta") ancestor.

• adAccountIdstringoptional

  EXPECTS: Meta platform ad account id (string starting with "act_"). Get it from vibiz_ads_accounts (action "list", platform "meta"), field id. OPTIONAL — omit to list pixels across every ad account on this social account.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• socialAccountIdstringrequired

  EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or vibiz_ads_accounts (action "list", platform "meta") ancestor.

• pixelIdstringrequired

  EXPECTS: Zernio tracking-tag id (returned as `tag.id` from `vibiz_meta_ads_pixels_create`, or `data[].id` from `vibiz_meta_ads_pixels_list`).

• aggregationstringoptional

  Aggregation dimension. Defaults to Zernio's server-side default (event) when omitted.

  Values: event, host, url, device_type

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• entityTypestringrequired

  Values: campaign, adset, ad

• idsarrayrequired

  Meta platform ids of the given level: campaign ids, ad set ids, or Zernio ad ids (vibiz_ads_creatives (action "list", platform "meta"), field id).

• dailyBudgetnumberrequired

  New daily budget in major units (20 = $20/day).

• campaignIdstringoptional

  Required when entityType is "adset": the campaign owning the ad sets. Meta platform campaign id (16-18 digits) from vibiz_ads_campaigns (action "tree", platform "meta"), field platformCampaignId. NOT a Zernio ObjectId or a Vibiz UUID.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• urlstringoptional

  Website or Instagram URL, e.g. https://acme.com or instagram.com/acme. Required unless vibiz resumes an existing brand.

• workspace_namestringoptional

  Display name for a new vibiz; defaults to the site name.

• vibizstringoptional

  Slug of a vibiz to resume instead of creating one.

Parameters

• vibizstringoptional

  Brand slug from list_vibiz, e.g. "acme". Omit only when the connector is pinned to one brand.

• formatstringrequired

  image (static ad), carousel (multi-slide), video (ad video), ugc (creator-style talking video), product_shot (product photo in a scene).

  Values: image, carousel, video, ugc, product_shot

• briefstringrequired

  What to make, in the user's words: offer, angle, audience, must-say lines.

• countintegeroptional

  How many variations, 1-4.

• placementstringoptional

  Where it runs, e.g. instagram_portrait, tiktok_story, facebook_feed, tiktok/reels/shorts for UGC.

• offer_idstringoptional

  Offer to feature, from vibiz_list_offers (workspace toolset). Optional.

• durationstringoptional

  video / ugc length. Default 4s (video), 8s (ugc).

  Values: 4s, 6s, 8s

• resolutionstringoptional

  ugc render quality (video: 720p or 1080p). Default 720p.

  Values: 480p, 720p, 1080p

• extra_fieldsobjectoptional

  Format-specific upstream fields (product_shot needs productTitle, productImageUrl, recipeId).

Parameters

• toolstringoptional

  The tool that answered approval_required, e.g. vibiz_social_publish.

• argumentsobjectoptional

  The exact arguments for that tool (without approval_token).

• callsarrayoptional

  Or all steps of one plan, ONE approval; a later step may use {{call:N.campaignId}} / {{call:N.adSetId}}. Each runs once.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• statusstringoptional

  Filter by status.

  Values: draft, scheduled, published, failed

• platformstringoptional

  Filter by platform.

• limitnumberoptional

  Max posts (1-100, default 10).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• contentstringrequired

  Post text.

• platformsarrayrequired

  Platforms + account IDs.

• mediaUrlsarrayoptional

  Image or video URLs to attach. A URL ending in .mp4 or .mov posts as a video (Reel, TikTok, Short where the platform supports it); anything else as an image. Upload local files first with vibiz_gallery_upload and use its publicUrl.

• scheduledForstringoptional

  When to publish: an ISO 8601 date-time in UTC (e.g. 2026-11-03T09:00:00Z) that is in the FUTURE — check the current year first. A past time is refused, and the error carries the real `now`. Omit to publish immediately.

• hashtagsarrayoptional

  Hashtags.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• personIdstringrequired
• genderstringoptional

  Values: female, male

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• videoUrlstringrequired

  The video to watch — a Vibiz or ad-platform url.

• mimeTypestringoptional

  Only when it is not mp4 (e.g. video/webm).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• sourceAdIdstringrequired

  The campaign_ad UUID of the existing static image to animate. Copy the adId from `vibiz_generate_image` (creatives toolset) output or the creatives gallery; never invent an ID.

• sourceImageUrlstringrequired

  The image URL of that ad (must be a valid https URL).

• promptstringoptional

  Animation description (up to 500 characters): how should the image come to life? E.g. "gentle camera push-in, subject smiles and nods". Optional — a sensible default is used if omitted.

• aspectRatiostringoptional

  Output aspect ratio. "auto" infers from the source image. Default "auto".

  Values: 16:9, 9:16, auto

• durationstringoptional

  Video length. Default "4s".

  Values: 4s, 6s, 8s

• resolutionstringoptional

  Default "720p".

  Values: 720p, 1080p

• generateAudiobooleanoptional

  Default true.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• photoUrlstringrequired

  The photograph to build on (https; Unsplash, Pexels or Vibiz storage).

• headlinestringoptional

  Three to six words.

• subheadstringoptional

  One short supporting line.

• platformstringoptional

  Values: instagram_square, instagram_portrait, instagram_story, facebook_feed, landscape

• logoCornerstringoptional

  Values: top-left, top-right, bottom-left, bottom-right

• noScrimbooleanoptional
• offerIdstringoptional

  Offer this ad is for, from vibiz_list_offers (workspace toolset).

• icpIdstringoptional

  Audience this ad is for, from vibiz_list_icps (workspace toolset).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• creativeIdstringoptional

  A creative id. Returns its full provenance and beliefs.

• icpIdstringoptional

  An ICP id from vibiz_list_icps (workspace toolset). Returns everything made for that audience.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• adIdstringrequired

  The creative (ad) id.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• referenceImageUrlstringoptional

  Public URL of the image to edit from the gallery, or omit when using conversationImageId for a chat upload.

• conversationImageIdstringoptional

  When the user attached the canvas image in chat, pass image-N from conversation labels.

• promptstringrequired

  What to change about the image. Be specific about the edit ("make the background sunset orange", "remove the watermark", "add a SHOP NOW button in the bottom-right"). Avoid storyboard/frame-style prompts — this is a single-image edit, not motion.

• platformstringoptional

  Target platform for the edited image. MUST be one of the listed values. Default: "instagram_portrait".

  Values: linkedin, instagram_portrait, instagram_story, facebook_feed, tiktok_story, landscape_3_2, landscape_4_3, landscape_5_4, cinematic

• aspectRatiostringoptional

  Optional output aspect ratio. If omitted, derived from `platform`. Note: changing aspect ratio relative to the source may crop or extend the image.

  Values: 1:1, 16:9, 9:16, 4:5, 3:2

• stylestringoptional

  Per-category style key. "hero-shot" is the default; pick the category whose visual style matches user intent.

  Values: hero-shot, lifestyle-shot, ugc, hyperrealistic, saas-demo, founder-portrait, infographic

• imageCountintegeroptional

  Number of edit VARIATIONS to generate (1-4). Default 1. Useful when the user wants to compare multiple takes on the same edit.

• additionalReferenceImagesarrayoptional

  Optional Discover/gallery URLs from prior tool output. Chat extras use conversationImageIds.

• conversationImageIdsarrayoptional

  Additional chat upload references (image-1, image-2, …).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• idstringrequired

  The meme video id from vibiz_produce_meme_videos (creatives toolset) `videos[].id`.

• captionstringoptional

  The new caption on the video. Omit to keep it.

• templateIdstringoptional

  A meme template id the user gave. Omit to keep the current meme.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• adIdstringrequired

  The ad id of the rendered video to finish.

• subtitlesbooleanoptional

  Add subtitles (captions of the spoken audio).

• subtitleStylestringoptional

  Caption style. Default hormozi.

  Values: hormozi, beast, karaoke, classic, minimal, bounce, editorial, glass, gold, boxed, statement

• subtitleLanguagestringoptional

  ISO 639-1 code of the spoken language, only when the user named it; omitted = auto-detected.

• musicstringoptional

  Add a music bed: what it should sound like over time. Omit for no music.

• musicDurationSecnumberoptional

  Optional upper bound for the bed; defaults to just under the video length.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• promptstringrequired

  Describe the full ad as ONE scene: subject, setting, brand framing, movement, on-screen copy. Do NOT provide frame-by-frame storyboards.

• platformstringoptional

  Target platform. Mapped to a video aspect ratio server-side (9:16 for story platforms, 16:9 otherwise). Default: "facebook_feed".

  Values: linkedin, instagram_portrait, instagram_story, facebook_feed, tiktok_story, landscape_3_2, landscape_4_3, landscape_5_4, cinematic

• videoDurationstringoptional

  Video length. Default "4s".

  Values: 4s, 6s, 8s

• videoResolutionstringoptional

  Default "720p".

  Values: 720p, 1080p

• generateAudiobooleanoptional

  Default true.

• useBrandbooleanoptional

  Apply workspace brand kit. Default true.

• allowPartialBrandbooleanoptional

  Draft override. Default false. Set true only when the user explicitly asks to generate before onboarding/branding/product setup is ready; the result may be off-brand.

• referenceImagesarrayoptional

  Optional Discover/gallery URLs from prior tool output. Chat uploads must use conversationImageIds.

• conversationImageIdsarrayoptional

  Chat upload references (image-1, image-2, …). Never copy attachment URLs into referenceImages.

• offerIdstringoptional

  Offer/product id this video is for. Get it from `vibiz_list_offers[].id` (workspace toolset). When set, the director script is grounded to the product's title/details/image. REQUIRED when the user said 'a video ad for my product' / 'video for this offer' — call `vibiz_list_offers` (workspace toolset) first and ASK if multiple plausible offers exist.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• promptstringrequired

  What the carousel is about: topic, angle, key message. The generator writes per-slide copy — you describe the story, not the individual slides.

• slideCountintegeroptional

  Number of slides (2-10). Default 3. Higher slide counts cost more credits (1 per slide).

• platformstringoptional

  Publishing destination. instagram_portrait=IG feed carousel 4:5; instagram_story=IG Story/Reels 9:16; tiktok_story=TikTok 9:16; linkedin=1:1; facebook_feed=1:1. Infer from context or ask one placement question if unclear.

  Values: instagram_portrait, instagram_story, linkedin, facebook_feed, tiktok_story

• aspectRatiostringoptional

  Optional override. Usually omit — derived from platform. Set only when the user explicitly requests a ratio different from the platform default.

  Values: 1:1, 16:9, 9:16, 4:5, 3:2

• useBrandbooleanoptional

  Apply workspace brand kit (colors, fonts, logo, tone). Default true.

• allowPartialBrandbooleanoptional

  Draft override. Default false. Set true only when the user explicitly asks to generate before onboarding/branding/product setup is ready; the result may be off-brand.

• offerIdstringoptional

  Offer/product id this carousel is about. Get it from `vibiz_list_offers[].id` (workspace toolset). When set, slide copy + visuals are grounded to that product. REQUIRED when the user said 'my product' / 'a carousel about [thing I sell]' — call `vibiz_list_offers` (workspace toolset) first and ASK if multiple offers could match.

• slidesarrayoptional

  Optional pre-authored carousel slides. When set, generation uses these headlines/copy instead of replanning the story.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• promptstringrequired

  Describe the STATIC IMAGE to generate. Do not structure as storyboard/frames.

• platformstringoptional

  Target platform. MUST be one of the listed values. Common mappings: TikTok → "tiktok_story", Instagram feed → "instagram_portrait", Instagram story → "instagram_story", Facebook → "facebook_feed", LinkedIn → "linkedin". Default: "instagram_portrait".

  Values: linkedin, instagram_portrait, instagram_story, facebook_feed, tiktok_story, landscape_3_2, landscape_4_3, landscape_5_4, cinematic

• aspectRatiostringoptional

  Optional. If omitted, derived from `platform`. 9:16 = vertical, 1:1 = square, 16:9 = landscape.

  Values: 1:1, 16:9, 9:16, 4:5, 3:2

• stylestringoptional

  Optional per-category style key. Omit unless the user picked or asked for a specific style. Use hero-shot for product-first studio hero, lifestyle-shot for planned real-world product context, ugc for social-native creator/phone-camera product shots, hyperrealistic for cinematic photographic realism, saas-demo for product UI, founder-portrait for trust-building, infographic for diagrams.

  Values: hero-shot, lifestyle-shot, ugc, hyperrealistic, saas-demo, founder-portrait, infographic

• useBrandbooleanoptional

  Apply the workspace brand kit (colors, fonts, logo, tone). Default true. Set false only if the user explicitly wants a generic look.

• allowPartialBrandbooleanoptional

  Draft override. Default false. Set true only when the user explicitly asks to generate before onboarding/branding/product setup is ready; the result may be off-brand.

• imageCountintegeroptional

  Number of VARIATIONS of the SAME image to generate (1-4). Default 1. NOT for making a video storyboard, use `vibiz_generate_ugc` (creatives toolset) for motion content.

• referenceImagesarrayoptional

  Optional Discover/gallery URLs from prior tool output (e.g. vibiz_get_for_you originalUrl). Never paste chat attachment URLs here — use conversationImageIds instead.

• conversationImageIdsarrayoptional

  Chat upload references (image-1, image-2, … from conversation labels). Required when the user attached images in chat.

• offerIdstringoptional

  Offer/product id this generation is for. Get it from `vibiz_list_offers[].id` (workspace toolset). When set, the prompt builder grounds the image to that product (title, price, image, source URL). REQUIRED when the user said 'my product' / 'this offer' — call `vibiz_list_offers` (workspace toolset) first and pass the matching id. If the workspace has multiple offers and the user didn't disambiguate, ASK them which one before calling this tool.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• productIdstringoptional

  Optional product id from vibiz_list_offers (workspace toolset).

• productTitlestringrequired

  Catalog product title.

• productImageUrlstringrequired

  Public URL for the exact catalog product image.

• productDescriptionstringoptional

  Optional product material and construction context.

• vendorstringoptional

  Optional product vendor.

• productTypestringoptional

  Optional product category.

• talentPresetIdstringoptional

  Optional style-based character sheet for recipes with a visible person.

  Values: sienna-vale, maya-sol, ren-hale, luca-arden, dax-mercer, milo-cruz, nia-laurent, ezra-cole, imani-roe, ravi-sloane, cleo-hart, ruby-voss, theo-maren, elara-quinn

• userNotesstringoptional

  Optional refinement subordinate to the selected recipe.

• secondaryProductImageUrlstringoptional

  Optional second product view for construction accuracy.

• allowPartialBrandbooleanoptional

  Allow generation before all onboarding context is ready.

• recipeIdstringrequired

  Exact Product Studio recipe id.

  Values: influencer_ugc.y2k_revival, influencer_ugc.quiet_luxury_scandi, influencer_ugc.coastal_grandmother, influencer_ugc.skater_thrasher, influencer_ugc.balletcore_soft_girl, influencer_ugc.gorpcore_techwear, influencer_ugc.dark_academia_indie_sleaze, influencer_ugc.cottagecore_picnic, influencer_ugc.metallic_y3k_futurist, influencer_ugc.old_money_prep, influencer_ugc.clean_girl, influencer_ugc.mob_wife, influencer_ugc.blokecore, influencer_ugc.festival, influencer_ugc.rave_cyber_y2k, model_on_body.studio_front_on, model_on_body.studio_three_quarter, model_on_body.studio_back_view, model_on_body.studio_editorial_dramatic, model_on_body.sunlit_outdoor_front, model_on_body.sunlit_outdoor_walking, model_on_body.full_body_editorial_pose, model_on_body.walking_motion, model_on_body.seated_reclined, model_on_body.cropped_application_detail, model_on_body.face_adjacent_closeup, model_on_body.candid_off_guard, model_on_body.fabric_motion_shot, model_on_body.layered_styling_context, model_on_body.mirror_reflection_on_body, packshot_catalog.front, packshot_catalog.three_quarter, packshot_catalog.side_profile, packshot_catalog.back, packshot_catalog.elevated_product, packshot_catalog.ghost_mannequin, product_hero_editorial.pedestal, product_hero_editorial.sculptural_shadow, product_hero_editorial.chrome_glass, product_hero_editorial.monochrome, product_hero_editorial.hard_flash, product_hero_editorial.graphic_color_field, product_hero_editorial.floating_composition, product_hero_editorial.material_led_hero, product_hero_editorial.architectural_composition, product_hero_editorial.minimal_premium_hero, lifestyle_in_use.outdoor_everyday_use, lifestyle_in_use.home_interior_everyday_use, lifestyle_in_use.workspace_desk_use, lifestyle_in_use.kitchen_mealtime_use, lifestyle_in_use.travel_on_the_go_use, lifestyle_in_use.social_gathering_use, lifestyle_in_use.fitness_active_use, lifestyle_in_use.pet_companion_use, lifestyle_in_use.automotive_commute_use, lifestyle_in_use.seasonal_weather_specific_use, flat_lay.clean_grid, flat_lay.styled_editorial, flat_lay.fabric_bed_surface, flat_lay.desk_layout, flat_lay.food_serving_layout, flat_lay.kit_collection_layout, flat_lay.asymmetric_composition, flat_lay.exploded_layout, detail_macro.material_texture, detail_macro.stitching_construction, detail_macro.hardware, detail_macro.label_graphic, detail_macro.surface_formula_texture, detail_macro.closure_fastener, detail_macro.sole_ports_functional_detail, detail_macro.edge_profile_finish, in_hand_held.close_natural_grip, in_hand_held.face_adjacent, in_hand_held.palm_scale_reference, in_hand_held.pov_reach, in_hand_held.passing_the_product, in_hand_held.casual_carry, in_hand_held.direct_flash_handheld, in_hand_held.refined_pdp_hand_crop, unboxing_delivery.bed_unboxing, unboxing_delivery.table_unboxing, unboxing_delivery.doorstep_delivery_moment, unboxing_delivery.packaging_peel_open, unboxing_delivery.hands_only_reveal, unboxing_delivery.box_contents_collection, routine_application.bathroom, routine_application.bedroom_getting_ready, routine_application.desk_workday, routine_application.gym_post_workout, routine_application.kitchen_morning_routine, routine_application.travel_pouch_hotel, routine_application.car_commute, routine_application.before_going_out, environment_placement.shelf, environment_placement.desk, environment_placement.bedside, environment_placement.kitchen_bathroom_counter, environment_placement.full_room_hero, environment_placement.workshop_workbench, environment_placement.installed_placement, environment_placement.retail_display_context, process_action.pouring, process_action.applying, process_action.spraying, process_action.opening, process_action.assembling, process_action.installing, process_action.plating, process_action.preparing_using

• aspectRatiostringoptional

  Optional output frame. The recipe default is preferred.

  Values: 1:1, 3:4, 9:16, 4:3, 16:9

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• productIdstringoptional

  Optional product id from vibiz_list_offers (workspace toolset).

• productTitlestringrequired

  Catalog product title.

• productImageUrlstringrequired

  Public URL for the exact catalog product image.

• productDescriptionstringoptional

  Optional product material and construction context.

• vendorstringoptional

  Optional product vendor.

• productTypestringoptional

  Optional product category.

• talentPresetIdstringoptional

  Optional style-based character sheet for recipes with a visible person.

  Values: sienna-vale, maya-sol, ren-hale, luca-arden, dax-mercer, milo-cruz, nia-laurent, ezra-cole, imani-roe, ravi-sloane, cleo-hart, ruby-voss, theo-maren, elara-quinn

• userNotesstringoptional

  Optional refinement subordinate to the selected recipe.

• secondaryProductImageUrlstringoptional

  Optional second product view for construction accuracy.

• allowPartialBrandbooleanoptional

  Allow generation before all onboarding context is ready.

• bundleIdstringrequired

  launch_essentials, social_content, pdp_catalog, influencer_collection, or model_collection.

  Values: launch_essentials, social_content, pdp_catalog, influencer_collection, model_collection

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• productNamestringrequired

  Short product / brand / service name the video is about (e.g. "Vibiz", "Acme Coffee Subscription"). Required.

• productDetailsstringrequired

  Paragraph describing the product, target audience, hooks, differentiators, and any tone/style notes. Required. Do NOT send a storyboard — describe the product + why it matters; the task writes its own script.

• scriptstringoptional

  Optional full UGC script you wrote: spoken lines in quotes, beats, camera, sound. Address a reference image as Image 1. When set, it is rendered as written (styleId, videoStyle, hook and creatorGender are not applied).

• styleIdstringoptional

  Named UGC style (see `vibiz_list_ugc_styles` (creatives toolset)). Prefer this over `videoStyle`.

  Values: punchy-review, spicy-review, secret-review, asmr-unbox, slow-unbox, grwm-chaos, mirror-grwm, tryon-whisper, tryon-mic, street-demo, candid-demo

• videoStylestringoptional

  Legacy talking-head style (ignored when `styleId` is set). talking_head is the default face-led phone-shot look.

  Values: talking_head, review, unboxing, pov

• platformstringoptional

  Target short-form platform. Drives aspect ratio + pacing. Default "tiktok".

  Values: tiktok, reels, shorts

• durationstringoptional

  Video length. Default "8s".

  Values: 4s, 6s, 8s

• resolutionstringoptional

  Render quality. Default "720p".

  Values: 480p, 720p, 1080p

• creatorGenderstringoptional

  Presented gender of the AI creator / talking head. Default "female".

  Values: female, male

• hookstringoptional

  Optional opening hook line (max 200 chars). If omitted, the task generates one from productDetails.

• referenceImageUrlstringoptional

  Optional product, brand, or style reference from a prior tool output URL. Chat uploads must use conversationImageId instead.

• conversationImageIdstringoptional

  When the user attached a reference image in chat, pass image-N from conversation labels.

• conversationImageIdsarrayoptional

  Additional chat upload references (image-1, image-2, …).

• offerIdstringoptional

  Offer/product id this UGC clip is for. Get it from `vibiz_list_offers[].id` (workspace toolset). When set, the chat agent's chosen offer is recorded on the resulting ad row so downstream tooling can reuse it. REQUIRED when the user said 'a UGC about my product' / 'spokesperson video for [thing I sell]' — call `vibiz_list_offers` (workspace toolset) first and ASK if multiple plausible offers exist.

• allowPartialBrandbooleanoptional

  Draft override. Default false. Set true only when the user explicitly asks to generate before onboarding/branding/product setup is ready; the result may be off-brand.

• icpIdstringoptional

  Optional selected ICP/customer profile id. Use when the user names a target audience or when an offer has a clear linked ICP; it shapes the UGC hook and creator angle.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• displaybooleanoptional

  Set true when the user should see the inline Discover inspiration gallery in chat.

• limitnumberoptional

  Max items to return (1..48, default 24).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

Parameters

• displaybooleanoptional

  Set true to render the inline UGC style preview gallery in chat. Omit when doing a silent lookup.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• imageUrlstringrequired

  The generated creative to look at.

• logoUrlstringoptional

  The official logo. Omit to use the workspace logo on file.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• countintegeroptional

  How many videos, 1 to 5. Default 3.

• anglestringoptional

  What the user asked for, in their words: angles, topic or tone (e.g. 'make fun of doing invoices by hand'). Omit when they just asked for meme videos.

• templateIdsarrayoptional

  Only when the user gave specific meme template ids, in order — video 1 uses the first. The other videos get memes picked to fit. Never guess an id.

Parameters

• platformstringrequired

  Ad platform: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest or twitter (X).

  Values: meta, google, tiktok, linkedin, pinterest, twitter

• levelstringrequired

  "campaign" or "creative" (a single ad).

  Values: campaign, creative

• idsarrayrequired

  Platform campaign ids (level campaign) or internal ad ids (level creative).

• publisher_platformstringoptional

  Meta only: where the campaign runs. Default facebook.

  Values: facebook, instagram

• vibizstringoptional

  Brand slug from list_vibiz, e.g. "acme". Omit only when the connector is pinned to one brand.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• titlestringrequired
• descriptionstringoptional
• reasonstringoptional

  One short sentence: the 'why now'.

• impactstringoptional

  Short expected outcome, e.g. '+8-12 leads/week'.

• approveLabelstringoptional
• sessionIdstringoptional
• planDayintegeroptional

  Rolling 3-day plan: 1 = today, 2 = tomorrow, 3 = day after. Omit for a one-off proposal.

• toolsarrayoptional

  Every write tool or subagent running the card will use; [] for read-only work. The platform computes `critical` from this list.

• ownerstringoptional

  Who runs the card: ads-operator for ad changes, cto for site work, researcher, video, or ceo.

  Values: ceo, ads-operator, cto, researcher, video

• planstringoptional

  Agent-only, never shown to the founder: the full markdown plan the run executes and is graded against (scope, acceptance criteria, links, risks).

• areastringoptional

  The card's domain.

  Values: ads, site, social, leads, offers, content, research, other

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• platformstringrequired

  Values: meta, google, tiktok, linkedin, pinterest, twitter

• objectivestringrequired

  traffic = site visits, conversions = sales/sign-ups, lead_generation = forms.

  Values: awareness, traffic, engagement, lead_generation, conversions, video_views, app_promotion

• daily_budgetnumberrequired

  "$30 a day" → 30. Never assume one.

• currencystringoptional

  ISO-4217, default USD.

• creative_idstringoptional

  Creative id (Meta).

• image_urlstringoptional

  Public image URL when there is no creative_id.

• briefstringoptional

  What the ad sells; its first sentence becomes the headline and the rest the body when those are omitted.

• headlinestringoptional
• bodystringoptional
• link_urlstringoptional

  Landing page.

• call_to_actionstringoptional

  e.g. LEARN_MORE, SHOP_NOW, SIGN_UP.

• countriesarrayoptional

  e.g. ["US","CA"]. Ask the user; do not default to US.

• audience_hintstringoptional

  Who it is for, in the user's words. An age range in it ("25-45", "18+") becomes age targeting where the platform supports it; the rest is shown as a note, not targeted.

• age_minintegeroptional
• age_maxintegeroptional
• ad_account_idstringoptional

  Required off Meta.

• social_account_idstringoptional

  From vibiz_social_list_accounts. Required off Meta.

• campaign_namestringoptional
• extra_fieldsobjectoptional

  Platform-specific launch_create fields only.

• modestringoptional

  Values: plan, execute

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• campaignIdstringrequired

  Meta platform campaign id (16-18 digits) from vibiz_ads_campaigns (action "tree", platform "meta"), field platformCampaignId. NOT a Zernio ObjectId or a Vibiz UUID.

• adSetIdsarrayrequired

  Meta platform ad set id from vibiz_ads_campaigns (action "tree", platform "meta"), field adSets[].platformAdSetId`.

• statusstringoptional

  Default "active". "paused" is refused for agents.

  Values: active, paused

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• sourcesarrayoptional

  Omit to build every buildable Vibiz audience. Values: auto_site_visitors, auto_leads_list, auto_page_engagers, auto_ig_engagers, or page_engagers:<pageId> / ig_engagers:<igUserId>.

• adAccountIdstringoptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• adAccountIdstringoptional

  Meta ad account ("act_…"); default the selected one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• adAccountIdstringoptional

  Meta ad account ("act_…"); default the selected one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• campaignIdstringrequired

  EXPECTS: Meta platform campaign id (16-18 digit numeric). Get it from vibiz_ads_campaigns (action "list", platform "meta"), field platformCampaignId.

• platformstringrequired

  Values: facebook, instagram

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• sourceCampaignIdstringrequired

  The live campaign to copy (platformCampaignId).

• namestringoptional

  The copy's name.

• adAccountIdstringoptional

  Put the copy on this Meta ad account ('act_…').

• goalstringoptional

  Switch the copy to another goal (Meta fixes a campaign's objective at creation, so a new goal needs a copy). `conversions` = Sales: optimizes on PURCHASE on the workspace pixel unless you pass conversionEvent / pixelId. Omit to keep the source's goal.

  Values: lead_conversion, conversions, signup, traffic, awareness, engagement, video_views, lead_generation

• conversionEventstringoptional

  Optimize the copy for this event instead; it must fit the copy's goal.

  Values: LEAD, COMPLETE_REGISTRATION, CONTACT, SCHEDULE, SUBMIT_APPLICATION, SUBSCRIBE, START_TRIAL, PURCHASE, INITIATED_CHECKOUT, ADD_TO_CART, ADD_PAYMENT_INFO

• pixelIdstringoptional
• dailyBudgetnumberoptional

  Override the daily budget (the campaign budget on CBO, every ad set on ABO).

• pauseSourcebooleanoptional

  Pause the original campaign once the copy is live (gateway only). Outside the gateway the original keeps running: the founder pauses it after launching the copy.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• campaignIdstringrequired

  Meta platform campaign id from vibiz_ads_campaigns (action "tree", platform "meta"), field platformCampaignId.

• adSetNamestringrequired

  Name for the new ad set (max 255 chars).

• dailyBudgetnumberoptional

  Required for ABO campaigns (ad-set budget). Omit when the parent campaign is CBO.

• goalstringoptional

  The ad-set optimization goal — pick the one that matches what the business actually wants, NOT 'traffic' by default. To drive SALES/PURCHASES (most ecommerce + paid offers) use 'conversions'. To collect LEADS (forms, sign-ups, quote requests) use 'lead_generation'. Only use 'traffic' when the user explicitly just wants clicks/visits — it optimizes for cheap clicks, not buyers, so it usually wastes spend for a sales business. 'engagement'/'awareness'/'video_views' are top-of-funnel only.

  Values: engagement, traffic, awareness, video_views, lead_generation, conversions, app_promotion

• budgetTypestringoptional

  Values: daily, lifetime

• linkUrlstringoptional

  Default destination URL for creatives missing linkUrl.

• urlTagsstringoptional

  The ads' Meta URL parameters as a query string, e.g. 'utm_source=fb&utm_campaign=spring'. Your keys are kept; Vibiz only adds the UTMs you leave out and its own creative id. UTMs already on linkUrl count as yours.

• countriesarrayoptional

  REQUIRED for good delivery — ISO-3166 alpha-2 country codes (e.g. ['ES'], ['MX'], ['US'], ['GB']). Do NOT leave empty: Meta defaults to the United States, which burns budget when the ad/business isn't US-facing. Unless the user already told you where to run the ads, ASK before launching — recommend countries from the ICP's geography and the business's market, and offer worldwide as an option; don't silently infer. Match the creative's language and the customer's location — Spanish copy for a Spain business → ['ES'], Spanish for Mexico → ['MX'], English US business → ['US']; never default to ['US'] unless the audience really is the US.

• ageMinintegeroptional
• ageMaxintegeroptional
• interestsarrayoptional

  Optional interest targeting. Each `{id,name}` MUST come from `vibiz_meta_ads_targeting_search` (ads toolset) in this session. Never invent or reuse a remembered id — Meta rejects stale ids (subcode 1487079) and the launch fails. Omit the array to launch broad / Advantage+ without interests.

• creativesarrayrequired
• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• campaignIdstringrequired

  The campaign owning the SOURCE ad set. Meta platform campaign id (16-18 digits) from vibiz_ads_campaigns (action "tree", platform "meta"), field platformCampaignId. NOT a Zernio ObjectId or a Vibiz UUID.

• adSetIdstringrequired

  The source ad set (or the ad set owning `adId`). Meta platform ad set id from vibiz_ads_campaigns (action "tree", platform "meta"), field adSets[].platformAdSetId`.

• adIdstringoptional

  Copy only this ad (platform ad id or Zernio ad id). Omit to copy the whole ad set.

• targetCampaignIdstringoptional

  Destination campaign. For an ad set copy: where it lands (default: same campaign). For an ad copy: required with `targetAdSetId`.

• targetAdSetIdstringoptional

  Ad copies only: the destination ad set (default: same ad set).

• platformstringoptional

  Default facebook.

  Values: facebook, instagram

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• draftIdstringoptional

  A new campaign draft (from a prepare / copy result).

• campaignIdstringoptional

  A live Meta platformCampaignId (its studio canvas).

• founderMessagestringoptional

  The founder's words for THIS change, verbatim ("add facebook engagers"). Needed when the change adds an audience: a separate ad set, the existing one as a starting signal, or the existing one shown to them only is THEIR call. After you asked, their words + a new line + one line per answer ('<question> <chosen option>'). Never paraphrase, never add what you inferred.

• campaignobjectoptional

  Campaign-level changes; only the fields passed change.

• adSetsarrayoptional
• adsarrayoptional

  Ad-level changes: copy, CTA, link, media (creativeId / imageUrl / videoUrl).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• adIdstringrequired

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• adAccountIdstringoptional
• namestringrequired

  Campaign name (max 255).

• goalstringrequired

  The ad-set optimization goal — pick the one that matches what the business actually wants, NOT 'traffic' by default. To drive SALES/PURCHASES (most ecommerce + paid offers) use 'conversions'. To collect LEADS (forms, sign-ups, quote requests) use 'lead_generation'. Only use 'traffic' when the user explicitly just wants clicks/visits — it optimizes for cheap clicks, not buyers, so it usually wastes spend for a sales business. 'engagement'/'awareness'/'video_views' are top-of-funnel only.

  Values: engagement, traffic, awareness, video_views, lead_generation, conversions, app_promotion

• budgetAmountnumberrequired

  Daily budget for the whole ad set, Vibiz fee included unless budgetBasis is "net". $10/day minimum.

• budgetBasisstringoptional

  Default "gross": the budget is the total the founder pays and the Vibiz fee (20%, less at higher budgets) comes out of it, so Meta gets the rest. "net": Meta gets the full budget and the fee is added on top.

  Values: gross, net

• budgetTypestringoptional

  Only 'daily' can be staged in the studio.

  Values: daily, lifetime

• currencystringoptional
• creativesarrayrequired
• countriesarrayoptional

  REQUIRED for good delivery — ISO-3166 alpha-2 country codes (e.g. ['ES'], ['MX'], ['US'], ['GB']). Do NOT leave empty: Meta defaults to the United States, which burns budget when the ad/business isn't US-facing. Unless the user already told you where to run the ads, ASK before launching — recommend countries from the ICP's geography and the business's market, and offer worldwide as an option; don't silently infer. Match the creative's language and the customer's location — Spanish copy for a Spain business → ['ES'], Spanish for Mexico → ['MX'], English US business → ['US']; never default to ['US'] unless the audience really is the US.

• ageMinintegeroptional
• ageMaxintegeroptional
• interestsarrayoptional

  Optional interest targeting. Each `{id,name}` MUST come from `vibiz_meta_ads_targeting_search` (ads toolset) in this session. Never invent or reuse a remembered id — Meta rejects stale ids (subcode 1487079) and the launch fails. Omit the array to launch broad / Advantage+ without interests.

• audienceIdstringoptional
• advantageAudienceintegeroptional
• budgetLevelstringoptional

  Values: campaign, adset

• specialAdCategoriesarrayoptional
• pixelIdstringoptional
• conversionEventstringoptional
• urlTagsstringoptional

  The ads' Meta URL parameters as a query string, e.g. 'utm_source=fb&utm_campaign=spring'. Your keys are kept; Vibiz only adds the UTMs you leave out and its own creative id. UTMs already on linkUrl count as yours.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• messagestringoptional

  The founder's message, verbatim.

• intentstringoptional

  Values: prospecting, retargeting

• goalstringoptional
• conversionEventstringoptional
• countriesarrayoptional

  ISO country codes, e.g. ["US", "CA"].

• dailyBudgetnumberoptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• adIdstringrequired

  Vibiz `campaign_ad` UUID.

• campaignIdstringrequired

  Meta platformCampaignId.

• adSetIdstringrequired

  Meta platformAdSetId.

• namestringoptional
• linkUrlstringoptional
• callToActionstringoptional

  Meta only.

  Values: LEARN_MORE, SHOP_NOW, SIGN_UP, BOOK_TRAVEL, CONTACT_US, DOWNLOAD, GET_OFFER, GET_QUOTE, SUBSCRIBE, WATCH_MORE

• headlinestringoptional
• bodystringoptional
• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• platformstringoptional

  Default facebook.

  Values: facebook, instagram

• limitintegeroptional

  How many to return (default 6).

• fromDatestringoptional

  ISO date (optional). Default: 90 days ago.

• toDatestringoptional

  ISO date (optional).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• adAccountIdstringoptional

  Meta ad account id ("act_…"). Omit for the vibiz's selected ad account.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• pageIdstringrequired

  Facebook Page id from `vibiz_meta_ads_pages_list[].availablePages (ads toolset)[].id`.

• adAccountIdstringoptional

  Meta ad account id ("act_…"). Omit for the vibiz's selected ad account.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• socialAccountIdstringrequired

  EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or vibiz_ads_accounts (action "list", platform "meta") ancestor.

• pixelIdstringrequired

  EXPECTS: Zernio tracking-tag id (returned as `tag.id` from `vibiz_meta_ads_pixels_create`, or `data[].id` from `vibiz_meta_ads_pixels_list`).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• socialAccountIdstringrequired

  EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or vibiz_ads_accounts (action "list", platform "meta") ancestor.

• pixelIdstringrequired

  EXPECTS: Zernio tracking-tag id (returned as `tag.id` from `vibiz_meta_ads_pixels_create`, or `data[].id` from `vibiz_meta_ads_pixels_list`).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• socialAccountIdstringrequired

  EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or vibiz_ads_accounts (action "list", platform "meta") ancestor.

• pixelIdstringrequired

  EXPECTS: Zernio tracking-tag id (returned as `tag.id` from `vibiz_meta_ads_pixels_create`, or `data[].id` from `vibiz_meta_ads_pixels_list`).

• adAccountIdstringrequired

  EXPECTS: Meta platform ad account id (string starting with "act_"). Get it from vibiz_ads_accounts (action "list", platform "meta"), field id. This is the RECIPIENT ad account that should gain access — NOT the ad account the pixel was originally created on.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• socialAccountIdstringrequired

  EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or vibiz_ads_accounts (action "list", platform "meta") ancestor.

• pixelIdstringrequired

  EXPECTS: Zernio tracking-tag id (returned as `tag.id` from `vibiz_meta_ads_pixels_create`, or `data[].id` from `vibiz_meta_ads_pixels_list`).

• adAccountIdstringrequired

  EXPECTS: Meta platform ad account id (string starting with "act_"). Get it from vibiz_ads_accounts (action "list", platform "meta"), field id.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• socialAccountIdstringrequired

  EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or vibiz_ads_accounts (action "list", platform "meta") ancestor.

• pixelIdstringrequired

  EXPECTS: Zernio tracking-tag id (returned as `tag.id` from `vibiz_meta_ads_pixels_create`, or `data[].id` from `vibiz_meta_ads_pixels_list`).

• namestringoptional
• enableAutomaticMatchingbooleanoptional
• firstPartyCookieStatusstringoptional
• dataUseSettingstringoptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• namestringrequired

  Campaign name as shown in Ads Manager, e.g. "{Business} Leads Campaign {date} - Vibiz".

• adAccountIdstringoptional

  Meta ad account id ('act_…'); omit for the workspace's selected account.

• goalstringrequired

  What the founder wants from the campaign, never assumed. Without one, ask the founder in their words ("What do you want from this campaign?"). lead_conversion = Leads (Collect contacts from people interested in your offer; optimizes on Lead by default, or Complete registration / Contact / Schedule / Submit application / Subscribe / Start trial); conversions = Sales (Find people likely to buy your product or service; optimizes on Purchase by default, or Initiated checkout / Add to cart / Add payment info / Subscribe / Start trial / Complete registration); signup = Sign-ups (Get people to register or create an account on your site; optimizes on Complete registration by default, or Subscribe / Start trial); traffic = Traffic (Send as many people as possible to your page); awareness = Awareness (Reach a broad audience and get your brand known). lead_generation = a Meta Instant Form whose leads never reach the site or CRM — only when the founder explicitly asks for a form.

  Values: lead_conversion, conversions, signup, traffic, awareness, engagement, video_views, lead_generation

• conversionEventstringoptional

  The pixel event the ad sets optimize on — the default for every ad set (a set may name its own with adSets[].conversionEvent); omit for the goal's default. It must fit the goal (Leads: LEAD, COMPLETE_REGISTRATION, CONTACT, SCHEDULE, SUBMIT_APPLICATION, SUBSCRIBE, START_TRIAL; Sales: PURCHASE, INITIATED_CHECKOUT, ADD_TO_CART, ADD_PAYMENT_INFO, SUBSCRIBE, START_TRIAL, COMPLETE_REGISTRATION; Sign-ups: COMPLETE_REGISTRATION, SUBSCRIBE, START_TRIAL) — a mismatch is refused. Only an event the pixel has actually seen can train: check ads_pixel_events.

  Values: LEAD, COMPLETE_REGISTRATION, CONTACT, SCHEDULE, SUBMIT_APPLICATION, SUBSCRIBE, START_TRIAL, PURCHASE, INITIATED_CHECKOUT, ADD_TO_CART, ADD_PAYMENT_INFO

• pixelIdstringoptional

  Meta pixel id from the pixels list; the account may hold several.

• specialAdCategoriesarrayoptional

  REQUIRED for loans / credit / insurance / investing / banking (FINANCIAL_PRODUCTS_SERVICES), jobs (EMPLOYMENT), homes (HOUSING). Meta then forces 18-65+ and all genders.

• budgetLevelstringoptional

  'campaign' (default, CBO): one dailyBudget on the campaign. 'adset' (ABO): a dailyBudget on every ad set.

  Values: campaign, adset

• dailyBudgetnumberoptional

  Campaign daily budget (CBO), stated in `currency`. Minimum 10 — below that an ad set never leaves learning.

• currencystringoptional

  ISO code the budgets are STATED in (default USD). The draft is stored in the ad account's currency — converted once at staging with the launch's rates — so the result's dailyBudget/currency are what the studio shows and what Meta runs.

• landingPageUrlstringoptional

  Default destination for ads that name no linkUrl. Resolve the live site first; never assume {slug}.vibiz.app.

• funnelIdstringoptional

  A Vibiz funnel (its id) as the destination — the launch installs the pixel on it and stamps attribution, like the wizard's site pick.

• dsaBeneficiarystringoptional

  Meta DSA (EU): the legal entity that benefits. Needed with dsaPayor when any EU/EEA country (or worldwide) is targeted. Leave both out when the ad account has a default advertiser — the draft fills them from it; ask the founder only when it has none. Never invent one.

• dsaPayorstringoptional

  Meta DSA (EU): the legal entity that pays. Usually the same as dsaBeneficiary.

• retargetKnownbooleanoptional

  'Everyone who already knows us': attach every READY Vibiz audience (site visitors, leads, Page + Instagram engagers) at Launch to each ad set that names no includeAudienceIds.

• adSetsarrayrequired

  The campaign's ad sets — one broad set is the default; add a retargeting set (includeAudienceIds) or an interest set when audiences differ.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• draftIdstringoptional

  A new campaign draft (from a prepare / copy result).

• campaignIdstringoptional

  A live Meta platformCampaignId (its studio canvas).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• founderMessagestringoptional

  The founder's words for THIS change, verbatim ("add facebook engagers"). Needed when the change adds an audience: a separate ad set, the existing one as a starting signal, or the existing one shown to them only is THEIR call. After you asked, their words + a new line + one line per answer ('<question> <chosen option>'). Never paraphrase, never add what you inferred.

• campaignIdstringrequired

  The live campaign (platformCampaignId) the changes are staged on.

• addAdsarrayoptional

  Ads to add to existing ad sets.

• addAdSetsarrayoptional

  New ad sets, each with its own audience and ads.

• copyAdSetIdsarrayoptional

  Live ad sets to copy with their ads.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• socialAccountIdstringrequired

  EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id`. NOT a Meta `act_…` id.

• qstringrequired

  Search text, e.g. "private school" or "São Paulo". At least 2 characters.

• dimensionstringoptional

  Default 'interest'. Use 'geo' to look up region/city keys (pair with geoType + countryCode).

  Values: interest, geo, behavior, income

• geoTypestringoptional

  Only when dimension=geo. Default 'all' searches every geo type at once.

  Values: country, region, city, zip, metro, all

• countryCodestringoptional

  ISO-3166 alpha-2 that scopes a geo search, e.g. "BR". Ignored for interest search.

• limitintegeroptional

  Max rows to return (default 15).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• adIdstringrequired
• headlinestringoptional
• bodystringoptional

  Primary text.

• callToActionstringoptional

  Values: LEARN_MORE, SHOP_NOW, SIGN_UP, BOOK_TRAVEL, CONTACT_US, DOWNLOAD, GET_OFFER, GET_QUOTE, SUBSCRIBE, WATCH_MORE

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• proposalIdstringrequired

  The card id from vibiz_list_proposals (autonomy toolset).

• statusstringoptional

  Values: pending, approved, rejected, discussing, executed, dismissed

• rejectReasonstringoptional

  Why the founder rejected it; required with `rejected`.

• titlestringoptional
• descriptionstringoptional
• reasonstringoptional
• impactstringoptional
• approveLabelstringoptional
• planDayintegeroptional

  Rolling 3-day plan: 1 = today, 2 = tomorrow, 3 = day after. Omit for a one-off proposal.

• toolsarrayoptional

  Every write tool or subagent running the card will use; [] for read-only work. The platform computes `critical` from this list.

• ownerstringoptional

  Who runs the card: ads-operator for ad changes, cto for site work, researcher, video, or ceo.

  Values: ceo, ads-operator, cto, researcher, video

• planstringoptional

  Agent-only, never shown to the founder: the full markdown plan the run executes and is graded against (scope, acceptance criteria, links, risks).

• areastringoptional

  The card's domain.

  Values: ads, site, social, leads, offers, content, research, other

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• platformstringoptional

  Platform to analyze. Omit for all platforms.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• platformstringoptional

  Filter to one platform. Omit for cross-platform aggregate.

• fromDatestringoptional

  Start date (YYYY-MM-DD). Default: 30 days ago.

• toDatestringoptional

  End date (YYYY-MM-DD). Default: today.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• platformstringoptional

  Filter by platform (facebook, instagram, linkedin, tiktok, etc.). Omit for all.

• sortBystringoptional

  Metric to sort by. Default: engagement.

  Values: engagement, impressions, reach, likes, comments, shares, date

• fromDatestringoptional

  Start date (YYYY-MM-DD). Default: 90 days ago.

• toDatestringoptional

  End date (YYYY-MM-DD). Default: today.

• limitnumberoptional

  Max posts to return (1-100, default 10).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• draftsarrayrequired

  One entry per post to draft.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• platformstringoptional

  Optional platform the user wants to connect (e.g. "x", "instagram"). Shown as a label; the connector page handles all platforms.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• recipientNamestringoptional
• recipientCompanystringoptional
• recipientRolestringoptional
• recipientIndustrystringoptional
• signalsstringoptional

  Buying/context signals to personalize on.

• senderProductstringoptional

  What this workspace offers — used to frame the pitch.

• channelstringoptional

  Default email.

  Values: email, linkedin

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• cursorstringoptional

  `nextCursor` from the previous page.

• unreadOnlybooleanoptional
• searchstringoptional
• mailboxIdstringoptional

  Only this mailbox (from vibiz_email_status (comms toolset)).

• limitintegeroptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• threadIdstringrequired

  From vibiz_email_list_threads (comms toolset).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• threadIdstringrequired

  From vibiz_email_list_threads (comms toolset).

• bodystringrequired

  The reply, plain text.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• tostringrequired
• subjectstringrequired
• bodystringrequired

  The email, plain text.

• mailboxIdstringoptional

  Which mailbox sends it (from vibiz_email_status (comms toolset)); omit for the first one that can send.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• mailboxIdstringrequired

  From vibiz_email_status (comms toolset).

• senderNamestringrequired

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• platformstringoptional

  Filter by platform.

• sortBystringoptional

  Sort by date or comment count.

  Values: date, comments

• limitnumberoptional

  Max posts to return (1-50, default 10).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• platformstringoptional

  Filter by platform (instagram, facebook, twitter, etc.).

• limitnumberoptional

  Max conversations to return (1-50, default 10).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• accountIdstringrequired

  Instagram/Facebook account to run the automation on. Must belong to the target vibiz.

• namestringrequired

  A label for the automation.

• dmMessagestringrequired

  The DM auto-sent to each commenter.

• commentReplystringoptional

  Optional public reply posted on the comment itself.

• keywordsarrayoptional

  Trigger keywords. OMIT or empty = fires on ANY comment (reply to all).

• matchModestringoptional

  How keywords match. Default "contains".

  Values: exact, contains

• platformPostIdstringoptional

  Scope to one post (platform media id, from `vibiz_inbox_comments` (comms toolset)). Omit for account-wide.

• triggerstringoptional

  Default "comment". "story_reply" fires on IG story replies.

  Values: comment, story_reply

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• automationIdstringrequired

  The automation to delete. From `vibiz_inbox_list_comment_automations` (comms toolset).

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• postIdstringrequired

  The post to read comments from. From `vibiz_inbox_comments` (comms toolset).

• accountIdstringrequired

  The account that owns the post (from `vibiz_inbox_comments` (comms toolset)). Must belong to the target vibiz.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• conversationIdstringrequired

  The conversation to read. From `vibiz_inbox_conversations` (comms toolset).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• postIdstringrequired

  The post containing the comment.

• commentIdstringrequired

  The comment to reply to.

• accountIdstringrequired

  The social account to reply from. Must belong to the target vibiz.

• messagestringrequired

  Reply message text.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• postIdstringrequired

  The post whose comments to reply to. From `vibiz_inbox_comments` (comms toolset).

• accountIdstringrequired

  The account to reply from. Must belong to the target vibiz.

• repliesarrayrequired

  One entry per comment (max 50). Each message should be unique + contextual.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• postIdstringrequired

  The post containing the comment. From `vibiz_inbox_comments` (comms toolset).

• commentIdstringrequired

  The comment whose author to DM. From `vibiz_inbox_get_comments` (comms toolset).

• accountIdstringrequired

  The account to send from. Must belong to the target vibiz.

• messagestringrequired

  The private DM text.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• conversationIdstringrequired

  The conversation to send in.

• accountIdstringrequired

  The social account to send from. Must belong to the target vibiz.

• messagestringrequired

  Message text.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• automationIdstringrequired

  The automation to toggle. From `vibiz_inbox_list_comment_automations` (comms toolset).

• activebooleanrequired

  true = launch/resume, false = stop/pause.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• channelIdstringoptional

  Slack channel id, e.g. C0ATX….

• limitintegeroptional

  Max messages per channel.

• daysintegeroptional

  Look-back window in days.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• querystringoptional

  Case-insensitive filter on the channel name.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• channelIdstringrequired

  Slack channel id.

• textstringrequired
• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• memberIdstringrequired

  From `teammates` in vibiz_slack_list_channels (comms toolset).

• textstringrequired
• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• channelIdstringrequired

  Slack channel id.

• tsstringrequired

  The thread root's ts, e.g. 1760000000.123456.

• limitintegeroptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• offerIdstringrequired
• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• imageUrlsarrayoptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• refreshbooleanoptional
• pageUrlsarrayoptional

  Specific pages to read. Implies a refresh.

• confirmobjectoptional
• dismissobjectoptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• titlestringrequired
• markdownstringrequired

  The body as markdown (headings, lists, tables).

• documentIdstringoptional

  Edit this existing document instead of creating one.

Parameters

• brandobjectrequired

  Structured brand payload synthesized from the local repo. Required: `companyName`. Other fields populate WorkspaceBranding.

• workspaceNamestringoptional

  Optional explicit workspace name. If omitted, derived from `brand.companyName`.

Parameters

• websiteUrlstringrequired

  A website URL (https://example.com) or Instagram profile URL (instagram.com/handle). The URL is validated by fetching the site (or scraping the IG profile); unreachable URLs fail.

• workspaceNamestringoptional

  Optional explicit name. If omitted, derived from the URL/scraped content.

• allowDuplicatebooleanoptional

  Create a second vibiz even when this workspace group already has one for the same site. Only when the user explicitly asks.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• namestringrequired
• titlestringoptional
• descriptionstringoptional
• demographicsobjectoptional
• painPointsarrayoptional
• goalsarrayoptional
• channelsarrayoptional
• landingSlugstringoptional

  Optional slug seed for the ICP landing page.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• titlestringrequired
• descriptionstringoptional
• priceCentsintegeroptional

  Stripe amount in the currency minor unit (2900 = $29 USD, 500 = ¥500 JPY). Set 0 or omit for non-payable offers.

• priceCurrencystringoptional
• iconEmojistringoptional
• imageUrlstringoptional

  Public image URL for the offer thumbnail.

• sourcestringoptional

  Origin tag. Default 'agent_chat'. Pass 'manual' when the user is adding a product to their catalog directly.

• scrapeUrlstringoptional

  Source PDP URL when the row was scraped from a product page. Stored in sourceData for traceability.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• offerIdstringrequired
• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• namestringrequired

  Short persona name (e.g. "SaaS Founder", "Busy Parent", "Gen-Z Gamer"). Required.

• titlestringoptional

  Optional job title / role label that appears under the name (e.g. "Marketing Manager at a 50-person B2B SaaS").

• descriptionstringoptional

  Optional one-paragraph summary of who they are, what motivates them, and how the brand fits into their life.

• demographicsobjectoptional

  Optional demographic block. All fields free-form strings.

• painPointsarrayoptional

  Optional list of pain points / frustrations.

• goalsarrayoptional

  Optional list of goals / desired outcomes.

• channelsarrayoptional

  Optional list of channels where this persona spends time (e.g. "TikTok", "LinkedIn", "Reddit r/SaaS").

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• titlestringrequired

  Short, punchy offer name (max ~100 chars). E.g. "50% off everything", "Free 14-day trial", "$99 starter package".

• descriptionstringoptional

  Optional details about the offer — terms, what is included, value prop. Max ~500 chars.

• priceCentsintegeroptional

  Stripe amount in the currency minor unit (9900 = $99.00 USD, 500 = ¥500 JPY). Omit for free offers / lead magnets.

• priceCurrencystringoptional

  ISO currency code. Default "USD".

• typestringoptional

  Business model type. Default "generic" if unsure.

  Values: software, service, ecommerce, agency, generic

• iconEmojistringoptional

  Single emoji that represents the offer visually. E.g. "🎁", "💰", "🚀".

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• icpIdstringrequired

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• querystringoptional

  What to look up in the uploaded documents, e.g. "refund policy" or "enterprise pricing". Omit to just get the summary + document list.

• limitnumberoptional

  Max passages to return (1..25, default 8).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• offerIdstringrequired
• icpIdstringrequired

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• categorystringoptional

  Values: product, lifestyle, team, screenshot, abstract

• limitintegeroptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• limitintegeroptional

  Max pages to return (default 20).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• offerIdstringoptional

  Only this offer (optional).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• displaybooleanoptional

  Set true when the user should see the inline Products gallery in chat.

• purposestringoptional

  When display=true, catalog = browse products; product_picker = choose one before generation.

  Values: catalog, product_picker

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• keystringrequired

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• keystringrequired
• valuestringrequired

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• hasProductGroundingbooleanoptional

  Set true only when the next generation already has a concrete offer/product/reference image. This lets ecommerce product-catalog readiness become informational instead of blocking.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• namestringrequired
• bodyMdstringrequired
• kindstringoptional

  Values: workflow, goal, lesson

• triggerstringoptional

  Workflow only: when it applies, in prose.

• statusstringoptional

  Values: proposed, active, archived

Parameters

• tzstringoptional

  IANA timezone (e.g. "Asia/Kolkata", "Europe/Rome", "America/New_York"). Defaults to UTC.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• offerIdstringrequired
• icpIdstringrequired

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• companyNamestringoptional
• headlinestringoptional
• websiteUrlstringoptional
• logoUrlstringoptional
• logoConversationImageIdstringoptional

  When the user uploaded a logo in chat, pass the conversation id shown as image-N. Never copy attachment URLs into logoUrl.

• colorsobjectoptional
• fontsobjectoptional
• tonestringoptional
• energystringoptional
• targetAudiencestringoptional
• languagestringoptional
• formalitystringoptional

  Values: formal, informal, neutral

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• icpIdstringrequired
• namestringoptional
• titlestringnulloptional
• descriptionstringnulloptional
• demographicsobjectnulloptional
• painPointsarraynulloptional
• goalsarraynulloptional
• channelsarraynulloptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• sectionstringoptional

  Heading of the one section to replace. Omit to replace the whole summary.

• contentstringrequired

  The full revised summary, or the new body of `section` when one is given.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• offerIdstringrequired
• titlestringoptional
• descriptionstringoptional
• priceCentsintegeroptional

  Stripe amount in the currency minor unit (2900 = $29 USD, 500 = ¥500 JPY).

• priceCurrencystringoptional
• iconEmojistringoptional
• statusstringoptional

  Values: draft, published, active

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• docstringrequired

  Values: company, member

• memberIdstringoptional

  Required when doc is 'member'.

• contentstringrequired

  Full revised markdown for the chosen document.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• competitorsarrayoptional

  Brand names or domains the user named. Omit to use the saved competitors (free).

• maxCompetitorsintegeroptional

  How many competitors. Default 5; more only when the user asks.

• adsPerCompetitorintegeroptional
• countrystringoptional

  ISO country for a named search. Default: the workspace's market.

• includeImagesbooleanoptional

  Attach the ad images as image content so you can see them. Default true.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• refreshbooleanoptional

  Force a fresh search instead of returning the saved list. Costs credits. Default false.

• countriesarrayoptional

  ISO country codes for the ad-library probe, e.g. ["US","GB"]. Only used on a fresh run. Default ["US"].

• hintstringoptional

  Optional positioning hint to bias the search, e.g. "focus on AI ad-creative tools". Only used on a fresh run.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• qstringoptional

  Free text matched against the description, spoken words, on-screen text, archetype, delivery and tags, e.g. "problem callout" or "skincare".

• aspectstringoptional

  Values: 9:16, 1:1, 16:9

• limitintegeroptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• querystringoptional
• emotionstringoptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• qstringoptional
• limitintegeroptional

Parameters

• symbolstringrequired

  Ticker or coin symbol (BTC, ETH, AAPL, TSLA, ...)

• kindstringoptional

  Asset kind. Defaults to "auto" (try crypto then stock).

  Values: auto, crypto, stock

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• urlstringrequired

  The public TikTok, Instagram, Facebook, or X post URL to read (e.g. https://www.tiktok.com/@user/video/123). Facebook takes post, photo, reel/video and share links (facebook.com/share/…, fb.watch/…), not a page link.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• querystringoptional

  Niche / keyword to search the Meta Ad Library for. Examples: 'cereal', 'pet insurance', 'protein bars', 'saas onboarding'. Required for discover; optional for scrape when `pageId` is set.

• countrystringoptional

  ISO country code, e.g. 'US', 'GB', 'DE', 'IT'.

• modestringoptional

  'discover' returns unique advertisers (cheap, ~$4). 'scrape' returns full ad rows (expensive, ~$7+ depending on limit).

  Values: discover, scrape

• sampleSizeintegeroptional

  Ads to sample in discover mode. More = more unique advertisers surfaced but linearly more expensive. Ignored in scrape mode.

• pageIdstringoptional

  Facebook page id from a prior `discover` response. Scrape mode only — when set, the scrape is filtered to this one advertiser's ads (better per-dollar than a keyword scrape).

• limitintegeroptional

  Max ads to return in scrape mode. Cost is linear: limit * ~$0.14. Ignored in discover mode.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• querystringrequired
• limitintegeroptional
• orientationstringoptional

  Values: landscape, portrait, squarish

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• queriesarrayrequired
• limitintegeroptional
• tonestringoptional

  Values: light, dark

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• nichestringrequired

  The topic/niche/keyword to research trends for (e.g. "skincare for men", "AI productivity tools").

• platformsarrayoptional

  Which platforms to scan. Default TikTok + Instagram.

• modestringoptional

  discover = cheap sample; deep = larger, more expensive pull.

  Values: discover, deep

• confirmbooleanoptional

  Required to run a `deep` pull — acknowledges the scraping cost. Without it, a deep request returns a cost preflight instead of spending. Ignored for `discover`.

• daysintegeroptional

  Recency window in days. Defaults to 14 (~2 weeks, recommended). Widen (e.g. 30) for slower niches, or narrow (e.g. 3) for what is hot right now.

Parameters

• urlstringrequired

  URL to fetch (with or without https://)

• includeScreenshotbooleanoptional

  Whether to capture a viewport screenshot. Defaults to true.

Parameters

• querystringrequired

  Search query

• sourcesarrayoptional

  Which sources to search. Defaults to ["web", "news"]. Use ["web"] only for non-news lookups to keep the response tight.

• limitnumberoptional

  Max results to return (1-10). Defaults to 5.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• contact_job_titlearrayoptional

  Target job titles, e.g. ["CEO", "CMO"].

• contact_not_job_titlearrayoptional

  Job titles to exclude.

• seniority_levelarrayoptional

  Seniority levels, e.g. ["c_suite", "vp", "director"].

• contact_locationarrayoptional

  Country / region targets, e.g. ["United States"].

• company_industryarrayoptional

  Industries (LinkedIn taxonomy). For SaaS, pass ["computer software", "internet", "information technology & services"] — the literal "saas" is documented but rejected by the actor.

• company_keywordsarrayoptional

  Keywords describing the company.

• company_domainarrayoptional

  Specific company domains to target.

• sizearrayoptional

  Employee size buckets, e.g. ["11-50", "51-200"].

• min_revenuestringoptional
• max_revenuestringoptional
• fundingarrayoptional
• email_statusarrayoptional

  Defaults to ["validated"].

• fetch_countnumberoptional

  Number of leads to fetch (10..10000). Smaller runs pay an outsized fixed cost; prefer >=50.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• emailstringrequired

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• leadIdstringrequired

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• limitintegeroptional

  People read before grouping (default 500).

• topNintegeroptional

  Rows per breakdown (default 12).

• sampleintegeroptional

  Individual people returned (default 25; 0 for counts only).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• limitnumberoptional

  Max leads to show (1..50, default 24).

• displaybooleanoptional

  Set true when the user should see the inline leads board in chat.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• scopestringoptional

  upcoming = soonest first (default); past = most recent first.

  Values: upcoming, past

• limitintegeroptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• meetingIdstringrequired

  The meeting id from vibiz_list_meetings (crm toolset).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• daysintegeroptional

  Window in days (default 30).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• leadIdstringrequired
• statusstringrequired

  Values: new, qualified, contacted, replied, disqualified

• reasonstringrequired

  Why this status: concrete evidence, shown on the CRM timeline.

• notesstringoptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• promptstringrequired

  Describe the landing page: what it sells, the hero message, the primary CTA, target audience, tone. The generator writes its own copy — you just describe the goal. Max 500 chars stored.

• qualificationbooleanoptional

  Optional. Set true to build a lead-qualification funnel (multi-step questionnaire + paywall/gating) instead of a single landing page. Default: false.

• creativeIdstringoptional

  Optional campaign_ad id to use as the hero image/reference for the page.

• creativeImageUrlstringoptional

  Optional image URL to embed as the hero visual (alternative to creativeId).

• allowPartialBrandbooleanoptional

  Draft override. Default false. Set true only when the user explicitly asks to generate before onboarding/branding/product setup is ready; the result may be off-brand.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• funnelIdstringrequired

  Id of the existing funnel to rewrite. Fetch from the user's workspace (recent funnel) or ask them to build one first via `vibiz_generate_funnel` (sites toolset).

• promptstringrequired

  Describe the qualification/gating flow: what fields to collect, what the paywall gates, what questions to ask, where the CTA leads. The generator writes its own HTML — describe the goal.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• intentstringrequired

  What the page is for, e.g. "Landing page for the 12-week coaching programme".

• labelstringoptional

  Two or three words naming the page.

• headlinestringoptional
• subheadlinestringoptional
• ctaLabelstringoptional

  The exact button text, e.g. "Book a call".

• navLinksarrayrequired

  Two to four navigation words, each naming a section of THIS page.

• herostringrequired

  The first screen around the headline: where the text sits and what fills the rest.

• sectionsarrayrequired

  Every section after the hero, top to bottom, ending with the closing call-to-action band. The footer is added for you.

• icpIdstringoptional
• offerIdstringoptional
• requestKeystringoptional

  Optional idempotency key: a retried call with the same key reuses the render instead of drawing another.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• sitestringoptional

  Values: source, workspace

• devicesarrayoptional

  Viewports to return (default desktop and mobile).

• pageUrlstringoptional

  A specific page of the site (e.g. the about page). Default: the chosen site.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• includeInFlightbooleanoptional
• includeFailedbooleanoptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• funnelIdstringrequired

  The funnel id from vibiz_list_landing_pages (sites toolset).

• pathstringoptional

  Public path on the org domain. `/` = homepage.

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• funnelIdstringrequired

  The funnel to review, from vibiz_list_landing_pages (sites toolset).

• intentstringoptional

  What the page was supposed to do, so the judge grades against the goal. Falls back to the funnel's own prompt.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• daysintegeroptional

  Window in days (default 7), compared against the previous window of the same length.

• pageLimitintegeroptional

  How many paths to list with views and visitors (default 8). Raise it to find one specific page.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• namestringrequired

  Short label, e.g. 'Morning check-in'.

• briefTemplatestringrequired

  What the agent does on each wake: imperative instructions only, no schedule wording.

• assignedTostringoptional

  Agent id from the org chart that runs it, e.g. 'cto'. Defaults to 'ceo'.

• presetstringoptional

  Cadence preset. Defaults to daily.

  Values: hourly, daily, weekly, every_6h

• intervalSecondsintegeroptional

  Custom interval in seconds. Use preset OR this.

• firstRunLocalTimestringoptional

  24h local time of the first run, e.g. '10:00'.

• timezonestringoptional

  IANA zone override; defaults to the workspace's zone. Set only when the founder names one.

• enabledbooleanoptional

  Defaults to true.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• routineIdstringrequired

  The routine id from vibiz_list_routines (autonomy toolset).

• approval_tokenstringoptional

  Only from vibiz_review_action, after the call answered approval_required. Never invent, reuse or edit one.

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• taskIdstringrequired

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• statusarrayoptional

  Only cards in these statuses (optional).

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• assignedTostringoptional

  Only this agent's tasks, e.g. 'cto'.

• statusarrayoptional

  Only tasks in these statuses.

• parentTaskIdstringnulloptional

  A task id for its sub-tasks, or null for top-level tasks only.

• planDayintegeroptional

  Only tasks tagged with this plan day.

• limitintegeroptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• subjectstringrequired

  What is being tested, e.g. 'welcome email subject lines'.

• axisstringrequired

  Values: creative, icp, email, offer

• variantsarrayrequired
• panelSizeintegeroptional

  Personas to interview. Omit to scale with the simulated budget.

• icpIdsarrayoptional

  Restrict the panel to these ICPs (from vibiz_list_icps (workspace toolset)).

• budgetnumberoptional

  Simulated DAILY ad budget in whole dollars.

• daysintegeroptional

  Days the simulated campaign runs (default 7).

• platformstringoptional

  Where the traffic comes from; shifts persona behaviour and the CPM.

  Values: tiktok, meta, linkedin, email, other

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• rationalestringrequired

  Why you are making this change.

• statusUpdatesarrayoptional
• objectiveEditsarrayoptional

Parameters

• targetobjectoptional

  Which brand to act on: {"vibiz":"<slug from list_vibiz>"}. Omit when the connector is pinned to one brand. Never fall back to another brand; an unlisted one needs vibiz_onboard_brand.

• organizationIdstringoptional

  Clerk organization id (optional if auth is org-scoped)

• routineIdstringrequired

  The routine id from vibiz_list_routines (autonomy toolset).

• enabledbooleanoptional

  false pauses the routine, true resumes it.

• namestringoptional
• briefTemplatestringoptional

  What the agent does on each wake: imperative instructions only, no schedule wording.

• presetstringoptional

  Values: hourly, daily, weekly, every_6h

• intervalSecondsintegeroptional