Referência de ferramentas

Parâmetros

• querystringopcional

  Filtro sem diferenciar maiúsculas e minúsculas pelo nome ou site do vibiz (por exemplo, “acme” ou “acme.com”).

• limitintegeropcional

  Tamanho da página.

• cursorstringopcional

  `next_cursor` da página anterior.

Parâmetros

• platformstringobrigatório

  Plataforma de anúncios: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest ou twitter (X).

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

• actionstringobrigatório

  “list”: contas de anúncios vinculadas a uma conta social. “connect_url”: link para conectar anúncios.

  Valores: list, connect_url

• vibizstringopcional

  Slug da marca de list_vibiz, por exemplo, “acme”. Omita apenas se o conector estiver fixado em uma marca.

• socialAccountIdstringopcional

  ESPERA: ID da conta social (Mongo ObjectId hexadecimal de 24 caracteres). Obtenha em `vibiz_social_list_accounts[].id`. NÃO é o ID de conta de anúncios da Meta `act_…`; esse é retornado por ESTA ferramenta em `accounts[].id`.

• publisher_platformstringopcional

  Somente Meta: onde a campanha é veiculada. Padrão: facebook.

  Valores: facebook, instagram

• redirectUrlstringopcional

  URL personalizado para redirecionar o usuário após OAuth (somente plataformas com o mesmo token).

Parâmetros

• platformstringobrigatório

  Plataforma de anúncios: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest ou twitter (X).

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

• actionstringobrigatório

  “list”: métricas da campanha. “tree”: campanha → conjuntos de anúncios → anúncios com orçamentos (mais lento).

  Valores: list, tree

• vibizstringopcional

  Slug da marca de list_vibiz, por exemplo, “acme”. Omita apenas se o conector estiver fixado em uma marca.

• publisher_platformstringopcional

  Somente Meta: onde a campanha é veiculada. Padrão: facebook.

  Valores: facebook, instagram

• statusstringopcional

  Retorna apenas itens com este status.

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

• includeExternalbooleanopcional

  Padrão false: apenas campanhas ou anúncios criados pelo Vibiz. Defina true SOMENTE quando o usuário perguntar sobre tudo na conta de anúncios, incluindo campanhas criadas no Gerenciador de Anúncios.

• limitintegeropcional

  Número máximo de campanhas a retornar (padrão: 20).

• fromDatestringopcional

  Data inicial, YYYY-MM-DD.

• toDatestringopcional

  Data final, YYYY-MM-DD.

Parâmetros

• platformstringobrigatório

  Plataforma de anúncios: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest ou twitter (X).

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

• actionstringobrigatório

  “list”: anúncios com métricas. “get”: um anúncio. “analytics”: dados diários de um anúncio. get/analytics exigem adId.

  Valores: list, get, analytics

• vibizstringopcional

  Slug da marca de list_vibiz, por exemplo, “acme”. Omita apenas se o conector estiver fixado em uma marca.

• publisher_platformstringopcional

  Somente Meta: onde a campanha é veiculada. Padrão: facebook.

  Valores: facebook, instagram

• statusstringopcional

  Retorna apenas itens com este status.

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

• includeExternalbooleanopcional

  Padrão false: apenas campanhas ou anúncios criados pelo Vibiz. Defina true SOMENTE quando o usuário perguntar sobre tudo na conta de anúncios, incluindo campanhas criadas no Gerenciador de Anúncios.

• campaignIdstringopcional

  ESPERA: ID de campanha da plataforma Meta (numérico de 16-18 dígitos, por exemplo, “23859876543210000”). NÃO é um ID interno de campanha. Obtenha em vibiz_ads_campaigns (action “list”, platform “meta”), campo platformCampaignId.

• fromDatestringopcional

  YYYY-MM-DD

• toDatestringopcional

  YYYY-MM-DD

• limitintegeropcional

  Número máximo de linhas a retornar.

• adIdstringopcional

  ID interno de anúncio: um Mongo ObjectId hexadecimal de 24 caracteres (por exemplo, “65a3f0c1d2e4b8e9f4a1c2d3”). Obtenha em vibiz_ads_creatives (action “list”, platform “meta”), campo id. NÃO é o ID numérico da plataforma Meta nem um UUID de campaign_ad do Vibiz.

• breakdownsarrayopcional

  Chaves de dimensão opcionais (Meta: age | gender | country | publisher_platform | device_platform | region). O servidor as une no parâmetro de consulta “breakdowns”, separadas por vírgulas.

Parâmetros

• platformstringobrigatório

  Plataforma de anúncios: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest ou twitter (X).

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

• levelstringobrigatório

  “campaign” (somente Meta) ou “creative” (um anúncio individual em qualquer plataforma).

  Valores: campaign, creative

• idstringobrigatório

  ID de campanha da plataforma ou ID interno de anúncio de vibiz_ads_creatives.

• publisher_platformstringopcional

  Somente Meta: onde a campanha é veiculada. Padrão: facebook.

  Valores: facebook, instagram

• vibizstringopcional

  Slug da marca de list_vibiz, por exemplo, “acme”. Omita apenas se o conector estiver fixado em uma marca.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• platformstringobrigatório

  Plataforma de anúncios: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest ou twitter (X).

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

• actionstringobrigatório

  “create”: uma nova campanha. “boost_post”: promove uma publicação social já publicada.

  Valores: create, boost_post

• vibizstringopcional

  Slug da marca de list_vibiz, por exemplo, “acme”. Omita apenas se o conector estiver fixado em uma marca.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

• adAccountIdstringopcional

  ID da conta de anúncios da Meta (“act_…”). Omita para usar a conta selecionada.

• namestringopcional

  Nome da campanha (máximo 255).

• goalstringopcional

  Objetivo de otimização do conjunto de anúncios: escolha o que corresponde ao que o negócio realmente quer, NÃO “traffic” por padrão. Para gerar VENDAS/COMPRAS (a maioria dos e-commerces e ofertas pagas), use “conversions”.

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

• budgetAmountnumberopcional

  Orçamento diário na moeda da conta de anúncios. Mínimo de $10/dia.

• budgetTypestringopcional

  No estúdio, só é possível preparar “daily”.

  Valores: daily, lifetime

• currencystringopcional
• headlinestringopcional
• bodystringopcional
• callToActionstringopcional

  Somente Meta.

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

• linkUrlstringopcional
• imageUrlstringopcional
• videoobjectopcional
• creativeIdstringopcional

  Um criativo do Vibiz em vez de imageUrl/video.

• campaignIdstringopcional

  Com adSetId: a campanha ativa à qual pertence o conjunto de anúncios.

• adSetIdstringopcional

  Prepara o anúncio neste conjunto existente (exige campaignId).

• countriesarrayopcional

  OBRIGATÓRIO para uma boa entrega: códigos de país ISO-3166 alpha-2 (por exemplo, ['ES'], ['MX'], ['US'], ['GB']). NÃO deixe vazio: a Meta usa Estados Unidos por padrão, desperdiçando orçamento quando o anúncio ou negócio não se destina a esse país.

• ageMinintegeropcional
• ageMaxintegeropcional
• interestsarrayopcional

  Segmentação por interesses opcional. Cada `{id,name}` DEVE vir de `vibiz_meta_ads_targeting_search` (ferramentas de anúncios) nesta sessão. Nunca invente nem reutilize um ID lembrado: a Meta rejeita IDs desatualizados (subcódigo 1487079) e o lançamento falha.

• specialAdCategoriesarrayopcional
• audienceIdstringopcional

  Um público personalizado da Meta para segmentar.

• advantageAudienceintegeropcional
• budgetLevelstringopcional

  Valores: campaign, adset

• pixelIdstringopcional
• conversionEventstringopcional
• postIdstringopcional

  ESPERA: ID interno da publicação (Mongo ObjectId hexadecimal de 24 caracteres, por exemplo, “65a3f0c1d2e4b8e9f4a1c2d3”). Obtenha na resposta de `vibiz_social_publish` ou em `vibiz_social_list_posts[].id`. Forneça UM entre `postId` e `platformPostId`.

• platformPostIdstringopcional

  ESPERA: ID de publicação da plataforma Meta (por exemplo, ID de mídia do Instagram “12345_67890” ou do Facebook “123_456”). Obtenha em response.platforms[].platformPostId de `vibiz_social_publish` ou consultando a publicação depois que ela for publicada na plataforma.

• accountIdstringopcional

  ESPERA: ID da conta social (Mongo ObjectId hexadecimal de 24 caracteres) do proprietário da publicação. Obtenha em `vibiz_social_list_accounts[].id`. NÃO é a conta de anúncios da Meta `act_…`.

• budgetobjectopcional
• scheduleobjectopcional
• targetingobjectopcional
• bidAmountnumberopcional

  Somente Meta.

• trackingobjectopcional

  Somente Meta.

• endDatestringopcional

  Obrigatório para orçamentos vitalícios.

• longHeadlinestringopcional

  Somente Display: título longo (máximo 90 caracteres). Obrigatório para anúncios do Google Display.

• imagesobjectopcional

  Anúncios responsivos de Display: `landscape` e `square` são obrigatórios nas campanhas de Display.

• businessNamestringopcional

  Nome do negócio exibido ao lado do anúncio (máximo 25 caracteres). Obrigatório para Google Display.

• campaignTypestringopcional

  Escolha `display` para anúncios responsivos com imagens e `search` para anúncios de texto segmentados por palavras-chave.

  Valores: display, search

• keywordsarrayopcional

  Somente campanhas de pesquisa: lista de palavras-chave (um termo por entrada).

• additionalHeadlinesarrayopcional

  Variações adicionais de títulos para anúncios responsivos de pesquisa. O Google as alterna automaticamente.

• additionalDescriptionsarrayopcional

  Variações adicionais de descrições para anúncios responsivos de pesquisa. O Google as alterna automaticamente.

• brandIdentityobjectopcional

  Identidade de marca do TikTok para contas apenas de anúncios (sem conta de publicação conectada). Omita para preencher a partir da marca do espaço de trabalho (nome e logotipo); o Late armazena a identidade na conta de anúncios após o primeiro lançamento.

• boardIdstringopcional

  ESPERA: ID do painel do Pinterest. Obrigatório: os anúncios do Pinterest devem direcionar a um painel específico.

Parâmetros

• platformstringobrigatório

  Plataforma de anúncios: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest ou twitter (X).

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

• levelstringobrigatório

  “campaign” ou “creative” (um anúncio individual).

  Valores: campaign, creative

• idsarrayobrigatório

  IDs de campanha da plataforma (nível campaign) ou IDs internos de anúncio (nível creative).

• publisher_platformstringopcional

  Somente Meta: onde a campanha é veiculada. Padrão: facebook.

  Valores: facebook, instagram

• vibizstringopcional

  Slug da marca de list_vibiz, por exemplo, “acme”. Omita apenas se o conector estiver fixado em uma marca.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• vibizstringopcional

  Slug da marca de list_vibiz, por exemplo, “acme”. Omita apenas se o conector estiver fixado em uma marca.

Parâmetros

• vibizstringopcional

  O mesmo valor do plano.

• formatstringobrigatório

  O mesmo valor do plano.

  Valores: image, carousel, video, ugc, product_shot

• briefstringobrigatório

  O mesmo valor do plano.

• countintegeropcional

  O mesmo valor do plano.

• placementstringopcional

  O mesmo valor do plano.

• offer_idstringopcional

  O mesmo valor do plano.

• durationstringopcional

  O mesmo valor do plano.

  Valores: 4s, 6s, 8s

