Docs

Get started

  • Welcome
  • Quickstart

Connect a client

  • Claude
  • Claude Code
  • Cursor

Reference

  • Generation
  • Workspace
  • Analytics
  • Inbox
  • Social
  • Meta ads
Open Vibiz dashboardGitHub
  1. Docs
  2. Reference
  3. Tool reference

Reference

Tool reference

59 tools across 6 surfaces. Each entry shows the tool name, what it does, and its input parameters as exposed via tools/list.

Generation

10 tools

Create images, videos, funnels, and creative insights.

vibiz_generate_image

Generate a static ad IMAGE (no motion, no sound). COST: 1 credit per image — with `imageCount` variations (1-4), the cost is `imageCount` credits (e.g. 3 variations = 3 credits).

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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` 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`. 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` 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.

vibiz_generate_carousel

Generate a multi-slide marketing CAROUSEL (hook → story → CTA). Each slide is its own image; they ship as one cohesive set. COST: ~1 credit per slide.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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`. 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` 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.

vibiz_generate_product_shot

Generate one ecommerce Product Studio image from a real product reference and one of the 110 art-directed recipes.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • productIdstringoptional

    Optional product id from vibiz_list_offers.

  • 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

vibiz_generate_product_shot_bundle

Generate one Product Studio collection from the same exact product reference.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • productIdstringoptional

    Optional product id from vibiz_list_offers.

  • 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

vibiz_generate_ugc

Generate a UGC-style VIDEO (motion + sound). A single rendered clip, NOT a sequence of images.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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.

  • styleIdstringoptional

    Named Omni Flash style preset (see `vibiz_list_ugc_styles`). Sets the format + opening hook. 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

  • creatorGenderstringoptional

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

    Values: female, male

  • captionsbooleanoptional

    Burn captions onto the video via ZapCap. Default true.

  • captionStylestringoptional

    Caption look. Default "clean" (plain, readable subtitles). Only pick "tiktok"/"bold" (animated, colorful, emoji) if the user explicitly asks for that style.

    Values: tiktok, bold, clean, minimal

  • 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`. 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` 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.

  • personaIdstringoptional

    Optional persona id within the selected ICP. Use only when the user explicitly selects a persona.

  • lightingstringoptional

    Per-call lighting override for director-script intent. Default 'auto'.

    Values: auto, studio, natural, golden-hour, dramatic

  • moodstringoptional

    Per-call mood override for director-script intent.

    Values: auto, professional, playful, premium, minimal, warm

  • cameraAnglestringoptional

    Per-call camera angle override (observable on ad row).

    Values: auto, eye-level, low-angle, aerial, close-up

  • brandIntensitystringoptional

    Brand kit assertiveness (observable on ad row).

    Values: auto, subtle, standard, strong

  • logoModestringoptional

    Logo stamping intent (observable on ad row).

    Values: auto, on, off

  • compositionstringoptional

    Composition intent (observable on ad row).

    Values: auto, centered, rule-of-thirds, asymmetric, flat-lay

vibiz_generate_ad_video

Generate a polished marketing VIDEO AD directly with Omni Flash from a rich director script. Output lands in the creatives gallery as a video ad.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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`. 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` first and ASK if multiple plausible offers exist.

vibiz_generate_funnel

Generate a marketing funnel / landing page AND automatically deploy it as a live website on Vercel. End-to-end: writes the HTML/content, provisions the repo, deploys — one call.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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.

vibiz_generate_qualification_funnel

Rewrite an EXISTING landing page into a lead-qualification funnel (multi-step form / paywall / gating flow) and auto-deploy the new version.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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`.

  • 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.

vibiz_generate_icps

Create a single Ideal Customer Profile (ICP / persona) in a vibiz.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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").

vibiz_generate_offers

Create a single marketing OFFER (lead magnet, promotion, deal) in a vibiz.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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. "🎁", "💰", "🚀".

Workspace

3 tools

Read brand context and send branded transactional emails.

vibiz_workspace_generate_icps_pipeline

Bulk-discover Ideal Customer Profiles (ICPs / personas) from the workspace branding.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

vibiz_workspace_generate_offers_pipeline

Bulk-discover marketing offers from the workspace branding / website.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

vibiz_workspace_generate_knowledge_pipeline

Generate the workspace's business knowledge-base summary.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

Analytics

3 tools