• resolutionstringopcional

  O mesmo valor do plano.

  Valores: 480p, 720p, 1080p

• extra_fieldsobjectopcional

  O mesmo valor do plano.

Parâmetros

• querystringobrigatório

  O que o usuário quer, nas palavras dele, por exemplo, “responda às minhas mensagens diretas do Instagram”.

• limitintegeropcional

  Máximo de correspondências (padrão: 5).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• imageUrlstringopcional

  URL público http(s) da imagem ou vídeo a enviar. O servidor baixa e armazena o arquivo. Melhor opção para a maioria dos clientes.

• imageBase64stringopcional

  Bytes do arquivo codificados em Base64 (sem prefixo data:). Exige `contentType`. Apenas arquivos pequenos (≤ 3 MB); arquivos locais maiores usam o modo pré-assinado (omita imageUrl e imageBase64).

• filenamestringopcional

  Nome original do arquivo, usado para deduzir sua extensão. Exemplo: “hero-shot.jpg”. Opcional quando `imageUrl` é fornecido.

• contentTypestringopcional

  Tipo MIME. Obrigatório para `imageBase64` e o modo pré-assinado; inferido da resposta para `imageUrl`.

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

Parâmetros

• runIdstringobrigatório

  ID de execução do Trigger.dev da resposta de uma ferramenta vibiz_generate_*.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

Parâmetros

• vibizstringopcional

  Slug da marca de list_vibiz, por exemplo, “acme”. Omita apenas se o conector estiver fixado em uma marca.

• rangestringopcional

  "7d" para a última semana (predefinição), "30d" para o último mês, "90d" para o trimestre.

  Valores: 7d, 30d, 90d

• platformsarrayopcional

  Plataformas de anúncios a incluir (por predefinição, as seis; as não ligadas são ignoradas).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• platformstringopcional
• statusstringopcional

  Valores: draft, queued, processing, succeeded, failed

• mediaTypestringopcional

  Valores: image, video, any

• limitintegeropcional
• onlyFavoritesbooleanopcional
• currentVersionsOnlybooleanopcional
• displaybooleanopcional

  Use true quando o utilizador deva ver a galeria de criativos no chat.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• campaignIdstringobrigatório

  ID da campanha na plataforma Meta de vibiz_ads_campaigns (action "tree", platform "meta"), campo platformCampaignId.

• adSetIdstringobrigatório

  ID do conjunto de anúncios na plataforma Meta de vibiz_ads_campaigns (action "tree", platform "meta"), campo adSets[].platformAdSetId`.

• linkUrlstringopcional

  URL de destino predefinido quando um criativo omite linkUrl (normalmente o funil ou a página de destino).

• creativesarrayobrigatório
• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• dailyBudgetnumberobrigatório

  Montante indicado pelo fundador (unidades monetárias principais).

• budgetCurrencystringopcional

  Moeda ISO de `dailyBudget`. Predefinição: USD.

• adAccountIdstringopcional

  Conta de anúncios Meta opcional (act_…). Predefinição: a conta selecionada no espaço de trabalho.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• entityTypestringobrigatório

  Valores: campaign, adset, ad

• idsarrayobrigatório

  IDs da plataforma Meta do nível indicado: IDs de campanhas, de conjuntos de anúncios ou de anúncios Zernio (vibiz_ads_creatives (action "list", platform "meta"), campo id).

• dailyBudgetnumberobrigatório

  Novo orçamento diário em unidades monetárias principais (20 = $20/dia).

• campaignIdstringopcional

  Obrigatório quando entityType é "adset": campanha proprietária dos conjuntos. ID da campanha na plataforma Meta (16-18 dígitos) de vibiz_ads_campaigns (action "tree", platform "meta"), campo platformCampaignId. NÃO é um ObjectId do Zernio nem um UUID do Vibiz.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• urlstringopcional

  URL do site ou Instagram, por exemplo, https://acme.com ou instagram.com/acme. Obrigatório, a menos que vibiz retome uma marca existente.

• workspace_namestringopcional

  Nome visível de um novo vibiz; por predefinição, o nome do site.

• vibizstringopcional

  Slug de um vibiz a retomar em vez de criar um.

Parâmetros

• vibizstringopcional

  Slug da marca de list_vibiz, por exemplo, “acme”. Omita apenas se o conector estiver fixado em uma marca.

• formatstringobrigatório

  image (anúncio estático), carousel (vários diapositivos), video (vídeo publicitário), ugc (vídeo falado ao estilo de criador), product_shot (fotografia de produto numa cena).

  Valores: image, carousel, video, ugc, product_shot

• briefstringobrigatório

  O que criar, nas palavras do utilizador: oferta, abordagem, público e frases obrigatórias.

• countintegeropcional

  Número de variações, 1-4.

• placementstringopcional

  Onde é publicado, por exemplo, instagram_portrait, tiktok_story, facebook_feed, tiktok/reels/shorts para UGC.

• offer_idstringopcional

  Oferta a destacar, de vibiz_list_offers (conjunto de ferramentas do espaço de trabalho). Opcional.

• durationstringopcional

  Duração de video / ugc. Predefinição: 4s (video), 8s (ugc).

  Valores: 4s, 6s, 8s

• resolutionstringopcional

  Qualidade de renderização ugc (video: 720p ou 1080p). Predefinição: 720p.

  Valores: 480p, 720p, 1080p

• extra_fieldsobjectopcional

  Campos de origem específicos do formato (product_shot precisa de productTitle, productImageUrl e recipeId).

Parâmetros

• toolstringobrigatório

  Ferramenta que respondeu approval_required, por exemplo, vibiz_social_publish.

• argumentsobjectobrigatório

  Argumentos exatos dessa ferramenta (sem approval_token).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• statusstringopcional

  Filtre por estado.

  Valores: draft, scheduled, published, failed

• platformstringopcional

  Filtre por plataforma.

• limitnumberopcional

  Número máximo de publicações (1-100; predefinição: 10).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• contentstringobrigatório

  Texto da publicação.

• platformsarrayobrigatório

  Plataformas e IDs de contas.

• mediaUrlsarrayopcional

  URLs de imagens ou vídeos a anexar. Um URL terminado em .mp4 ou .mov é publicado como vídeo (Reel, TikTok ou Short onde a plataforma o permitir); qualquer outro, como imagem. Carregue primeiro os ficheiros locais com vibiz_gallery_upload e use o respetivo publicUrl.

• scheduledForstringopcional

  Data e hora ISO para agendar. Omita para publicar de imediato.

• hashtagsarrayopcional

  Hashtags.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• personIdstringobrigatório
• genderstringopcional

  Valores: female, male

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• videoUrlstringobrigatório

  Vídeo a analisar: um URL do Vibiz ou de uma plataforma de anúncios.

• mimeTypestringopcional

  Somente se não for mp4 (por exemplo, video/webm).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• sourceAdIdstringobrigatório

  ID campaign_ad da imagem estática existente a animar (obtenha na saída de `vibiz_generate_image`, do conjunto de ferramentas criativas, ou na galeria).

• sourceImageUrlstringobrigatório

  URL da imagem desse anúncio (deve ser um URL https válido).

• promptstringopcional

  Descrição da animação: como a imagem deve ganhar vida? Por exemplo, “aproximação suave da câmera, a pessoa sorri e acena com a cabeça”. Opcional; se omitida, usa-se um padrão adequado.

• aspectRatiostringopcional

  Proporção de saída. “auto” a deduz da imagem original. Padrão: “auto”.

  Valores: 16:9, 9:16, auto

• durationstringopcional

  Duração do vídeo. Padrão: “4s”.

  Valores: 4s, 6s, 8s

• resolutionstringopcional

  Padrão: “720p”.

  Valores: 720p, 1080p

• generateAudiobooleanopcional

  Padrão: true.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• photoUrlstringobrigatório

  Fotografia de base (https; Unsplash, Pexels ou armazenamento do Vibiz).

• headlinestringopcional

  De três a seis palavras.

• subheadstringopcional

  Uma frase curta de apoio.

• platformstringopcional

  Valores: instagram_square, instagram_portrait, instagram_story, facebook_feed, landscape

• logoCornerstringopcional

  Valores: top-left, top-right, bottom-left, bottom-right

• noScrimbooleanopcional
• offerIdstringopcional

  Oferta a que o anúncio se refere, de vibiz_list_offers (ferramentas do espaço de trabalho).

• icpIdstringopcional

  Público a que o anúncio se destina, de vibiz_list_icps (ferramentas do espaço de trabalho).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• creativeIdstringopcional

  ID de um criativo. Retorna sua origem completa e as hipóteses associadas.

• icpIdstringopcional

  ID de ICP de vibiz_list_icps (ferramentas do espaço de trabalho). Retorna tudo o que foi criado para esse público.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• adIdstringobrigatório

  ID do criativo (anúncio).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• referenceImageUrlstringopcional

  URL público da imagem a editar, obtido da galeria, ou omita ao usar conversationImageId para uma imagem enviada no chat.

• conversationImageIdstringopcional

  Se o usuário anexou a imagem da tela no chat, passe image-N dos rótulos da conversa.

• promptstringobrigatório

  O que mudar na imagem. Seja específico sobre a edição (“deixe o fundo laranja de pôr do sol”, “remova a marca d'água”, “adicione um botão COMPRAR AGORA no canto inferior direito”). Evite instruções de storyboard ou quadros: trata-se da edição de uma imagem, não de movimento.

• platformstringopcional

  Plataforma de destino da imagem editada. DEVE ser um dos valores listados. Padrão: “instagram_portrait”.

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

• aspectRatiostringopcional

  Proporção de saída opcional. Se omitida, deriva de `platform`. Observação: alterar a proporção em relação à imagem original pode cortá-la ou expandi-la.

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

• stylestringopcional

  Chave de estilo por categoria. “hero-shot” é o padrão; escolha a categoria cujo estilo visual corresponda à intenção do usuário.

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

• imageCountintegeropcional

  Número de VARIAÇÕES de edição a gerar (1-4). Padrão 1. Útil quando o usuário quer comparar várias versões da mesma edição.

• additionalReferenceImagesarrayopcional

  URLs opcionais do Discover ou da galeria vindos de resultados anteriores de ferramentas. Arquivos adicionais do chat usam conversationImageIds.

• conversationImageIdsarrayopcional

  Referências adicionais de arquivos enviados no chat (image-1, image-2, …).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• idstringobrigatório

  ID do vídeo de meme de `videos[].id` em vibiz_produce_meme_videos (ferramentas criativas).

• captionstringopcional

  Novo texto do vídeo. Omita para manter o atual.

• templateIdstringopcional

  ID do modelo de meme indicado pelo usuário. Omita para manter o meme atual.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• adIdstringobrigatório

  ID do anúncio do vídeo renderizado a finalizar.

• subtitlesbooleanopcional

  Adiciona legendas (transcrição do áudio falado).

• subtitleStylestringopcional

  Estilo das legendas. Padrão hormozi.

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

• subtitleLanguagestringopcional

  Código ISO 639-1 do idioma falado, apenas se o usuário o indicar; se omitido, é detectado automaticamente.

• musicstringopcional

  Adiciona música de fundo: descreva como deve soar ao longo do tempo. Omita para não adicionar música.

• musicDurationSecnumberopcional

  Limite superior opcional para a música; por padrão, um pouco abaixo da duração do vídeo.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• promptstringobrigatório

  Descreva o anúncio inteiro como UMA cena: sujeito, ambiente, enquadramento da marca, movimento e texto na tela. NÃO forneça storyboards quadro a quadro.

• platformstringopcional

  Plataforma de destino. O servidor a converte em uma proporção de vídeo (9:16 para plataformas de stories, 16:9 para as demais). Padrão: “facebook_feed”.

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

• videoDurationstringopcional

  Duração do vídeo. Padrão: “4s”.

  Valores: 4s, 6s, 8s

• videoResolutionstringopcional

  Padrão: “720p”.

  Valores: 720p, 1080p

• generateAudiobooleanopcional

  Padrão: true.

• useBrandbooleanopcional

  Aplica o kit de marca do espaço de trabalho. Padrão true.

• allowPartialBrandbooleanopcional

  Permite um rascunho antecipado. Padrão false. Defina true apenas se o usuário pedir explicitamente para gerar antes de concluir a configuração inicial, a marca ou o produto; o resultado pode não seguir a marca.

• referenceImagesarrayopcional

  URLs opcionais do Discover ou da galeria vindos de resultados anteriores de ferramentas. Imagens enviadas no chat devem usar conversationImageIds.

• conversationImageIdsarrayopcional

  Referências a arquivos enviados no chat (image-1, image-2, …). Nunca copie URLs de anexos para referenceImages.

• offerIdstringopcional

  ID da oferta ou produto do vídeo. Obtenha em `vibiz_list_offers[].id` (ferramentas do espaço de trabalho). Quando definido, o roteiro se baseia no título, nos detalhes e na imagem do produto. OBRIGATÓRIO se o usuário disser “um anúncio em vídeo do meu produto” ou “um vídeo para esta oferta”: chame primeiro `vibiz_list_offers` (ferramentas do espaço de trabalho) e PERGUNTE se houver várias ofertas possíveis.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• promptstringobrigatório

  Sobre o que é o carrossel: tema, abordagem e mensagem principal. O gerador escreve o texto de cada slide; você descreve a história, não os slides individuais.

• slideCountintegeropcional

  Número de slides (2-10). Padrão 3. Mais slides custam mais créditos (1 por slide).

• platformstringopcional

  Destino de publicação. instagram_portrait=carrossel do Instagram 4:5; instagram_story=Story/Reels do Instagram 9:16; tiktok_story=TikTok 9:16; linkedin=1:1; facebook_feed=1:1. Deduza pelo contexto ou pergunte pelo posicionamento se não estiver claro.

  Valores: instagram_portrait, instagram_story, linkedin, facebook_feed, tiktok_story

• aspectRatiostringopcional

  Valor alternativo opcional. Normalmente omita; ele é derivado da plataforma. Defina apenas quando o usuário solicitar explicitamente uma proporção diferente da padrão.

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

• useBrandbooleanopcional

  Aplica o kit de marca do espaço de trabalho (cores, fontes, logotipo e tom). Padrão true.

• allowPartialBrandbooleanopcional

  Permite um rascunho antecipado. Padrão false. Defina true apenas se o usuário pedir explicitamente para gerar antes de concluir a configuração inicial, a marca ou o produto; o resultado pode não seguir a marca.

• offerIdstringopcional

  ID da oferta ou produto do carrossel. Obtenha em `vibiz_list_offers[].id` (ferramentas do espaço de trabalho). Quando definido, os textos e imagens se baseiam nesse produto. OBRIGATÓRIO se o usuário disser “meu produto” ou “um carrossel sobre [algo que vendo]”: chame primeiro `vibiz_list_offers` (ferramentas do espaço de trabalho) e PERGUNTE se várias ofertas puderem corresponder.

• slidesarrayopcional

  Slides de carrossel pré-redigidos, opcionais. Quando definidos, a geração usa esses títulos e textos em vez de replanejar a história.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• promptstringobrigatório

  Descreva a IMAGEM ESTÁTICA a gerar. Não a estruture como um storyboard ou uma sequência de fotogramas.

• platformstringopcional

  Plataforma de destino. TEM de ser um dos valores indicados. Correspondências comuns: TikTok → "tiktok_story", feed do Instagram → "instagram_portrait", história do Instagram → "instagram_story", Facebook → "facebook_feed", LinkedIn → "linkedin". Predefinição: "instagram_portrait".

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

• aspectRatiostringopcional

  Opcional. Se omitido, é deduzido de `platform`. 9:16 = vertical, 1:1 = quadrado, 16:9 = horizontal.

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

• stylestringopcional

  Chave de estilo opcional por categoria. Omita-a, a menos que o utilizador tenha escolhido ou pedido um estilo específico. Use hero-shot para uma imagem principal de estúdio centrada no produto, lifestyle-shot para um contexto real planeado, ugc para fotografias de produto de criadores ou de telemóvel próprias das redes sociais, hyperrealistic para realismo fotográfico cinematográfico, saas-demo para interfaces de produto, founder-portrait para transmitir confiança e infographic para diagramas.

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

• useBrandbooleanopcional

  Aplique o kit de marca do espaço de trabalho (cores, tipos de letra, logótipo e tom). Predefinição: true. Use false apenas se o utilizador pedir explicitamente um aspeto genérico.

• allowPartialBrandbooleanopcional

  Permite um rascunho antecipado. Padrão false. Defina true apenas se o usuário pedir explicitamente para gerar antes de concluir a configuração inicial, a marca ou o produto; o resultado pode não seguir a marca.

• imageCountintegeropcional

  Número de VARIAÇÕES da MESMA imagem a gerar (1-4). Predefinição: 1. NÃO serve para criar um storyboard de vídeo; use `vibiz_generate_ugc` (conjunto de ferramentas de criativos) para conteúdo em movimento.

• referenceImagesarrayopcional

  URLs opcionais do Discover ou da galeria provenientes de uma resposta anterior de ferramenta (por exemplo, originalUrl de vibiz_get_for_you). Nunca cole aqui URLs de anexos do chat; use conversationImageIds.

• conversationImageIdsarrayopcional

  Referências de imagens carregadas no chat (image-1, image-2, … das etiquetas da conversa). Obrigatório quando o utilizador anexou imagens no chat.

• offerIdstringopcional

  ID da oferta ou produto para o qual a imagem é gerada. Obtenha-o de `vibiz_list_offers[].id` (conjunto de ferramentas do espaço de trabalho). Quando definido, o gerador de prompts baseia a imagem nesse produto (título, preço, imagem e URL de origem). OBRIGATÓRIO quando o utilizador disser «o meu produto» ou «esta oferta»: chame primeiro `vibiz_list_offers` (conjunto de ferramentas do espaço de trabalho) e passe o ID correspondente. Se houver várias ofertas e o utilizador não tiver especificado qual, PERGUNTE antes de chamar esta ferramenta.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• productIdstringopcional

  ID de produto opcional de vibiz_list_offers (conjunto de ferramentas do espaço de trabalho).

• productTitlestringobrigatório

  Título do produto no catálogo.

• productImageUrlstringobrigatório

  URL público da imagem exata do produto do catálogo.

• productDescriptionstringopcional

  Contexto opcional sobre os materiais e o fabrico do produto.

• vendorstringopcional

  Fornecedor do produto opcional.

• productTypestringopcional

  Categoria de produto opcional.

• talentPresetIdstringopcional

  Ficha de personagem opcional baseada no estilo para composições com uma pessoa visível.

  Valores: 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

• userNotesstringopcional

  Ajuste opcional subordinado à composição selecionada.

• secondaryProductImageUrlstringopcional

  Segunda vista opcional do produto para representar a sua construção com precisão.

• allowPartialBrandbooleanopcional

  Permita a geração antes de estar pronto todo o contexto de integração inicial.

• recipeIdstringobrigatório

  ID exato da composição do Product Studio.

  Valores: 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

• aspectRatiostringopcional

  Formato de saída opcional. Recomenda-se a predefinição da composição.

  Valores: 1:1, 3:4, 9:16, 4:3, 16:9

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• productIdstringopcional

  ID de produto opcional de vibiz_list_offers (conjunto de ferramentas do espaço de trabalho).

• productTitlestringobrigatório

  Título do produto no catálogo.

• productImageUrlstringobrigatório

  URL público da imagem exata do produto do catálogo.

• productDescriptionstringopcional

  Contexto opcional sobre os materiais e o fabrico do produto.

• vendorstringopcional

  Fornecedor do produto opcional.

• productTypestringopcional

  Categoria de produto opcional.

• talentPresetIdstringopcional

  Ficha de personagem opcional baseada no estilo para composições com uma pessoa visível.

  Valores: 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

• userNotesstringopcional

  Ajuste opcional subordinado à composição selecionada.

• secondaryProductImageUrlstringopcional

  Segunda vista opcional do produto para representar a sua construção com precisão.

• allowPartialBrandbooleanopcional

  Permita a geração antes de estar pronto todo o contexto de integração inicial.

• bundleIdstringobrigatório

  launch_essentials, social_content, pdp_catalog, influencer_collection ou model_collection.

  Valores: launch_essentials, social_content, pdp_catalog, influencer_collection, model_collection

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• productNamestringobrigatório

  Nome curto do produto, marca ou serviço do vídeo (por exemplo, «Vibiz», «Subscrição de café Acme»). Obrigatório.

• productDetailsstringobrigatório

  Parágrafo que descreva o produto, o público-alvo, os ganchos, os elementos diferenciadores e as indicações de tom ou estilo. Obrigatório. NÃO envie um storyboard: descreva o produto e a sua importância; a tarefa escreve o seu próprio guião.

• scriptstringopcional

  Guião UGC completo opcional escrito por si: falas entre aspas, momentos, câmara e som. Refira-se a uma imagem de referência como Image 1. Quando definido, é renderizado tal como foi escrito (styleId, videoStyle, hook e creatorGender não são aplicados).

• styleIdstringopcional

  Estilo UGC com nome (consulte `vibiz_list_ugc_styles` (conjunto de ferramentas de criativos)). Prefira-o a `videoStyle`.

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

• videoStylestringopcional

  Estilo antigo de pessoa a falar para a câmara (ignorado quando `styleId` está definido). talking_head é o aspeto predefinido, centrado no rosto e gravado com telemóvel.

  Valores: talking_head, review, unboxing, pov

• platformstringopcional

  Plataforma de destino para vídeo curto. Determina a proporção e o ritmo. Predefinição: "tiktok".

  Valores: tiktok, reels, shorts

• durationstringopcional

  Duração do vídeo. Predefinição: "8s".

  Valores: 4s, 6s, 8s

• resolutionstringopcional

  Qualidade de renderização. Predefinição: "720p".

  Valores: 480p, 720p, 1080p

• creatorGenderstringopcional

  Género apresentado pelo criador de IA ou pela pessoa que fala para a câmara. Predefinição: "female".

  Valores: female, male

• hookstringopcional

  Gancho de abertura opcional (máx. 200 caracteres). Se omitido, a tarefa gera um a partir de productDetails.

• referenceImageUrlstringopcional

  Referência opcional de produto, marca ou estilo a partir de um URL devolvido anteriormente por uma ferramenta. Para ficheiros carregados no chat, use conversationImageId.

• conversationImageIdstringopcional

  Se o utilizador anexou uma imagem de referência no chat, passe image-N das etiquetas da conversa.

• conversationImageIdsarrayopcional

  Referências adicionais de arquivos enviados no chat (image-1, image-2, …).

• offerIdstringopcional

  ID da oferta ou produto para este clip UGC. Obtenha-o de `vibiz_list_offers[].id` (conjunto de ferramentas do espaço de trabalho). Quando definido, a oferta escolhida pelo agente do chat é registada na linha do anúncio resultante para que outras ferramentas a possam reutilizar. OBRIGATÓRIO quando o utilizador disser «um UGC sobre o meu produto» ou «vídeo com porta-voz para [o que vendo]»: chame primeiro `vibiz_list_offers` (conjunto de ferramentas do espaço de trabalho) e PERGUNTE se houver várias ofertas possíveis.

• allowPartialBrandbooleanopcional

  Permite um rascunho antecipado. Padrão false. Defina true apenas se o usuário pedir explicitamente para gerar antes de concluir a configuração inicial, a marca ou o produto; o resultado pode não seguir a marca.

• icpIdstringopcional

  ID opcional do perfil de cliente ou ICP selecionado. Use-o quando o utilizador indicar um público-alvo ou quando uma oferta tiver um ICP claramente associado; orienta o gancho UGC e a abordagem do criador.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• displaybooleanopcional

  Use true quando o utilizador deva ver a galeria de inspiração do Discover no chat.

• limitnumberopcional

  Número máximo de itens a devolver (1..48; predefinição: 24).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

Parâmetros

• displaybooleanopcional

  Use true para mostrar a galeria de pré-visualizações de estilos UGC no chat. Omita numa consulta silenciosa.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• imageUrlstringobrigatório

  Criativo gerado a examinar.

• logoUrlstringopcional

  Logótipo oficial. Omita para usar o logótipo guardado do espaço de trabalho.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• countintegeropcional

  Número de vídeos, de 1 a 5. Predefinição: 3.

• anglestringopcional

  O que o utilizador pediu, nas suas palavras: abordagens, tema ou tom (por exemplo, «faz piadas sobre fazer faturas à mão»). Omita se apenas pediu vídeos meme.

• templateIdsarrayopcional

  Apenas se o utilizador indicou IDs específicos de modelos de memes, por ordem: o vídeo 1 usa o primeiro. Para os restantes são escolhidos memes adequados. Nunca adivinhe um ID.

Parâmetros

• platformstringobrigatório

  Plataforma de anúncios: meta (Facebook + Instagram), google, tiktok, linkedin, pinterest ou twitter (X).

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

• levelstringobrigatório

  “campaign” ou “creative” (um anúncio individual).

  Valores: campaign, creative

• idsarrayobrigatório

  IDs de campanha da plataforma (nível campaign) ou IDs internos de anúncio (nível creative).

• publisher_platformstringopcional

  Somente Meta: onde a campanha é veiculada. Padrão: facebook.

  Valores: facebook, instagram

• vibizstringopcional

  Slug da marca de list_vibiz, por exemplo, “acme”. Omita apenas se o conector estiver fixado em uma marca.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• titlestringobrigatório
• descriptionstringopcional
• reasonstringopcional

  Uma frase curta: o motivo para agir agora.

• impactstringopcional

  Resultado esperado breve, por exemplo, '+8-12 leads/semana'.

• approveLabelstringopcional
• sessionIdstringopcional
• planDayintegeropcional

  Plano contínuo de 3 dias: 1 = hoje, 2 = amanhã, 3 = depois de amanhã. Omita para uma proposta pontual.

• toolsarrayopcional

  Todas as ferramentas de escrita ou subagentes usados na execução do cartão; [] para trabalho somente de leitura. A plataforma calcula `critical` a partir desta lista.

• ownerstringopcional

  Quem executa o cartão: ads-operator para alterações em anúncios, cto para trabalho em sites, researcher, video ou ceo.

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

• planstringopcional

  Somente para o agente, nunca mostrado ao fundador: o plano completo em Markdown que a execução segue e pelo qual é avaliada (escopo, critérios de aceitação, links e riscos).

• areastringopcional

  O domínio do cartão.

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

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• platformstringobrigatório

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

• objectivestringobrigatório

  traffic = visitas ao site, conversions = vendas/registos, lead_generation = formulários.

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

• daily_budgetnumberobrigatório

  «$30 por dia» → 30. Nunca presuma um orçamento.

• currencystringopcional

  ISO-4217; predefinição: USD.

• creative_idstringopcional

  ID do criativo (Meta).

• image_urlstringopcional

  URL público de imagem quando não existe creative_id.

• briefstringopcional

  O que o anúncio vende; se o título e o corpo forem omitidos, a primeira frase é usada como título e o resto como corpo.

• headlinestringopcional
• bodystringopcional
• link_urlstringopcional

  Página de destino.

• call_to_actionstringopcional

  Por exemplo, LEARN_MORE, SHOP_NOW, SIGN_UP.

• countriesarrayopcional

  Por exemplo, ["US","CA"]. Pergunte ao utilizador; não use US por predefinição.

• audience_hintstringopcional

  A quem se destina, nas palavras do utilizador. Um intervalo de idades ("25-45", "18+") é usado para segmentar por idade quando a plataforma o permite; o restante aparece como nota, sem segmentação.

• age_minintegeropcional
• age_maxintegeropcional
• ad_account_idstringopcional

  Obrigatório fora do Meta.

• social_account_idstringopcional

  De vibiz_social_list_accounts. Obrigatório fora do Meta.

• campaign_namestringopcional
• extra_fieldsobjectopcional

  Apenas campos de launch_create específicos da plataforma.

• modestringopcional

  Valores: plan, execute

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• campaignIdstringobrigatório

  ID da campanha na plataforma Meta (16-18 dígitos) de vibiz_ads_campaigns (action "tree", platform "meta"), campo platformCampaignId. NÃO é um ObjectId do Zernio nem um UUID do Vibiz.

• adSetIdsarrayobrigatório

  ID do conjunto de anúncios na plataforma Meta de vibiz_ads_campaigns (action "tree", platform "meta"), campo adSets[].platformAdSetId`.