Surface engagement, top-performing content, and reporting.

vibiz_analytics_top_posts

Pull the vibiz's social posts WITH their analytics — to review or analyze performance. Includes ORGANIC posts the user published directly on the platform (not just ones made in Vibiz); Zernio syncs all posts from the connected account.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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).

vibiz_analytics_daily_metrics

Get aggregated daily social media metrics with per-platform breakdown.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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.

vibiz_analytics_best_time

Find the best times to post on social media based on historical engagement data.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • platformstringoptional

    Platform to analyze. Omit for all platforms.

Inbox

12 tools

Read and reply to social-media inbox conversations.

vibiz_inbox_conversations

List recent DM conversations across the social accounts connected to a vibiz.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • platformstringoptional

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

  • limitnumberoptional

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

vibiz_inbox_read_conversation

Read the full message thread of a DM conversation (the back-and-forth), so you have context before replying.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • conversationIdstringrequired

    The conversation to read. From `vibiz_inbox_conversations`.

vibiz_inbox_comments

List posts that have received comments across the social accounts connected to a vibiz.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • platformstringoptional

    Filter by platform.

  • sortBystringoptional

    Sort by date or comment count.

    Values: date, comments

  • limitnumberoptional

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

vibiz_inbox_get_comments

GET the actual comments on a post — read each comment's text, author, and id.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • postIdstringrequired

    The post to read comments from. From `vibiz_inbox_comments`.

  • accountIdstringrequired

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

vibiz_inbox_reply_comment

Reply to a comment on a social media post in a vibiz.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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.

vibiz_inbox_reply_private

Send a PRIVATE DM to the AUTHOR of a comment (Instagram + Facebook only) — the ManyChat move: pair it with `vibiz_inbox_reply_comment` to also reply publicly.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • postIdstringrequired

    The post containing the comment. From `vibiz_inbox_comments`.

  • commentIdstringrequired

    The comment whose author to DM. From `vibiz_inbox_get_comments`.

  • accountIdstringrequired

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

  • messagestringrequired

    The private DM text.

vibiz_inbox_reply_comments_bulk

Reply to MANY comments on a post in ONE call — for "reply to all the comments on this post".

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • postIdstringrequired

    The post whose comments to reply to. From `vibiz_inbox_comments`.

  • 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.

vibiz_inbox_create_comment_automation