• statusstringopcional

  Predefinição: "active". "paused" é recusado para os agentes.

  Valores: active, paused

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• sourcesarrayopcional

  Omita para criar todos os públicos do Vibiz que possam ser criados. Valores: auto_site_visitors, auto_leads_list, auto_page_engagers, auto_ig_engagers, ou page_engagers:<pageId> / ig_engagers:<igUserId>.

• adAccountIdstringopcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• adAccountIdstringopcional

  Conta de anúncios Meta ("act_…"); por predefinição, a selecionada.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• adAccountIdstringopcional

  Conta de anúncios Meta ("act_…"); por predefinição, a selecionada.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• campaignIdstringobrigatório

  ESPERA: ID da campanha na plataforma Meta (numérico, com 16-18 dígitos). Obtenha-o de vibiz_ads_campaigns (action "list", platform "meta"), campo platformCampaignId.

• platformstringobrigatório

  Valores: facebook, instagram

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• sourceCampaignIdstringobrigatório

  Campanha ativa a copiar (platformCampaignId).

• namestringopcional

  Nome da cópia.

• adAccountIdstringopcional

  Coloque a cópia nesta conta de anúncios Meta ('act_…').

• conversionEventstringopcional

  Otimize a cópia para este evento em alternativa.

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

• pixelIdstringopcional
• dailyBudgetnumberopcional

  Substitua o orçamento diário (orçamento da campanha em CBO, de cada conjunto de anúncios em ABO).

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• campaignIdstringobrigatório

  ID da campanha na plataforma Meta de vibiz_ads_campaigns (action "tree", platform "meta"), campo platformCampaignId.

• adSetNamestringobrigatório

  Nome do novo conjunto de anúncios (máx. 255 caracteres).

• dailyBudgetnumberopcional

  Obrigatório para campanhas ABO (orçamento por conjunto de anúncios). Omita se a campanha principal for CBO.

• goalstringopcional

  Objetivo de otimização do conjunto de anúncios: escolha o que corresponde ao que o negócio realmente pretende; NÃO use 'traffic' por predefinição. Para gerar VENDAS/COMPRAS (a maioria dos negócios de comércio eletrónico e ofertas pagas), use 'conversions'. Para captar POTENCIAIS CLIENTES (formulários, registos e pedidos de orçamento), use 'lead_generation'. Use 'traffic' apenas quando o utilizador pretender explicitamente cliques ou visitas: otimiza para cliques baratos, não compradores, pelo que costuma desperdiçar orçamento em negócios focados em vendas. 'engagement'/'awareness'/'video_views' destinam-se apenas ao topo do funil.

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

• budgetTypestringopcional

  Valores: daily, lifetime

• linkUrlstringopcional

  URL de destino predefinido para criativos sem linkUrl.

• countriesarrayopcional

  OBRIGATÓRIO para uma boa entrega: códigos de país ISO-3166 alpha-2 (por exemplo, ['ES'], ['MX'], ['US'], ['GB']). NÃO deixe vazio: o Meta usa os Estados Unidos por predefinição, o que desperdiça orçamento se o anúncio ou negócio não se destinar a esse mercado. Se o utilizador ainda não indicou onde anunciar, PERGUNTE antes de lançar: recomende países com base na geografia do ICP e no mercado do negócio, e apresente a opção mundial; não deduza em silêncio. Faça corresponder o idioma do criativo à localização do cliente: texto em espanhol para um negócio de Espanha → ['ES'], espanhol para o México → ['MX'], negócio americano em inglês → ['US']; nunca use ['US'] por predefinição, a menos que o público seja realmente dos Estados Unidos.

• ageMinintegeropcional
• ageMaxintegeropcional
• interestsarrayopcional

  Segmentação opcional por interesses. Cada `{id,name}` TEM de vir de `vibiz_meta_ads_targeting_search` (conjunto de ferramentas de anúncios) nesta sessão. Nunca invente nem reutilize um ID memorizado: o Meta rejeita IDs desatualizados (subcódigo 1487079) e o lançamento falha. Omita o array para lançar com público amplo ou Advantage+, sem interesses.

• creativesarrayobrigatório
• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• campaignIdstringobrigatório

  Campanha proprietária do conjunto de anúncios de ORIGEM. ID da campanha na plataforma Meta (16-18 dígitos) de vibiz_ads_campaigns (action "tree", platform "meta"), campo platformCampaignId. NÃO é um ObjectId do Zernio nem um UUID do Vibiz.

• adSetIdstringobrigatório

  Conjunto de anúncios de origem (ou o que contém `adId`). ID do conjunto de anúncios na plataforma Meta de vibiz_ads_campaigns (action "tree", platform "meta"), campo adSets[].platformAdSetId`.

• adIdstringopcional

  Copie apenas este anúncio (ID do anúncio na plataforma ou no Zernio). Omita para copiar todo o conjunto.

• targetCampaignIdstringopcional

  Campanha de destino. Para copiar um conjunto de anúncios: onde fica (por predefinição, a mesma campanha). Para copiar um anúncio: obrigatório com `targetAdSetId`.

• targetAdSetIdstringopcional

  Apenas para cópias de anúncios: conjunto de anúncios de destino (por predefinição, o mesmo conjunto).

• platformstringopcional

  Predefinição: facebook.

  Valores: facebook, instagram

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• draftIdstringopcional

  Novo rascunho de campanha (do resultado de uma preparação ou cópia).

• campaignIdstringopcional

  platformCampaignId de uma campanha Meta ativa (a respetiva tela no estúdio).

• founderMessagestringopcional

  Palavras do fundador para ESTA alteração, textuais («adiciona pessoas que interagem com o Facebook»). Necessárias se a alteração acrescentar um público: um conjunto separado, o existente como sinal inicial ou apenas mostrar-lhes o existente é uma decisão SUA. Depois de perguntar, as suas palavras + uma nova linha + uma linha por resposta ('<question> <chosen option>'). Nunca parafraseie nem acrescente o que deduziu.

• campaignobjectopcional

  Alterações ao nível da campanha; só mudam os campos enviados.

• adSetsarrayopcional
• adsarrayopcional

  Alterações ao nível do anúncio: texto, CTA, ligação e multimédia (creativeId / imageUrl / videoUrl).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• adIdstringobrigatório

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• adAccountIdstringopcional
• namestringobrigatório

  Nome da campanha (máximo 255).

• goalstringobrigatório

  Objetivo de otimização do conjunto de anúncios: escolha o que corresponde ao que o negócio realmente pretende; NÃO use 'traffic' por predefinição. Para gerar VENDAS/COMPRAS (a maioria dos negócios de comércio eletrónico e ofertas pagas), use 'conversions'. Para captar POTENCIAIS CLIENTES (formulários, registos e pedidos de orçamento), use 'lead_generation'. Use 'traffic' apenas quando o utilizador pretender explicitamente cliques ou visitas: otimiza para cliques baratos, não compradores, pelo que costuma desperdiçar orçamento em negócios focados em vendas. 'engagement'/'awareness'/'video_views' destinam-se apenas ao topo do funil.

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

• budgetAmountnumberobrigatório

  Orçamento diário de todo o conjunto de anúncios. Mínimo de $10/dia.

• budgetTypestringopcional

  No estúdio, só é possível preparar “daily”.

  Valores: daily, lifetime

• currencystringopcional
• creativesarrayobrigatório
• countriesarrayopcional

  OBRIGATÓRIO para uma boa entrega: códigos de país ISO-3166 alpha-2 (por exemplo, ['ES'], ['MX'], ['US'], ['GB']). NÃO deixe vazio: o Meta usa os Estados Unidos por predefinição, o que desperdiça orçamento se o anúncio ou negócio não se destinar a esse mercado. Se o utilizador ainda não indicou onde anunciar, PERGUNTE antes de lançar: recomende países com base na geografia do ICP e no mercado do negócio, e apresente a opção mundial; não deduza em silêncio. Faça corresponder o idioma do criativo à localização do cliente: texto em espanhol para um negócio de Espanha → ['ES'], espanhol para o México → ['MX'], negócio americano em inglês → ['US']; nunca use ['US'] por predefinição, a menos que o público seja realmente dos Estados Unidos.

• ageMinintegeropcional
• ageMaxintegeropcional
• interestsarrayopcional

  Segmentação opcional por interesses. Cada `{id,name}` TEM de vir de `vibiz_meta_ads_targeting_search` (conjunto de ferramentas de anúncios) nesta sessão. Nunca invente nem reutilize um ID memorizado: o Meta rejeita IDs desatualizados (subcódigo 1487079) e o lançamento falha. Omita o array para lançar com público amplo ou Advantage+, sem interesses.

• audienceIdstringopcional
• advantageAudienceintegeropcional
• budgetLevelstringopcional

  Valores: campaign, adset

• specialAdCategoriesarrayopcional
• pixelIdstringopcional
• conversionEventstringopcional
• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• messagestringopcional

  Mensagem do fundador, textual.

• intentstringopcional

  Valores: prospecting, retargeting

• goalstringopcional
• conversionEventstringopcional
• countriesarrayopcional

  Códigos ISO de país, por exemplo, ["US", "CA"].

• dailyBudgetnumberopcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• adIdstringobrigatório

  UUID de `campaign_ad` do Vibiz.

• campaignIdstringobrigatório

  platformCampaignId do Meta.

• adSetIdstringobrigatório

  platformAdSetId do Meta.

• namestringopcional
• linkUrlstringopcional
• callToActionstringopcional

  Somente Meta.

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

• headlinestringopcional
• bodystringopcional
• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• platformstringopcional

  Predefinição: facebook.

  Valores: facebook, instagram

• limitintegeropcional

  Quantos devolver (predefinição: 6).

• fromDatestringopcional

  Data ISO (opcional).

• toDatestringopcional

  Data ISO (opcional).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• pixelIdstringobrigatório

  ID do píxel Meta (dígitos).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• socialAccountIdstringobrigatório

  ESPERA: ID da conta social Zernio (ObjectId Mongo hexadecimal de 24 caracteres). Obtenha-o de `vibiz_social_list_accounts[].id` ou do ancestral de vibiz_ads_accounts (action "list", platform "meta").

• adAccountIdstringobrigatório

  ESPERA: ID da conta de anúncios na plataforma Meta (cadeia que começa por "act_"). Obtenha-o de vibiz_ads_accounts (action "list", platform "meta"), campo id.

• namestringobrigatório

  Nome legível do píxel apresentado no gestor de eventos Meta. Sugestão: inclua o nome do espaço de trabalho para distinguir vários píxeis (por exemplo, 'NeceSera — Píxel do site principal').

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• socialAccountIdstringobrigatório

  ESPERA: ID da conta social Zernio (ObjectId Mongo hexadecimal de 24 caracteres). Obtenha-o de `vibiz_social_list_accounts[].id` ou do ancestral de vibiz_ads_accounts (action "list", platform "meta").

• pixelIdstringobrigatório

  ESPERA: ID da etiqueta de acompanhamento Zernio (devolvido como `tag.id` por `vibiz_meta_ads_pixels_create` (conjunto de ferramentas de anúncios), ou `data[].id` por `vibiz_meta_ads_pixels_list` (conjunto de ferramentas de anúncios)).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• socialAccountIdstringobrigatório

  ESPERA: ID da conta social Zernio (ObjectId Mongo hexadecimal de 24 caracteres). Obtenha-o de `vibiz_social_list_accounts[].id` ou do ancestral de vibiz_ads_accounts (action "list", platform "meta").

• adAccountIdstringopcional

  ESPERA: ID da conta de anúncios na plataforma Meta (cadeia que começa por "act_"). Obtenha-o de vibiz_ads_accounts (action "list", platform "meta"), campo id. OPCIONAL: omita para listar os píxeis de todas as contas de anúncios desta conta social.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• socialAccountIdstringobrigatório

  ESPERA: ID da conta social Zernio (ObjectId Mongo hexadecimal de 24 caracteres). Obtenha-o de `vibiz_social_list_accounts[].id` ou do ancestral de vibiz_ads_accounts (action "list", platform "meta").

• pixelIdstringobrigatório

  ESPERA: ID da etiqueta de acompanhamento Zernio (devolvido como `tag.id` por `vibiz_meta_ads_pixels_create` (conjunto de ferramentas de anúncios), ou `data[].id` por `vibiz_meta_ads_pixels_list` (conjunto de ferramentas de anúncios)).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• socialAccountIdstringobrigatório

  ESPERA: ID da conta social Zernio (ObjectId Mongo hexadecimal de 24 caracteres). Obtenha-o de `vibiz_social_list_accounts[].id` ou do ancestral de vibiz_ads_accounts (action "list", platform "meta").

• pixelIdstringobrigatório

  ESPERA: ID da etiqueta de acompanhamento Zernio (devolvido como `tag.id` por `vibiz_meta_ads_pixels_create` (conjunto de ferramentas de anúncios), ou `data[].id` por `vibiz_meta_ads_pixels_list` (conjunto de ferramentas de anúncios)).

• adAccountIdstringobrigatório

  ESPERA: ID da conta de anúncios na plataforma Meta (cadeia que começa por "act_"). Obtenha-o de vibiz_ads_accounts (action "list", platform "meta"), campo id. É a conta DESTINATÁRIA que receberá acesso, NÃO a conta onde o píxel foi originalmente criado.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• socialAccountIdstringobrigatório

  ESPERA: ID da conta social Zernio (ObjectId Mongo hexadecimal de 24 caracteres). Obtenha-o de `vibiz_social_list_accounts[].id` ou do ancestral de vibiz_ads_accounts (action "list", platform "meta").

• pixelIdstringobrigatório

  ESPERA: ID da etiqueta de acompanhamento Zernio (devolvido como `tag.id` por `vibiz_meta_ads_pixels_create` (conjunto de ferramentas de anúncios), ou `data[].id` por `vibiz_meta_ads_pixels_list` (conjunto de ferramentas de anúncios)).

• aggregationstringopcional

  Dimensão de agregação. Se omitida, usa o valor predefinido do servidor Zernio (event).

  Valores: event, host, url, device_type

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• socialAccountIdstringobrigatório

  ESPERA: ID da conta social Zernio (ObjectId Mongo hexadecimal de 24 caracteres). Obtenha-o de `vibiz_social_list_accounts[].id` ou do ancestral de vibiz_ads_accounts (action "list", platform "meta").

• pixelIdstringobrigatório

  ESPERA: ID da etiqueta de acompanhamento Zernio (devolvido como `tag.id` por `vibiz_meta_ads_pixels_create` (conjunto de ferramentas de anúncios), ou `data[].id` por `vibiz_meta_ads_pixels_list` (conjunto de ferramentas de anúncios)).

• adAccountIdstringobrigatório

  ESPERA: ID da conta de anúncios na plataforma Meta (cadeia que começa por "act_"). Obtenha-o de vibiz_ads_accounts (action "list", platform "meta"), campo id.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• socialAccountIdstringobrigatório

  ESPERA: ID da conta social Zernio (ObjectId Mongo hexadecimal de 24 caracteres). Obtenha-o de `vibiz_social_list_accounts[].id` ou do ancestral de vibiz_ads_accounts (action "list", platform "meta").

• pixelIdstringobrigatório

  ESPERA: ID da etiqueta de acompanhamento Zernio (devolvido como `tag.id` por `vibiz_meta_ads_pixels_create` (conjunto de ferramentas de anúncios), ou `data[].id` por `vibiz_meta_ads_pixels_list` (conjunto de ferramentas de anúncios)).

• namestringopcional
• enableAutomaticMatchingbooleanopcional
• firstPartyCookieStatusstringopcional
• dataUseSettingstringopcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• namestringobrigatório

  Nome da campanha tal como aparece no gestor de anúncios, por exemplo, "{Business} Campanha de potenciais clientes {date} - Vibiz".

• adAccountIdstringopcional

  ID da conta de anúncios Meta ('act_…'); omita para usar a conta selecionada do espaço de trabalho.

• goalstringobrigatório

  O que o fundador pretende da campanha; nunca presuma. Se não tiver sido indicado, pergunte pelas suas próprias palavras («O que pretende conseguir com esta campanha?»). lead_conversion = Potenciais clientes (recolhe contactos interessados na oferta; otimiza para Lead por predefinição, ou Registo concluído / Contacto / Agendamento / Candidatura enviada / Subscrição / Início de teste); conversions = Vendas (encontra pessoas com probabilidade de comprar o produto ou serviço; otimiza para Compra por predefinição, ou Início de pagamento / Adição ao carrinho / Adição de dados de pagamento / Subscrição / Início de teste / Registo concluído); signup = Registos (leva as pessoas a registarem-se ou a criarem uma conta no site; otimiza para Registo concluído por predefinição, ou Subscrição / Início de teste); traffic = Tráfego (envia o maior número possível de pessoas para a página); awareness = Notoriedade (alcança um público amplo e dá a conhecer a marca). lead_generation = Formulário instantâneo Meta cujos contactos nunca chegam ao site ou CRM; apenas quando o fundador pede explicitamente um formulário.

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

• conversionEventstringopcional

  Evento do píxel para o qual os conjuntos de anúncios são otimizados; predefinição para todos os conjuntos (cada um pode indicar o seu com adSets[].conversionEvent). Omita para usar a predefinição do objetivo. Tem de corresponder ao objetivo (Potenciais clientes: LEAD, COMPLETE_REGISTRATION, CONTACT, SCHEDULE, SUBMIT_APPLICATION, SUBSCRIBE, START_TRIAL; Vendas: PURCHASE, INITIATED_CHECKOUT, ADD_TO_CART, ADD_PAYMENT_INFO, SUBSCRIBE, START_TRIAL, COMPLETE_REGISTRATION; Registos: COMPLETE_REGISTRATION, SUBSCRIBE, START_TRIAL); incompatibilidades são recusadas. Só um evento que o píxel tenha recebido pode servir para aprendizagem: consulte ads_pixel_events.

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

• pixelIdstringopcional

  ID do píxel Meta da lista de píxeis; a conta pode ter vários.

• specialAdCategoriesarrayopcional

  OBRIGATÓRIO para empréstimos, crédito, seguros, investimento e banca (FINANCIAL_PRODUCTS_SERVICES), emprego (EMPLOYMENT) e habitação (HOUSING). O Meta impõe então 18-65+ e todos os géneros.

• budgetLevelstringopcional

  'campaign' (predefinição, CBO): um dailyBudget na campanha. 'adset' (ABO): um dailyBudget em cada conjunto de anúncios.

  Valores: campaign, adset

• dailyBudgetnumberopcional

  Orçamento diário da campanha (CBO), expresso em `currency`. Mínimo de 10; abaixo disso, um conjunto de anúncios nunca sai da fase de aprendizagem.

• currencystringopcional

  Código ISO da moeda em que os orçamentos são EXPRESSOS (predefinição: USD). O rascunho é guardado na moeda da conta de anúncios, convertido uma única vez na preparação com as taxas de câmbio do lançamento; assim, dailyBudget/currency do resultado são os valores que o estúdio mostra e o Meta executa.

• landingPageUrlstringopcional

  Destino predefinido para anúncios sem linkUrl. Identifique primeiro o site publicado; nunca presuma {slug}.vibiz.app.

• funnelIdstringopcional

  Um funil Vibiz (o respetivo ID) como destino: o lançamento instala o píxel e acrescenta a atribuição, tal como ao escolher o site no assistente.

• dsaBeneficiarystringopcional

  Meta DSA (UE): entidade jurídica beneficiária. Obrigatória com dsaPayor ao segmentar qualquer país da UE/EEE ou o mundo inteiro. Omita ambos se a conta tiver um anunciante predefinido: o rascunho preenche-os a partir dele; pergunte ao fundador apenas se não existir. Nunca invente um.

• dsaPayorstringopcional

  Meta DSA (UE): entidade jurídica que paga. Normalmente, a mesma que dsaBeneficiary.

• retargetKnownbooleanopcional

  «Todos os que já nos conhecem»: no lançamento, associe todos os públicos Vibiz PRONTOS (visitantes do site, potenciais clientes e pessoas que interagem com a página e o Instagram) a cada conjunto sem includeAudienceIds.

• adSetsarrayobrigatório

  Conjuntos de anúncios da campanha: por predefinição, um conjunto de público amplo; acrescente um de retargeting (includeAudienceIds) ou de interesses quando os públicos diferirem.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• draftIdstringopcional

  Novo rascunho de campanha (do resultado de uma preparação ou cópia).

• campaignIdstringopcional

  platformCampaignId de uma campanha Meta ativa (a respetiva tela no estúdio).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• founderMessagestringopcional

  Palavras do fundador para ESTA alteração, textuais («adiciona pessoas que interagem com o Facebook»). Necessárias se a alteração acrescentar um público: um conjunto separado, o existente como sinal inicial ou apenas mostrar-lhes o existente é uma decisão SUA. Depois de perguntar, as suas palavras + uma nova linha + uma linha por resposta ('<question> <chosen option>'). Nunca parafraseie nem acrescente o que deduziu.

• campaignIdstringobrigatório

  Campanha ativa (platformCampaignId) onde são preparadas as alterações.

• addAdsarrayopcional

  Anúncios a acrescentar a conjuntos existentes.

• addAdSetsarrayopcional

  Novos conjuntos, cada um com o seu próprio público e anúncios.

• copyAdSetIdsarrayopcional

  Conjuntos de anúncios ativos a copiar com os respetivos anúncios.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• socialAccountIdstringobrigatório

  ESPERA: ID da conta social Zernio (ObjectId Mongo hexadecimal de 24 caracteres). Obtenha-o de `vibiz_social_list_accounts[].id`. NÃO é um ID `act_…` do Meta.

• qstringobrigatório

  Texto de pesquisa, por exemplo, «escola privada» ou «São Paulo». Pelo menos 2 caracteres.

• dimensionstringopcional

  Predefinição: 'interest'. Use 'geo' para pesquisar chaves de região/cidade (com geoType + countryCode).

  Valores: interest, geo, behavior, income

• geoTypestringopcional

  Apenas quando dimension=geo. O valor predefinido 'all' pesquisa todos os tipos geográficos de uma vez.

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

• countryCodestringopcional

  ISO-3166 alpha-2 que limita a pesquisa geográfica, por exemplo, "BR". Ignorado na pesquisa de interesses.

• limitintegeropcional

  Número máximo de linhas a devolver (predefinição: 15).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• adIdstringobrigatório
• headlinestringopcional
• bodystringopcional

  Texto principal.

• callToActionstringopcional

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

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• proposalIdstringobrigatório

  ID do cartão de vibiz_list_proposals (conjunto de ferramentas de autonomia).

• statusstringopcional

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

• rejectReasonstringopcional

  Porque foi rejeitada pelo fundador; obrigatório com `rejected`.

• titlestringopcional
• descriptionstringopcional
• reasonstringopcional
• impactstringopcional
• approveLabelstringopcional
• planDayintegeropcional

  Plano contínuo de 3 dias: 1 = hoje, 2 = amanhã, 3 = depois de amanhã. Omita para uma proposta pontual.

• toolsarrayopcional

  Todas as ferramentas de escrita ou subagentes usados na execução do cartão; [] para trabalho somente de leitura. A plataforma calcula `critical` a partir desta lista.

• ownerstringopcional

  Quem executa o cartão: ads-operator para alterações em anúncios, cto para trabalho em sites, researcher, video ou ceo.

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

• planstringopcional

  Somente para o agente, nunca mostrado ao fundador: o plano completo em Markdown que a execução segue e pelo qual é avaliada (escopo, critérios de aceitação, links e riscos).

• areastringopcional

  O domínio do cartão.

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

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• platformstringopcional

  Plataforma a analisar. Omita para todas as plataformas.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• platformstringopcional

  Filtra uma plataforma. Omita para obter o agregado de todas.

• fromDatestringopcional

  Data inicial (YYYY-MM-DD). Padrão: 30 dias atrás.

• toDatestringopcional

  Data final (YYYY-MM-DD). Padrão: hoje.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• platformstringopcional

  Filtra por plataforma (facebook, instagram, linkedin, tiktok etc.). Omita para todas.

• sortBystringopcional

  Métrica para ordenar. Padrão: engagement.

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

• fromDatestringopcional

  Data inicial (YYYY-MM-DD). Padrão: 90 dias atrás.

• toDatestringopcional

  Data final (YYYY-MM-DD). Padrão: hoje.

• limitnumberopcional

  Máximo de publicações a retornar (1-100, padrão 10).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• draftsarrayobrigatório

  Uma entrada por publicação a preparar.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• platformstringopcional

  Plataforma opcional que o utilizador pretende ligar (por exemplo, "x", "instagram"). Aparece como etiqueta; a página de ligações gere todas as plataformas.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• recipientNamestringopcional
• recipientCompanystringopcional
• recipientRolestringopcional
• recipientIndustrystringopcional
• signalsstringopcional

  Sinais de compra ou contexto para personalizar a mensagem.

• senderProductstringopcional

  O que este espaço de trabalho oferece; usado para orientar a proposta.

• channelstringopcional

  Padrão: email.

  Valores: email, linkedin

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• cursorstringopcional

  `nextCursor` da página anterior.

• unreadOnlybooleanopcional
• searchstringopcional
• mailboxIdstringopcional

  Somente esta caixa de correio (de vibiz_email_status, ferramentas de comunicação).

• limitintegeropcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• threadIdstringobrigatório

  De vibiz_email_list_threads (ferramentas de comunicação).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• threadIdstringobrigatório

  De vibiz_email_list_threads (ferramentas de comunicação).

• bodystringobrigatório

  Resposta em texto simples.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• tostringobrigatório
• subjectstringobrigatório
• bodystringobrigatório

  E-mail em texto simples.

• mailboxIdstringopcional

  Caixa de correio que envia (de vibiz_email_status, ferramentas de comunicação); omita para usar a primeira que puder enviar.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• mailboxIdstringobrigatório

  De vibiz_email_status (ferramentas de comunicação).

• senderNamestringobrigatório

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• platformstringopcional

  Filtre por plataforma.

• sortBystringopcional

  Ordene por data ou número de comentários.

  Valores: date, comments

• limitnumberopcional

  Número máximo de publicações a devolver (1-50; predefinição: 10).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• platformstringopcional

  Filtre por plataforma (instagram, facebook, twitter, etc.).

• limitnumberopcional

  Número máximo de conversas a devolver (1-50; predefinição: 10).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• accountIdstringobrigatório

  Conta de Instagram/Facebook onde executar a automatização. Tem de pertencer ao vibiz de destino.

• namestringobrigatório

  Uma etiqueta para a automatização.

• dmMessagestringobrigatório

  A mensagem direta enviada automaticamente a cada pessoa que comenta.

• commentReplystringopcional

  Resposta pública opcional ao próprio comentário.

• keywordsarrayopcional

  Palavras-chave de ativação. OMITIDO ou vazio = é acionada por QUALQUER comentário (responde a todos).

• matchModestringopcional

  Como são comparadas as palavras-chave. Predefinição: "contains".

  Valores: exact, contains

• platformPostIdstringopcional

  Limite a uma publicação (ID do conteúdo na plataforma, de `vibiz_inbox_comments` (conjunto de ferramentas de comunicação)). Omita para toda a conta.

• triggerstringopcional

  Predefinição: "comment". "story_reply" é acionado por respostas a histórias do IG.

  Valores: comment, story_reply

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• automationIdstringobrigatório

  Automatização a eliminar. De `vibiz_inbox_list_comment_automations` (conjunto de ferramentas de comunicação).

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• postIdstringobrigatório

  Publicação cujos comentários serão lidos. De `vibiz_inbox_comments` (conjunto de ferramentas de comunicação).

• accountIdstringobrigatório

  Conta proprietária da publicação (de `vibiz_inbox_comments` (conjunto de ferramentas de comunicação)). Tem de pertencer ao vibiz de destino.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• conversationIdstringobrigatório

  Conversa a ler. De `vibiz_inbox_conversations` (conjunto de ferramentas de comunicação).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• postIdstringobrigatório

  Publicação que contém o comentário.

• commentIdstringobrigatório

  Comentário a que responder.

• accountIdstringobrigatório

  Conta de rede social a partir da qual responder. Tem de pertencer ao vibiz de destino.

• messagestringobrigatório

  Texto da mensagem de resposta.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• postIdstringobrigatório

  Publicação cujos comentários serão respondidos. De `vibiz_inbox_comments` (conjunto de ferramentas de comunicação).

• accountIdstringobrigatório

  Conta a partir da qual responder. Tem de pertencer ao vibiz de destino.

• repliesarrayobrigatório

  Uma entrada por comentário (máx. 50). Cada mensagem deve ser única e adaptada ao contexto.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• postIdstringobrigatório

  Publicação que contém o comentário. De `vibiz_inbox_comments` (conjunto de ferramentas de comunicação).

• commentIdstringobrigatório

  Comentário a cujo autor será enviada a mensagem direta. De `vibiz_inbox_get_comments` (conjunto de ferramentas de comunicação).

• accountIdstringobrigatório

  Conta a partir da qual enviar. Tem de pertencer ao vibiz de destino.

• messagestringobrigatório

  Texto da mensagem direta privada.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• conversationIdstringobrigatório

  Conversa onde enviar.

• accountIdstringobrigatório

  Conta de rede social a partir da qual enviar. Tem de pertencer ao vibiz de destino.

• messagestringobrigatório

  Texto da mensagem.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• automationIdstringobrigatório

  Automatização a ativar ou desativar. De `vibiz_inbox_list_comment_automations` (conjunto de ferramentas de comunicação).

• activebooleanobrigatório

  true = iniciar/retomar, false = parar/pausar.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• channelIdstringopcional

  ID do canal Slack, por exemplo, C0ATX….

• limitintegeropcional

  Número máximo de mensagens por canal.

• daysintegeropcional

  Período retrospetivo em dias.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• querystringopcional

  Filtro por nome do canal sem distinguir maiúsculas de minúsculas.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• channelIdstringobrigatório

  ID do canal Slack.

• textstringobrigatório
• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• memberIdstringobrigatório

  De `teammates` em vibiz_slack_list_channels (conjunto de ferramentas de comunicação).

• textstringobrigatório
• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• channelIdstringobrigatório

  ID do canal Slack.

• tsstringobrigatório

  O ts da mensagem inicial da conversa, por exemplo, 1760000000.123456.

• limitintegeropcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• offerIdstringobrigatório
• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• imageUrlsarrayopcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• refreshbooleanopcional
• pageUrlsarrayopcional

  Páginas específicas a ler. Implica atualizar os dados.

• confirmobjectopcional
• dismissobjectopcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• titlestringobrigatório
• markdownstringobrigatório

  O conteúdo em Markdown (títulos, listas, tabelas).

• documentIdstringopcional

  Edita este documento existente em vez de criar outro.

Parâmetros

• brandobjectobrigatório

  Dados estruturados da marca sintetizados do repositório local. Obrigatório: `companyName`. Os demais campos preenchem WorkspaceBranding.

• workspaceNamestringopcional

  Nome explícito opcional do espaço de trabalho. Se omitido, deriva de `brand.companyName`.

Parâmetros

• websiteUrlstringobrigatório

  URL de um site (https://example.com) ou perfil do Instagram (instagram.com/handle). O URL é validado acessando o site ou extraindo o perfil do Instagram; URLs inacessíveis falham.

• workspaceNamestringopcional

  Nome explícito opcional. Se omitido, deriva do URL ou do conteúdo extraído.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• namestringobrigatório
• titlestringopcional
• descriptionstringopcional
• demographicsobjectopcional
• painPointsarrayopcional
• goalsarrayopcional
• channelsarrayopcional
• landingSlugstringopcional

  Base opcional de slug para a página de destino do ICP.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• titlestringobrigatório
• descriptionstringopcional
• priceCentsintegeropcional

  Valor do Stripe na menor unidade da moeda (2900 = $29 USD, 500 = ¥500 JPY). Defina 0 ou omita para ofertas sem pagamento.

• priceCurrencystringopcional
• iconEmojistringopcional
• imageUrlstringopcional

  URL público da imagem para a miniatura da oferta.

• sourcestringopcional

  Etiqueta de origem. Padrão: 'agent_chat'. Use 'manual' quando o usuário adicionar um produto diretamente ao catálogo.

• scrapeUrlstringopcional

  URL da página de produto original quando a linha foi extraída dela. Armazenado em sourceData para rastreabilidade.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• offerIdstringobrigatório
• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• namestringobrigatório

  Nome curto da persona (por exemplo, «Fundador de SaaS», «Pai ocupado», «Gamer da geração Z»). Obrigatório.

• titlestringopcional

  Cargo ou função opcional que aparece por baixo do nome (por exemplo, «Gestor de marketing numa empresa SaaS B2B com 50 pessoas»).

• descriptionstringopcional

  Resumo opcional de um parágrafo sobre quem é, o que a motiva e como a marca se enquadra na sua vida.

• demographicsobjectopcional

  Bloco demográfico opcional. Todos os campos são cadeias de texto livre.

• painPointsarrayopcional

  Lista opcional de problemas ou frustrações.

• goalsarrayopcional

  Lista opcional de objetivos ou resultados pretendidos.

• channelsarrayopcional

  Lista opcional de canais onde esta persona passa tempo (por exemplo, «TikTok», «LinkedIn», «Reddit r/SaaS»).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• titlestringobrigatório

  Nome da oferta curto e apelativo (máx. ~100 caracteres). Por exemplo, «50% de desconto em tudo», «Teste gratuito de 14 dias», «Pacote inicial de $99».

• descriptionstringopcional

  Detalhes opcionais da oferta: condições, o que está incluído e proposta de valor. Máx. ~500 caracteres.

• priceCentsintegeropcional

  Montante Stripe na unidade monetária menor (9900 = $99.00 USD, 500 = ¥500 JPY). Omita para ofertas gratuitas ou recursos de captação.

• priceCurrencystringopcional

  Código de moeda ISO. Predefinição: "USD".

• typestringopcional

  Tipo de modelo de negócio. Use "generic" em caso de dúvida.

  Valores: software, service, ecommerce, agency, generic

• iconEmojistringopcional

  Um emoji que represente visualmente a oferta. Por exemplo, "🎁", "💰", "🚀".

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• icpIdstringobrigatório

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• querystringopcional

  O que procurar nos documentos carregados, por exemplo, «política de reembolso» ou «preços empresariais». Omita para obter apenas o resumo e a lista de documentos.

• limitnumberopcional

  Número máximo de excertos a devolver (1..25; predefinição: 8).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• offerIdstringobrigatório
• icpIdstringobrigatório

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• categorystringopcional

  Valores: product, lifestyle, team, screenshot, abstract

• limitintegeropcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• limitintegeropcional

  Número máximo de páginas a devolver (predefinição: 20).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• offerIdstringopcional

  Apenas esta oferta (opcional).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• displaybooleanopcional

  Use true quando o utilizador deva ver a galeria de produtos no chat.

• purposestringopcional

  Quando display=true, catalog = explorar produtos; product_picker = escolher um antes de gerar.

  Valores: catalog, product_picker

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• keystringobrigatório

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• keystringobrigatório
• valuestringobrigatório

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• hasProductGroundingbooleanopcional

  Use true apenas se a próxima geração já tiver uma oferta, produto ou imagem de referência concretos. Assim, o estado de preparação do catálogo de comércio eletrónico passa a ser informativo em vez de bloquear.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• namestringobrigatório
• bodyMdstringobrigatório
• kindstringopcional

  Valores: workflow, goal, lesson

• triggerstringopcional

  Apenas fluxos de trabalho: quando se aplica, em prosa.

• statusstringopcional

  Valores: proposed, active, archived

Parâmetros

• tzstringopcional

  Fuso horário IANA (por exemplo, "Asia/Kolkata", "Europe/Rome", "America/New_York"). Predefinição: UTC.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• offerIdstringobrigatório
• icpIdstringobrigatório

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• companyNamestringopcional
• headlinestringopcional
• websiteUrlstringopcional
• logoUrlstringopcional
• logoConversationImageIdstringopcional

  Se o utilizador carregou um logótipo no chat, passe o ID da conversa apresentado como image-N. Nunca copie URLs de anexos para logoUrl.

• colorsobjectopcional
• fontsobjectopcional
• tonestringopcional
• energystringopcional
• targetAudiencestringopcional
• languagestringopcional
• formalitystringopcional

  Valores: formal, informal, neutral

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• icpIdstringobrigatório
• namestringopcional
• titlestringnullopcional
• descriptionstringnullopcional
• demographicsobjectnullopcional
• painPointsarraynullopcional
• goalsarraynullopcional
• channelsarraynullopcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• sectionstringopcional

  Título da secção a substituir. Omita para substituir todo o resumo.

• contentstringobrigatório

  Resumo completo revisto, ou novo corpo de `section` se for indicada uma.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• offerIdstringobrigatório
• titlestringopcional
• descriptionstringopcional
• priceCentsintegeropcional

  Montante Stripe na unidade monetária menor (2900 = $29 USD, 500 = ¥500 JPY).

• priceCurrencystringopcional
• iconEmojistringopcional
• statusstringopcional

  Valores: draft, published, active

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• docstringobrigatório

  Valores: company, member

• memberIdstringopcional

  Obrigatório se doc for 'member'.

• contentstringobrigatório

  Markdown completo revisto do documento escolhido.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• competitorsarrayopcional

  Nomes de marcas ou domínios indicados pelo usuário. Omita para usar os concorrentes salvos (gratuito).

• maxCompetitorsintegeropcional

  Número de concorrentes. Padrão 5; mais apenas se o usuário pedir.

• adsPerCompetitorintegeropcional
• countrystringopcional

  País ISO para uma busca por nome. Padrão: o mercado do espaço de trabalho.

• includeImagesbooleanopcional

  Anexa as imagens dos anúncios como conteúdo visual para você poder vê-las. Padrão true.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• refreshbooleanopcional

  Força uma nova busca em vez de retornar a lista salva. Consome créditos. Padrão false.

• countriesarrayopcional

  Códigos ISO de país para consultar a biblioteca de anúncios, por exemplo, ["US","GB"]. Usados apenas em uma nova busca. Padrão ["US"].

• hintstringopcional

  Indicação opcional de posicionamento para orientar a busca, por exemplo, “focar em ferramentas de criativos de anúncios com IA”. Usada apenas em uma nova busca.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• qstringopcional

  Texto livre buscado na descrição, nas falas, no texto na tela, no arquétipo, na apresentação e nas etiquetas; por exemplo, “apresentação do problema” ou “cuidados com a pele”.

• aspectstringopcional

  Valores: 9:16, 1:1, 16:9

• limitintegeropcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• querystringopcional
• emotionstringopcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• qstringopcional
• limitintegeropcional

Parâmetros

• symbolstringobrigatório

  Símbolo bolsista ou de criptomoeda (BTC, ETH, AAPL, TSLA, ...)

• kindstringopcional

  Tipo de ativo. Predefinição: "auto" (tenta primeiro criptomoedas e depois ações).

  Valores: auto, crypto, stock

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• urlstringobrigatório

  URL público da publicação do TikTok, Instagram, Facebook ou X a ler (por exemplo, https://www.tiktok.com/@user/video/123). O Facebook aceita ligações para publicações, fotografias, reels/vídeos e partilhas (facebook.com/share/…, fb.watch/…), não para páginas.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• querystringobrigatório

  Nicho ou palavra-chave a pesquisar na biblioteca de anúncios Meta. Exemplos: «cereais», «seguro para animais», «barras de proteína», «integração SaaS». Obrigatório para discover; para scrape, obrigatório A MENOS QUE `pageId` esteja definido.

• countrystringopcional

  Código ISO de país, por exemplo, 'US', 'GB', 'DE', 'IT'.

• modestringopcional

  'discover' devolve anunciantes únicos (económico, ~$4). 'scrape' devolve registos completos de anúncios (mais caro, ~$7+ consoante o limite).

  Valores: discover, scrape

• sampleSizeintegeropcional

  Anúncios a amostrar no modo discover. Mais anúncios = mais anunciantes únicos encontrados, mas o custo aumenta linearmente. Ignorado no modo scrape.

• pageIdstringopcional

  ID de página de Facebook de uma resposta anterior de `discover`. Apenas no modo scrape: quando definido, filtra os anúncios desse anunciante (melhor rendimento por dólar do que pesquisar por palavra-chave).

• limitintegeropcional

  Número máximo de anúncios a devolver no modo scrape. Custo linear: limit * ~$0.14. Ignorado no modo discover.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• querystringobrigatório
• limitintegeropcional
• orientationstringopcional

  Valores: landscape, portrait, squarish

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• queriesarrayobrigatório
• limitintegeropcional
• tonestringopcional

  Valores: light, dark

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• nichestringobrigatório

  Tema, nicho ou palavra-chave cujas tendências pesquisar (por exemplo, «cuidados da pele para homens», «ferramentas de produtividade com IA»).

• platformsarrayopcional

  Plataformas a analisar. Predefinição: TikTok e Instagram.

• modestringopcional

  discover = amostra económica; deep = extração maior e mais cara.

  Valores: discover, deep

• confirmbooleanopcional

  Obrigatório para uma extração `deep`: aceita o custo de recolha. Sem isso, um pedido deep devolve uma estimativa prévia em vez de gastar. Ignorado para `discover`.

• daysintegeropcional

  Período de atualidade em dias. Predefinição: 14 (~2 semanas, recomendado). Alargue (por exemplo, 30) para nichos mais lentos ou reduza (por exemplo, 3) para ver o que está em alta agora.

Parâmetros

• urlstringobrigatório

  URL a obter (com ou sem https://)

• includeScreenshotbooleanopcional

  Se deve capturar uma imagem da área visível. Predefinição: true.

Parâmetros

• querystringobrigatório

  Consulta de pesquisa

• sourcesarrayopcional

  Fontes onde pesquisar. Predefinição: ["web", "news"]. Use apenas ["web"] para consultas não relacionadas com notícias e manter a resposta concisa.

• limitnumberopcional

  Número máximo de resultados a devolver (1-10). Predefinição: 5.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• contact_job_titlearrayopcional

  Cargos-alvo, por exemplo, ["CEO", "CMO"].

• contact_not_job_titlearrayopcional

  Cargos a excluir.

• seniority_levelarrayopcional

  Níveis de senioridade, por exemplo, ["c_suite", "vp", "director"].

• contact_locationarrayopcional

  Países ou regiões-alvo, por exemplo, ["United States"].

• company_industryarrayopcional

  Setores (taxonomia do LinkedIn). Para SaaS, passe ["computer software", "internet", "information technology & services"]; o valor literal “saas” está documentado, mas é rejeitado pelo ator.

• company_keywordsarrayopcional

  Palavras-chave que descrevem a empresa.

• company_domainarrayopcional

  Domínios de empresas específicos a segmentar.

• sizearrayopcional

  Faixas de número de funcionários, por exemplo, ["11-50", "51-200"].

• min_revenuestringopcional
• max_revenuestringopcional
• fundingarrayopcional
• email_statusarrayopcional

  O padrão é ["validated"].

• fetch_countnumberopcional

  Número de leads a buscar (10..10000). Execuções pequenas têm um custo fixo desproporcional; prefira >=50.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• emailstringobrigatório

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• leadIdstringobrigatório

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• limitintegeropcional

  Pessoas lidas antes de agrupar (predefinição: 500).

• topNintegeropcional

  Linhas por discriminação (predefinição: 12).

• sampleintegeropcional

  Pessoas individuais devolvidas (predefinição: 25; 0 apenas para contagens).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• limitnumberopcional

  Número máximo de potenciais clientes a mostrar (1..50; predefinição: 24).

• displaybooleanopcional

  Use true quando o utilizador deva ver o quadro de potenciais clientes no chat.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• scopestringopcional

  upcoming = as mais próximas primeiro (predefinição); past = as mais recentes primeiro.

  Valores: upcoming, past

• limitintegeropcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• meetingIdstringobrigatório

  ID da reunião de vibiz_list_meetings (conjunto de ferramentas de CRM).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• daysintegeropcional

  Intervalo em dias (predefinição: 30).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• leadIdstringobrigatório
• statusstringobrigatório

  Valores: new, qualified, contacted, replied, disqualified

• reasonstringobrigatório

  Motivo deste estado: provas concretas, apresentadas na cronologia do CRM.

• notesstringopcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• promptstringobrigatório

  Descreva a página de destino: o que vende, a mensagem principal, a chamada para ação, o público e o tom. O gerador escreve os textos; você só descreve o objetivo. São armazenados no máximo 500 caracteres.

• qualificationbooleanopcional

  Opcional. Defina true para criar um funil de qualificação de leads (questionário de várias etapas e pagamento ou restrição de acesso) em vez de uma única página de destino. Padrão: false.

• creativeIdstringopcional

  ID campaign_ad opcional para usar como imagem principal ou referência da página.

• creativeImageUrlstringopcional

  URL de imagem opcional para usar como imagem principal (alternativa a creativeId).

• allowPartialBrandbooleanopcional

  Permite um rascunho antecipado. Padrão false. Defina true apenas se o usuário pedir explicitamente para gerar antes de concluir a configuração inicial, a marca ou o produto; o resultado pode não seguir a marca.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• funnelIdstringobrigatório

  ID do funil existente a reescrever. Obtenha-o do espaço de trabalho do utilizador (funil recente) ou peça-lhe que crie primeiro um com `vibiz_generate_funnel` (conjunto de ferramentas de sites).

• promptstringobrigatório

  Descreva o fluxo de qualificação ou acesso: que campos recolher, o que a barreira de pagamento protege, que perguntas fazer e para onde leva a chamada à ação. O gerador escreve o seu próprio HTML; descreva o objetivo.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• intentstringobrigatório

  Para que serve a página, por exemplo, «Página de destino do programa de coaching de 12 semanas».

• labelstringopcional

  Duas ou três palavras que deem nome à página.

• headlinestringopcional
• subheadlinestringopcional
• ctaLabelstringopcional

  Texto exato do botão, por exemplo, «Agendar uma chamada».

• navLinksarrayobrigatório

  Duas a quatro palavras de navegação, cada uma correspondente a uma secção DESTA página.

• herostringobrigatório

  O primeiro ecrã em torno do título: onde fica o texto e o que ocupa o restante espaço.

• sectionsarrayobrigatório

  Todas as secções depois do cabeçalho principal, de cima para baixo, terminando com a faixa da chamada à ação final. O rodapé é adicionado automaticamente.

• icpIdstringopcional
• offerIdstringopcional
• requestKeystringopcional

  Chave de idempotência opcional: uma chamada repetida com a mesma chave reutiliza a imagem renderizada em vez de criar outra.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• sitestringopcional

  Valores: source, workspace

• devicesarrayopcional

  Tamanhos de ecrã a devolver (por predefinição, computador e telemóvel).

• pageUrlstringopcional

  Uma página específica do site (por exemplo, a página «Sobre»). Predefinição: o site escolhido.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• includeInFlightbooleanopcional
• includeFailedbooleanopcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• funnelIdstringobrigatório

  ID do funil de vibiz_list_landing_pages (conjunto de ferramentas de sites).

• pathstringopcional

  Caminho público no domínio da organização. `/` = página inicial.

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• funnelIdstringobrigatório

  Funil a rever, de vibiz_list_landing_pages (conjunto de ferramentas de sites).

• intentstringopcional

  O que a página devia fazer, para o avaliador a classificar segundo o objetivo. Se faltar, usa o prompt do próprio funil.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• daysintegeropcional

  Intervalo em dias (predefinição: 7), comparado com o intervalo anterior de igual duração.

• pageLimitintegeropcional

  Número de caminhos a listar com visualizações e visitantes (predefinição: 8). Aumente para encontrar uma página específica.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• namestringobrigatório

  Rótulo curto, por exemplo, 'Revisão da manhã'.

• briefTemplatestringobrigatório

  O que o agente faz a cada ativação: apenas instruções imperativas, sem mencionar a programação.

• assignedTostringopcional

  ID do agente do organograma que executa a tarefa, por exemplo, 'cto'. Padrão: 'ceo'.

• presetstringopcional

  Frequência predefinida. Padrão: diária.

  Valores: hourly, daily, weekly, every_6h

• intervalSecondsintegeropcional

  Intervalo personalizado em segundos. Use a predefinição OU este valor.

• firstRunLocalTimestringopcional

  Hora local da primeira execução no formato 24h, por exemplo, '10:00'.

• timezonestringopcional

  Zona IANA alternativa; por padrão, a do espaço de trabalho. Defina apenas quando o fundador indicar uma.

• enabledbooleanopcional

  O padrão é true.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• routineIdstringobrigatório

  ID da rotina de vibiz_list_routines (ferramentas de autonomia).

• approval_tokenstringopcional

  Somente de vibiz_review_action, depois que a chamada retornar approval_required. Nunca invente, reutilize ou edite um.

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• taskIdstringobrigatório

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• statusarrayopcional

  Apenas cartões com estes estados (opcional).

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• assignedTostringopcional

  Apenas tarefas deste agente, por exemplo, 'cto'.

• statusarrayopcional

  Apenas tarefas com estes estados.

• parentTaskIdstringnullopcional

  ID de uma tarefa para obter as suas subtarefas, ou null para obter apenas tarefas de nível superior.

• planDayintegeropcional

  Apenas tarefas etiquetadas com este dia do plano.

• limitintegeropcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• subjectstringobrigatório

  O que está a ser testado, por exemplo, «assuntos de emails de boas-vindas».

• axisstringobrigatório

  Valores: creative, icp, email, offer

• variantsarrayobrigatório
• panelSizeintegeropcional

  Perfis a entrevistar. Omita para ajustar a quantidade ao orçamento simulado.

• icpIdsarrayopcional

  Limite o painel a estes ICPs (de vibiz_list_icps (conjunto de ferramentas do espaço de trabalho)).

• budgetnumberopcional

  Orçamento publicitário DIÁRIO simulado em dólares inteiros.

• daysintegeropcional

  Dias de duração da campanha simulada (predefinição: 7).

• platformstringopcional

  Origem do tráfego; altera o comportamento dos perfis e o CPM.

  Valores: tiktok, meta, linkedin, email, other

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• rationalestringobrigatório

  Porque está a fazer esta alteração.

• statusUpdatesarrayopcional
• objectiveEditsarrayopcional

Parâmetros

• targetobjectopcional

  Marca em que agir: {"vibiz":"<slug from list_vibiz>"}. Omita quando o conector estiver fixado em uma marca. Nunca use outra marca como alternativa; uma marca não listada exige vibiz_onboard_brand.

• organizationIdstringopcional

  ID da organização Clerk (opcional se a autenticação já estiver limitada à organização)

• routineIdstringobrigatório

  ID da rotina de vibiz_list_routines (ferramentas de autonomia).

• enabledbooleanopcional

  false pausa a rotina; true retoma-a.

• namestringopcional
• briefTemplatestringopcional

  O que o agente faz a cada ativação: apenas instruções imperativas, sem mencionar a programação.

• presetstringopcional

  Valores: hourly, daily, weekly, every_6h

• intervalSecondsintegeropcional