Set up a STANDING automation that auto-replies to comments — including FUTURE ones — on Instagram/Facebook. This is the real "reply to all comments on this post" (the bulk tool only hits comments that exist now; this fires on every new comment server-side).

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong 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`). Omit for account-wide.

  • triggerstringoptional

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

    Values: comment, story_reply

vibiz_inbox_list_comment_automations

List the standing comment-to-DM automations on a vibiz (with their stats).

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

vibiz_inbox_delete_comment_automation

Delete (turn off) a standing comment-to-DM automation. Get its id from `vibiz_inbox_list_comment_automations`.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • automationIdstringrequired

    The automation to delete. From `vibiz_inbox_list_comment_automations`.

vibiz_inbox_set_comment_automation_active

Launch (resume) or STOP (pause) a comment-to-DM automation, without deleting it. Get the id from `vibiz_inbox_list_comment_automations`.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • automationIdstringrequired

    The automation to toggle. From `vibiz_inbox_list_comment_automations`.

  • activebooleanrequired

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

vibiz_inbox_send_dm

Send a direct message in an existing conversation on a vibiz.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • conversationIdstringrequired

    The conversation to send in.

  • accountIdstringrequired

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

  • messagestringrequired

    Message text.

Social

4 tools

Schedule and publish posts across connected social accounts.

vibiz_social_trends

Research what content is CURRENTLY WORKING on TikTok, Instagram, and X for a niche — and get it back as reusable creative signal: hook patterns, angles/themes, and formats.

Parameters

  • targetobjectoptional

    Which vibiz to act on. Pass `vibiz` from list_vibiz when the MCP token is workspace-wide (plugin callers). Omit when the token is bound to a single vibiz — the auth-scoped vibiz is used implicitly.

  • 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.

vibiz_social_list_accounts

List connected social media accounts for a vibiz.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

vibiz_social_list_posts

List social media posts for a vibiz.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • statusstringoptional

    Filter by status.

    Values: draft, scheduled, published, failed

  • platformstringoptional

    Filter by platform.

  • limitnumberoptional

    Max posts (1-100, default 10).

vibiz_social_publish

Publish or schedule a social media post to one or more platforms.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • contentstringrequired

    Post text.

  • platformsarrayrequired

    Platforms + account IDs.

  • mediaUrlsarrayoptional

    Media URLs to attach.

  • scheduledForstringoptional

    ISO datetime to schedule. Omit for immediate.

  • hashtagsarrayoptional

    Hashtags.

Meta ads

27 tools

Read, launch, and manage Meta ad campaigns and creatives.

vibiz_meta_ads_campaigns_list

List Meta (Facebook + Instagram) ad campaigns connected to a vibiz.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • platformstringoptional

    Values: facebook, instagram

  • statusstringoptional

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

  • limitintegeroptional

    Max campaigns to return (default 20).

vibiz_meta_ads_campaigns_get_tree

Return the full Campaign → Ad Set → Ad hierarchy with rolled-up metrics at every level.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • platformstringoptional

    Values: facebook, instagram

  • statusstringoptional

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

  • fromDatestringoptional
  • toDatestringoptional
  • limitintegeroptional
vibiz_meta_ads_campaigns_set_status

Pause or resume a Meta ad campaign. Status transitions only — does NOT delete or duplicate.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • campaignIdstringrequired

    EXPECTS: Meta platform campaign id (16-18 digit numeric, e.g. "23859876543210000"). Get it from `vibiz_meta_ads_campaigns_list[].platformCampaignId`. NOT an internal Mongo ObjectId; NOT a Vibiz campaign UUID.

  • statusstringrequired

    Values: active, paused

  • platformstringrequired

    Values: facebook, instagram

vibiz_meta_ads_campaigns_bulk_set_status

Pause or resume up to 50 Meta campaigns in a single call. Per-campaign result; one bad row does not fail the batch.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • statusstringrequired

    Values: active, paused

  • campaignsarrayrequired
vibiz_meta_ads_campaigns_duplicate

Duplicate a Meta campaign (deep copy of all ad sets + ads). The copy starts PAUSED by default.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • campaignIdstringrequired

    EXPECTS: Meta platform campaign id (16-18 digit numeric). Get it from `vibiz_meta_ads_campaigns_list[].platformCampaignId`.

  • platformstringrequired

    Values: facebook, instagram

vibiz_meta_ads_campaigns_delete

Delete a Meta campaign — cascades to ad sets + ads on the platform; locally marks Ad rows as `cancelled` (preserves history).

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • campaignIdstringrequired

    EXPECTS: Meta platform campaign id (16-18 digit numeric). Get it from `vibiz_meta_ads_campaigns_list[].platformCampaignId`.

  • platformstringrequired

    Values: facebook, instagram

vibiz_meta_ads_creatives_list

List individual Meta ads (the leaf level — below campaigns and ad sets) with metrics.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • platformstringoptional

    Values: facebook, instagram

  • statusstringoptional

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

  • campaignIdstringoptional

    EXPECTS: Meta platform campaign id (16-18 digit numeric, e.g. "23859876543210000"). NOT an internal campaign id. Get it from `vibiz_meta_ads_campaigns_list[].platformCampaignId`.

  • fromDatestringoptional

    YYYY-MM-DD

  • toDatestringoptional

    YYYY-MM-DD

  • limitintegeroptional
vibiz_meta_ads_creatives_get

Get details of a single ad by its internal ad id.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • adIdstringrequired

    Internal ad id — a 24-char hex Mongo ObjectId (e.g. "65a3f0c1d2e4b8e9f4a1c2d3"). You get this from `vibiz_meta_ads_creatives_list[].id`. NOT the Meta platform numeric id, NOT a Vibiz campaign_ad UUID.

vibiz_meta_ads_creatives_get_analytics

Get analytics for a single ad — summary + daily time series + optional Meta breakdowns (age, gender, country, etc.).

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • adIdstringrequired

    Internal ad id — a 24-char hex Mongo ObjectId (e.g. "65a3f0c1d2e4b8e9f4a1c2d3"). You get this from `vibiz_meta_ads_creatives_list[].id`. NOT the Meta platform numeric id, NOT a Vibiz campaign_ad UUID.

  • fromDatestringoptional

    YYYY-MM-DD

  • toDatestringoptional

    YYYY-MM-DD

  • breakdownsarrayoptional

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

vibiz_meta_ads_creatives_set_status

Pause or resume a single Meta ad creative.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • adIdstringrequired

    Internal ad id — a 24-char hex Mongo ObjectId (e.g. "65a3f0c1d2e4b8e9f4a1c2d3"). You get this from `vibiz_meta_ads_creatives_list[].id`. NOT the Meta platform numeric id, NOT a Vibiz campaign_ad UUID.

  • statusstringrequired

    Values: active, paused

vibiz_meta_ads_creatives_delete

Cancel a single ad creative. Marks the platform ad as cancelled and updates the local row to `cancelled` (preserves history).

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • adIdstringrequired

    Internal ad id — a 24-char hex Mongo ObjectId (e.g. "65a3f0c1d2e4b8e9f4a1c2d3"). You get this from `vibiz_meta_ads_creatives_list[].id`. NOT the Meta platform numeric id, NOT a Vibiz campaign_ad UUID.

vibiz_meta_ads_launch_boost_post

Boost an existing organic Facebook or Instagram post as a paid ad. Cheaper than creating from scratch — reuses the post creative.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • 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. Provide ONE of `postId` or `platformPostId`.

  • accountIdstringrequired

    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_…`.

  • adAccountIdstringrequired

    EXPECTS: Meta platform ad account id (string starting with "act_", e.g. "act_1234567890"). Get it from `vibiz_meta_ads_accounts_list[].id` for the chosen socialAccountId. NOT an internal Mongo ObjectId.

  • namestringrequired

    Ad name (max 255 chars).

  • 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

  • budgetobjectrequired
  • currencystringoptional

    ISO-4217 currency code.

  • scheduleobjectoptional
  • targetingobjectoptional
  • bidAmountnumberoptional

    Meta only.

  • trackingobjectoptional

    Meta only.

  • specialAdCategoriesarrayoptional

    Meta only.

vibiz_meta_ads_launch_create

Create a standalone Meta ad from scratch — campaign + ad set + ad in one call. No existing post needed.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • accountIdstringrequired

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

  • adAccountIdstringrequired

    EXPECTS: Meta platform ad account id (string starting with "act_"). Get it from `vibiz_meta_ads_accounts_list[].id`.

  • namestringrequired

    Ad name (max 255 chars).

  • 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

    Budget amount in the ad account currency. Minimums: Meta=$1/day, TikTok=$20/day, Pinterest=$5/day.

  • budgetTypestringrequired

    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

    Meta only.

  • adSetIdstringoptional

    Meta only — attach this creative to an existing ad set. Mutually exclusive with `creatives[]`.

  • 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. Choose based on the ad's LANGUAGE and the business's actual market — Spanish copy for a Spain business → ['ES'], Spanish for Mexico → ['MX'], English US business → ['US']. Match the creative's language and the customer's location; never default to ['US'] unless the audience really is the US.

  • ageMinintegeroptional
  • ageMaxintegeroptional
  • interestsarrayoptional
  • endDatestringoptional

    Required for lifetime budgets.

  • audienceIdstringoptional
  • advantageAudienceintegeroptional

    Advantage Audience flag. 0 = off, 1 = on. Constrained via minimum/maximum (not enum) so Gemini accepts the schema.

  • budgetLevelstringoptional

    Meta budget model. Default (omit) = 'campaign': CBO / Advantage+ campaign budget — the budget lives on the campaign and Meta distributes spend. Pass 'adset' ONLY when the user explicitly asks for per-ad-set budgets (ABO). Ignored when attaching to an existing ad set.

    Values: campaign, adset

vibiz_meta_ads_launch_bulk

Launch multiple Meta ads in ONE call — all sharing the same campaign, ad set, budget, and targeting. Cheaper and faster than calling `vibiz_meta_ads_launch_create` N times because it avoids creating N separate campaigns.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • accountIdstringrequired

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

  • adAccountIdstringrequired

    EXPECTS: Meta platform ad account id (string starting with "act_"). Get it from `vibiz_meta_ads_accounts_list[].id`.

  • namestringrequired

    Campaign name (max 255 chars). Each ad inside the campaign gets an auto-numbered name from Meta.

  • 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

    Shared budget for the whole ad set (NOT per-ad). Meta=$1/day minimum.

  • budgetTypestringrequired

    Values: daily, lifetime

  • currencystringoptional

    ISO-4217 currency code.

  • creativesarrayrequired

    Array of ad creatives. Each entry needs exactly one of `imageUrl` or `video`. All other fields are required.

  • 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. Choose based on the ad's LANGUAGE and the business's actual market — Spanish copy for a Spain business → ['ES'], Spanish for Mexico → ['MX'], English US business → ['US']. Match the creative's language and the customer's location; never default to ['US'] unless the audience really is the US.

  • ageMinintegeroptional
  • ageMaxintegeroptional
  • interestsarrayoptional
  • endDatestringoptional

    Required for lifetime budgets.

  • audienceIdstringoptional
  • advantageAudienceintegeroptional

    Advantage Audience flag. 0 = off, 1 = on. Constrained via minimum/maximum (not enum) so Gemini accepts the schema.

  • budgetLevelstringoptional

    Meta budget model. Default (omit) = 'campaign': CBO / Advantage+ campaign budget — the budget lives on the campaign and Meta distributes spend. Pass 'adset' ONLY when the user explicitly asks for per-ad-set budgets (ABO). Ignored when attaching to an existing ad set.

    Values: campaign, adset

vibiz_meta_ads_launch_from_creative

Attach an EXISTING Vibiz creative to an EXISTING Meta ad set. The creative's image/video, headline, body, and CTA are resolved from the Vibiz `campaign_ad` row; the ad set's goal, budget, and targeting are inherited from Meta.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • adIdstringrequired

    EXPECTS: Vibiz `campaign_ad` UUID. Get from a recent `vibiz_generate_image` / `vibiz_creatives_edit` response or `vibiz_list_creatives`. Must have status "succeeded" and a resolved imageUrl or videoUrl.

  • adSetIdstringrequired

    EXPECTS: Meta ad set platform id. Get from `vibiz_meta_ads_campaigns_get_tree[].adSets[].platformAdSetId`. The ad set must belong to a campaign on the chosen `adAccountId`.

  • accountIdstringrequired

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

  • adAccountIdstringrequired

    EXPECTS: Meta ad account id (starts with "act_"). Get from `vibiz_meta_ads_accounts_list[].id`.

  • namestringoptional

    Ad name shown on Meta (max 255 chars). Defaults to the Vibiz creative's `name` when omitted.

  • linkUrlstringrequired

    Destination URL the ad clicks through to. Vibiz creatives have no stored link — ASK the user (usually their landing page / funnel URL) if not provided.

  • callToActionstringoptional

    Meta only.

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

  • headlinestringoptional

    Optional override for the ad headline. Defaults to the Vibiz creative's `headline` (auto-derived from the prompt).

  • bodystringoptional

    Optional override for the ad body copy. Defaults to the Vibiz creative's `body` (auto-derived from the prompt).

  • budgetAmountnumberrequired

    Declared daily / lifetime budget used to compute the tiered Vibiz platform fee (20% base, 5% at $100+, 1% at $1,000+). Meta's actual spend is inherited from the ad set; this number does NOT change Meta's budget.

  • budgetTypestringrequired

    Values: daily, lifetime

  • currencystringoptional

    ISO-4217 currency code for the fee calculation. Default USD.

vibiz_meta_ads_add_to_ad_set

Add 1–10 creatives to an EXISTING Meta ad set. Inherits the ad set budget, goal, and targeting — no new campaign is created.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • campaignIdstringrequired

    Meta platform campaign id from `vibiz_meta_ads_campaigns_get_tree[].platformCampaignId`.

  • adSetIdstringrequired

    Meta platform ad set id from `vibiz_meta_ads_campaigns_get_tree[].adSets[].platformAdSetId`.

  • linkUrlstringoptional

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

  • creativesarrayrequired
vibiz_meta_ads_create_ad_set

Create a NEW Meta ad set inside an EXISTING campaign, then add 1–10 creatives.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • campaignIdstringrequired

    Meta platform campaign id from `vibiz_meta_ads_campaigns_get_tree[].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.

  • 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. Choose based on the ad's LANGUAGE and the business's actual market — Spanish copy for a Spain business → ['ES'], Spanish for Mexico → ['MX'], English US business → ['US']. Match the creative's language and the customer's location; never default to ['US'] unless the audience really is the US.

  • ageMinintegeroptional
  • ageMaxintegeroptional
  • interestsarrayoptional
  • creativesarrayrequired
vibiz_meta_ads_accounts_list

List the platform ad accounts (e.g. Meta `act_…` ids) reachable through a given social account.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • socialAccountIdstringrequired

    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`.

vibiz_meta_ads_accounts_get_connect_url

Start the ads-specific OAuth flow for a platform. Returns either an `authUrl` to send the user to, or `{ alreadyConnected: true }` when the workspace already has an ads credential for that platform.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • platformstringrequired

    Ads platform to connect. Note `googleads` (not `google`).

    Values: facebook, instagram, linkedin, tiktok, twitter, pinterest, googleads

  • socialAccountIdstringoptional

    Required for separate-token platforms (tiktok, twitter); ignored for same-token + standalone.

  • redirectUrlstringoptional

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

vibiz_meta_ads_pixels_create

Provision a new Meta Pixel under a Meta ad account. Returns the pixel id and the install snippet (`tag.code`) the user pastes into their site (or the assistant injects into a generated funnel).

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • socialAccountIdstringrequired

    EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or `vibiz_meta_ads_accounts_list` ancestor.

  • adAccountIdstringrequired

    EXPECTS: Meta platform ad account id (string starting with "act_"). Get it from `vibiz_meta_ads_accounts_list[].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').

vibiz_meta_ads_pixels_list

List every Meta Pixel (pixel id + name) reachable through the given social account. Pass `adAccountId` to scope to one ad account.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • socialAccountIdstringrequired

    EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or `vibiz_meta_ads_accounts_list` ancestor.

  • adAccountIdstringoptional

    EXPECTS: Meta platform ad account id (string starting with "act_"). Get it from `vibiz_meta_ads_accounts_list[].id`. OPTIONAL — omit to list pixels across every ad account on this social account.

vibiz_meta_ads_pixels_get

Fetch one Meta Pixel by id, including the install snippet (`code`) and `lastFiredTime`.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • socialAccountIdstringrequired

    EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or `vibiz_meta_ads_accounts_list` 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`).

vibiz_meta_ads_pixels_stats

Pixel event performance broken down by an aggregation dimension (event / host / url / device_type).

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • socialAccountIdstringrequired

    EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or `vibiz_meta_ads_accounts_list` 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

vibiz_meta_ads_pixels_update

Rename a pixel or toggle Meta's feature flags on it (Advanced Matching, first-party cookies, data-use setting).

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • socialAccountIdstringrequired

    EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or `vibiz_meta_ads_accounts_list` 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
vibiz_meta_ads_pixels_share

Grant another Meta ad account permission to fire / read this pixel. This is the "grant pixel on demand" handoff: a workspace can wire one pixel into ad campaigns owned by separate ad accounts without copy-pasting install snippets per surface.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • socialAccountIdstringrequired

    EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or `vibiz_meta_ads_accounts_list` 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_meta_ads_accounts_list[].id`. This is the RECIPIENT ad account that should gain access — NOT the ad account the pixel was originally created on.

vibiz_meta_ads_pixels_list_shares

List the Meta ad accounts this pixel is currently shared with. Pair with `vibiz_meta_ads_pixels_share` / `_unshare` to audit and tighten permissions.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • socialAccountIdstringrequired

    EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or `vibiz_meta_ads_accounts_list` 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`).

vibiz_meta_ads_pixels_unshare

Revoke a Meta ad account's access to this pixel. Closest thing to 'delete' since Meta does not expose a pixel-delete endpoint.

Parameters

  • targetobjectoptional

    Where the generation should be applied. Pass `vibiz` (slug from list_vibiz) OR `brandUrl` (any URL — we scrape its brand). CRITICAL: if the user requests a brand that is not in the list_vibiz output AND brandUrl is not yet supported (or the URL fails), DO NOT silently fall back to a different vibiz. Tell the user the brand is not yet onboarded and either (a) suggest they create a new vibiz at /vibiz or (b) ask them to pick from the available vibiz. Do not generate with the wrong brand.

  • socialAccountIdstringrequired

    EXPECTS: Zernio social account id (24-char hex Mongo ObjectId). Get it from `vibiz_social_list_accounts[].id` or `vibiz_meta_ads_accounts_list` 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_meta_ads_accounts_list[].id`.

On this page

  • Generation
  • Workspace
  • Analytics
  • Inbox
  • Social
  • Meta ads