> ## Documentation Index
> Fetch the complete documentation index at: https://docs.so-me.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Referência das ferramentas MCP de redes sociais

> Todas as ferramentas que o servidor MCP do Social media studio expõe, por categoria: publicações, rascunhos, mídia, caixa de entrada, análises, legendas com IA, webhooks e mais.

O servidor MCP do Social media studio expõe **205 ferramentas**, agrupadas abaixo por área. Todas as ferramentas listadas
abaixo estão registradas no endpoint MCP padrão (`https://api.so-me.studio/mcp`) e podem ser chamadas
por qualquer agente autenticado com a sua `X-API-Key`.

> [!NOTE]
>
> As 205 ferramentas estão disponíveis no único endpoint MCP público — **não existe uma superfície
> MCP de administração separada**. Ferramentas como `create_tenant`, `delete_tenant` e `list_tenants` são ferramentas
> comuns do espaço de trabalho, restritas ao usuário autenticado.
>
> Os controllers `admin/mcp-tool-costs` e `api-access/mcp` são rotas do painel protegidas por JWT,
> usadas para ver/editar os **custos em créditos** e os **logs de uso** de cada ferramenta — elas não expõem ferramentas
> MCP adicionais.

> [!NOTE]
>
> Cada chamada de ferramenta consome créditos do plano e conta para o seu limite de requisições por minuto. Consulte
> os custos em tempo de execução com [`list_mcp_tools`](#introspecção-do-mcp-2-ferramentas) e o seu saldo restante com
> [`get_mcp_usage`](#introspecção-do-mcp-2-ferramentas). Faixas de crédito: `1` ler/listar/obter, `2` escrever/alterar/excluir,
> `3` análises, `5` texto com IA, `8` imagem com IA, `10` ações compostas com IA.

## Enums comuns

Estes valores de enum são reutilizados em muitas ferramentas.

> **socialMedia (SOCIAL\_MEDIA\_ENUM)**
>
> `TWITTER`, `INSTAGRAM`, `LINKEDIN`, `LINKEDIN_PAGE`, `FACEBOOK`, `TIKTOK`, `YOUTUBE`,
> `THREADS`, `WHATSAPP`, `DRIBBBLE`, `PINTEREST`

> **platform (PLATFORM\_ENUM)**
>
> `TWITTER`, `INSTAGRAM`, `LINKEDIN`, `FACEBOOK`, `TIKTOK`, `YOUTUBE`, `THREADS`, `DRIBBBLE`,
> `PINTEREST`, `WHATSAPP`, `LINKEDIN_PAGE`

> **status (STATUS\_ENUM)**
>
> `POSTED`, `SCHEDULED`, `PENDING`, `FAILED`, `PENDING_APPROVAL`, `REJECTED`

> **postType (POST\_TYPE\_ENUM)**
>
> `TEXT`, `IMAGE`, `MULTIPLE_IMAGES`, `VIDEO`, `CAROUSEL`, `REEL`, `STORY`

> [!NOTE]
>
> Os padrões de paginação são consistentes entre as ferramentas de listagem: `page` tem padrão `1`, `limit` tem padrão
> `20` (máx. `100`), a menos que uma ferramenta documente outro esquema (por exemplo, baseado em cursor ou offset).

## Publicações (11 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_posts` | Lista as publicações agendadas/publicadas do seu espaço de trabalho | `page?`, `limit?`, `status?`, `socialMedia?` |
| `get_post` | Obtém uma publicação pelo ID | `id` |
| `create_post` | Cria uma nova publicação | `text`, `socialMedia`, `postType?`, `scheduledAt?`, `accountId?` |
| `update_post` | Atualiza uma publicação existente | `id`, `text?`, `scheduledAt?`, `metaData?`, `postType?` |
| `schedule_post` | Agenda uma publicação existente para publicação futura | `id`, `scheduledAt` |
| `unschedule_post` | Remove uma publicação do agendamento (volta para pendente) | `id` |
| `delete_post` | Exclui uma publicação | `id` |
| `retry_post` | Tenta novamente uma publicação com falha (FAILED → PENDING) | `id` |
| `resubmit_post` | Reenvia para aprovação uma publicação rejeitada | `id` |
| `bulk_delete_posts` | Exclui várias publicações de uma vez | `ids` (array) |
| `get_calendar_posts` | Obtém as publicações de um intervalo de datas (visão de calendário) | `startDate`, `endDate` |

## Fluxo de publicação

As ferramentas de escrita aceitam três campos opcionais além de `text`, `fileIds` e `scheduledAt`: `threadParts`, `firstComment` e `tiktok`. As descrições das ferramentas explicam o que cada campo faz; esta seção traz a ordem de operações recomendada para um agente que publica em nome de um usuário.

**1. Verifique a mídia primeiro**

Quando a mídia foi gerada, editada ou escolhida pelo agente, chame `validate_post_media` com os
`targets` pretendidos antes de `create_post` ou `schedule_post`. Ele retorna, por destino, a
largura, a altura, a duração, o codec e a taxa de quadros medidos, os limites configurados e uma string `fix`
para cada divergência. Aplique a correção e valide de novo quando o agente tiver produzido o arquivo; mostre o
relatório e deixe o usuário decidir quando foi ele quem enviou o arquivo. Envie apenas valores medidos — toda
propriedade omitida volta como `needs_review` em vez de aprovada. `get_media_rules` retorna a
tabela completa por plataforma, que é a forma mais barata de já gerar a mídia no tamanho certo.

**2. Confirme os uploads**

`presign_media_upload` reserva arquivos da biblioteca e retorna URLs PUT. Cada PUT deve enviar um
cabeçalho `Content-Type` igual ao `mimetype` declarado, ou o armazenamento responde 403. O upload só está
completo depois que os bytes são armazenados: chame `get_media_file` com `verifyUpload: true` antes de
anexar o arquivo a uma publicação.

**3. TikTok: pergunte ao criador, nunca adivinhe**

O TikTok rejeita qualquer publicação sem nível de privacidade, e só o criador pode escolhê-lo. Chame
`get_tiktok_creator_info` para a conta de destino, ofereça ao usuário apenas os valores retornados em
`privacy_level_options` (uma conta privada não pode escolher `PUBLIC_TO_EVERYONE`), sugira
`PUBLIC_TO_EVERYONE` para uma conta pública, pergunte se os comentários são permitidos e então envie
`{ privacyLevel, allowComments, allowDuet, allowStitch }` no objeto `tiktok`. Uma publicação sem
`tiktok.privacyLevel` é rejeitada com `TIKTOK_PRIVACY_LEVEL_REQUIRED`; um nível que o criador não pode
usar retorna `TIKTOK_PRIVACY_LEVEL_NOT_ALLOWED`. Um aviso `TIKTOK_SETTING_FORCED` significa que o criador
desativou comentários, duetos ou stitch em toda a conta — repita isso ao usuário.

**4. Encadeamentos e primeiros comentários**

`threadParts` cria um encadeamento de várias publicações somente no X, Threads, Bluesky e Mastodon: `text` é
a publicação inicial e `threadParts[0]` é a primeira resposta. A publicação além da inicial é feita com o melhor esforço;
informe `metaData.threadPartWarning` se ele estiver definido e nunca republique a publicação inicial. `firstComment` publica um
comentário sob a publicação (sob a última parte de um encadeamento) no Facebook, Instagram, X, LinkedIn,
Página do LinkedIn, Threads, YouTube, TikTok, Bluesky e Mastodon (o TikTok exige que o acesso a comentários da conta
esteja ativado em Contas). Verifique `capabilities.firstComment` em `list_accounts` antes de
prometer isso — um destino sem suporte ainda publica e retorna um aviso `FIRST_COMMENT_UNSUPPORTED`.
Leia `firstCommentStatus` na publicação antes de dizer que o comentário está no ar.

## Comentários da publicação (5 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_post_comments` | Lista os comentários de uma publicação | `postId`, `page?`, `limit?` |
| `add_post_comment` | Adiciona um comentário a uma publicação | `postId`, `content` |
| `update_post_comment` | Atualiza um comentário existente de uma publicação | `commentId`, `content` |
| `delete_post_comment` | Exclui um comentário de uma publicação | `commentId` |
| `mark_comments_as_read` | Marca todos os comentários de uma publicação como lidos | `postId` |

## Rascunhos (6 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_drafts` | Lista os rascunhos do seu espaço de trabalho | `page?`, `limit?` |
| `get_draft` | Obtém um rascunho pelo ID | `id` |
| `create_draft` | Cria um novo rascunho | `text?`, `title?`, `socialMedia?`, `postType?`, `description?`, `accountId?` |
| `update_draft` | Atualiza um rascunho existente | `id`, `text?`, `title?`, `socialMedia?`, `postType?`, `description?`, `accountId?` |
| `delete_draft` | Exclui um rascunho | `id` |
| `convert_draft` | Converte um rascunho em publicação agendada (o rascunho precisa ter `text`, `socialMedia`, `postType`) | `id`, `scheduledAt?` |

## Contas (3 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_accounts` | Lista as contas de redes sociais conectadas | *(nenhum)* |
| `get_account` | Obtém os detalhes de uma conta social conectada | `id` |
| `disconnect_account` | Desconecta (remove) uma conta social conectada | `id` |

## Mídia (13 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_media` | Lista os arquivos de mídia da sua biblioteca | `page?`, `limit?`, `folderId?` |
| `search_media` | Pesquisa arquivos de mídia pelo nome | `query` |
| `get_media_file` | Obtém um arquivo de mídia pelo ID | `id` |
| `delete_media` | Exclui um arquivo de mídia da biblioteca | `id` |
| `bulk_delete_media` | Exclui vários arquivos de mídia de uma vez | `fileIds` (array) |
| `list_media_folders` | Lista as pastas de mídia da biblioteca | `page?`, `limit?` |
| `create_media_folder` | Cria uma nova pasta de mídia | `name`, `parentId?` |
| `delete_media_folder` | Exclui uma pasta de mídia e o conteúdo dela | `id` |
| `move_media_file` | Move um arquivo de mídia para outra pasta (ou para a raiz) | `id`, `folderId?` |
| `move_media_folder` | Move uma pasta para outra pasta pai (ou para a raiz) | `id`, `parentId?` |
| `rename_media_file` | Renomeia um arquivo de mídia | `id`, `name` |
| `rename_media_folder` | Renomeia uma pasta de mídia | `id`, `name` |
| `presign_media_upload` | Gera URLs PUT pré-assinadas do S3 para enviar mídia à biblioteca | `files` (array of `{filename, mimetype, size?}`), `folderId?` |

## Caixa de entrada (18 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_conversations` | Lista as conversas da caixa de entrada de todas as plataformas conectadas | *(nenhum)* |
| `get_messages` | Obtém as mensagens de uma conversa | `threadId` |
| `reply_to_conversation` | Envia uma resposta em uma conversa | `threadId`, `message` |
| `update_conversation` | Atualiza o status da conversa (`threadStatus`: `OPEN`/`CLOSED`/`ARCHIVED`) | `threadId`, `threadStatus?`, `isSeen?` |
| `delete_conversation` | Exclui uma conversa | `threadId` |
| `list_saved_replies` | Lista os modelos de respostas salvas | `page?`, `limit?` |
| `get_saved_reply` | Obtém um modelo de resposta salva pelo ID | `id` |
| `create_saved_reply` | Cria um novo modelo de resposta salva | `text` |
| `update_saved_reply` | Atualiza uma resposta salva existente | `id`, `text` |
| `delete_saved_reply` | Exclui uma resposta salva | `id` |
| `subscribe_inbox` | Ativa a sincronização da caixa de entrada para uma conta social conectada | `accountId` |
| `unsubscribe_inbox` | Desativa a sincronização da caixa de entrada para uma conta social conectada | `accountId` |
| `edit_inbox_message` | Edita um comentário/mensagem na caixa de entrada social (Facebook/Instagram) | `threadId`, `messageId`, `commentId`, `message`, `pageId`, `attachment?` |
| `delete_inbox_message` | Exclui um comentário/mensagem na caixa de entrada social (Facebook/Instagram) | `threadId`, `messageId`, `commentId`, `pageId` |
| `hide_inbox_message` | Oculta ou reexibe um comentário na caixa de entrada social (Facebook/Instagram) | `threadId`, `messageId`, `commentId`, `pageId`, `hidden?` |
| `preview_bulk_reply` | Mostra uma prévia dos destinatários de uma resposta em massa antes do envio | `threadIds` (array) |
| `create_bulk_reply` | Envia uma resposta (com personalização opcional `{{name}}`) para muitas conversas de DM | `threadIds` (array), `message`, `attachments?` (array) |
| `get_bulk_reply_batch` | Obtém o status e os resultados de um lote de respostas em massa | `batchId` |

## Aprovações (4 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_approvals` | Lista as publicações aguardando aprovação | *(nenhum)* |
| `approve_post` | Aprova uma publicação que aguarda aprovação | `postId`, `comment?` |
| `reject_post` | Rejeita uma publicação que aguarda aprovação | `postId`, `comment` (motivo obrigatório) |
| `update_review_comment` | Atualiza o comentário de revisão/rejeição de uma publicação no fluxo de aprovação | `postId`, `comment` |

## Equipes (6 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_team_members` | Lista todos os membros da equipe do seu espaço de trabalho | *(nenhum)* |
| `invite_team_member` | Convida alguém para o espaço de trabalho (`role`: `owner`/`member`, padrão `member`; `postApproval`: `requires_approval`/`auto_approve`, padrão `requires_approval`, ignorado para proprietários) | `email`, `role?`, `postApproval?` |
| `remove_team_member` | Remove um membro do espaço de trabalho | `memberId` |
| `update_member_role` | Atualiza a função de um membro da equipe (`role`: `owner`/`member`). Um espaço de trabalho pode ter vários proprietários; o último proprietário não pode ser rebaixado. `postApproval` (`requires_approval`/`auto_approve`) é ignorado para proprietários, que sempre publicam sem revisão | `memberId`, `role`, `postApproval?` |
| `list_team_invitations` | Lista os convites de equipe pendentes | `page?`, `limit?` |
| `cancel_team_invitation` | Cancela um convite de equipe pendente | `invitationId` |

## Links na bio (19 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_biolinks` | Lista todas as páginas de link na bio | *(nenhum)* |
| `get_biolink` | Obtém os detalhes de uma página de link na bio | `id` |
| `create_biolink` | Cria uma nova página de link na bio | `slug?`, `displayName?`, `bio?` |
| `update_biolink` | Atualiza uma página de link na bio existente | `id`, `displayName?`, `bio?`, `slug?` |
| `delete_biolink` | Exclui uma página de link na bio | `id` |
| `publish_biolink` | Alterna o estado de publicação de um link na bio | `id` |
| `change_biolink_theme` | Troca um link na bio para um tema predefinido | `id`, `theme` |
| `set_biolink_custom_theme` | Aplica cores de tema personalizadas a um link na bio | `id`, `backgroundColor?`, `textColor?`, `buttonColor?`, `buttonTextColor?` |
| `list_biolink_buttons` | Lista os botões de uma página de link na bio | `biolinkId`, `page?`, `limit?` |
| `create_biolink_button` | Adiciona um botão a uma página de link na bio | `biolinkId`, `type`, `text`, `url?`, `email?`, `phone?`, `icon?`, `isActive?` |
| `update_biolink_button` | Atualiza um botão de uma página de link na bio | `biolinkId`, `buttonId`, `text?`, `url?`, `email?`, `phone?`, `icon?`, `isActive?` |
| `delete_biolink_button` | Exclui um botão de uma página de link na bio | `biolinkId`, `buttonId` |
| `reorder_biolink_buttons` | Reordena os botões de uma página de link na bio | `biolinkId`, `buttonIds` (array) |
| `list_biolink_posts` | Lista as publicações da galeria de um link na bio | `biolinkId` |
| `create_biolink_post` | Adiciona uma publicação de galeria a um link na bio | `biolinkId`, `imageUrl?`, `caption?`, `linkUrl?`, `isVisible?` |
| `update_biolink_post` | Atualiza uma publicação de galeria de um link na bio | `biolinkId`, `postId`, `imageUrl?`, `caption?`, `linkUrl?`, `isVisible?` |
| `delete_biolink_post` | Exclui uma publicação de galeria de um link na bio | `biolinkId`, `postId` |
| `reorder_biolink_posts` | Reordena as publicações da galeria de um link na bio | `biolinkId`, `itemIds` (array) |
| `get_biolink_analytics` | Obtém as análises de uma página de link na bio (visualizações, cliques) | `biolinkId` |

## Conteúdo com IA (10 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `generate_caption` | Gera uma legenda com IA para uma plataforma de rede social | `platform`, `topic`, `tone?` |
| `generate_content` | Gera ou reescreve conteúdo de texto com IA de qualquer tipo (publicação, legenda, hashtag, título, bio, thread, e-mail etc.) | `text`, `type?`, `command?` (`generate`/`rewrite`/`insert`), `tone?`, `platform?`, `customInstruction?` |
| `generate_image` | Gera uma imagem com IA a partir de um prompt de texto | `prompt`, `style?`, `aspectRatio?`, `negativePrompt?`, `provider?`, `numImages?` |
| `generate_and_schedule` | Gera conteúdo com IA, cria uma publicação e a agenda — tudo em uma só chamada | `platform`, `socialMedia`, `topic`, `scheduledAt`, `tone?`, `accountId?` |
| `get_ai_history` | Obtém o histórico de prompts de geração com IA | `page?`, `limit?` |
| `get_ai_credits` | Obtém os saldos e limites de créditos de IA (texto, imagem, vídeo UGC) do plano atual | *(nenhum)* |
| `list_ai_image_providers` | Lista os provedores de geração de imagem com IA permitidos pelo plano atual | *(nenhum)* |
| `list_generated_images` | Lista as imagens geradas com IA, com paginação | `page?`, `limit?` |
| `get_generated_image` | Obtém os detalhes de uma imagem gerada com IA pelo ID | `id` |
| `delete_generated_image` | Exclui uma imagem gerada com IA pelo ID | `id` |

## Vídeo com IA / UGC (9 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `generate_video` | Gera um vídeo UGC com IA | `hookText` (máx. 500 caracteres), `avatarId`, `soundId?`, `productDemoUrl?` |
| `list_videos` | Lista os vídeos UGC gerados | `page?`, `limit?` |
| `get_video` | Obtém um vídeo gerado pelo ID (inclui o status da geração) | `id` |
| `delete_video` | Exclui um vídeo gerado | `id` |
| `list_avatars` | Lista os avatares UGC disponíveis para geração de vídeo | `page?`, `limit?` |
| `list_sounds` | Lista os sons/músicas disponíveis para geração de vídeo | `page?`, `limit?`, `genre?` |
| `get_sound_genres` | Lista os gêneros de som de fundo disponíveis para vídeos UGC | *(nenhum)* |
| `generate_hook_suggestions` | Gera sugestões de gancho/roteiro com IA para vídeos UGC | `topic`, `platform?`, `count?` (padrão 5) |
| `list_ai_video_providers` | Lista os provedores de vídeo UGC com IA permitidos pelo plano atual | *(nenhum)* |

## Análises (26 ferramentas)

### Multiplataforma e por publicação

| Ferramenta | Descrição | Params |
| - | - | - |
| `get_analytics_summary` | Visão geral das análises do espaço de trabalho — contagem de publicações por status e plataforma | *(nenhum)* |
| `get_platform_analytics` | Análises detalhadas de uma conta social conectada específica | `accountId`, `days?` |
| `get_post_analytics` | Análises de uma publicação específica | `postId`, `days?` |

### Análises por plataforma

| Ferramenta | Descrição | Params |
| - | - | - |
| `get_facebook_analytics` | Análises da página do Facebook | `accountId`, `days?` |
| `get_facebook_posts_analytics` | Análises por publicação da página do Facebook | `accountId`, `days?` |
| `get_facebook_videos_analytics` | Análises por vídeo da página do Facebook | `accountId`, `days?` |
| `get_instagram_analytics` | Análises da conta do Instagram | `accountId`, `days?` |
| `get_instagram_media_analytics` | Análises de mídia por publicação do Instagram | `accountId`, `days?` |
| `get_instagram_stories_analytics` | Análises de stories do Instagram | `accountId`, `days?` |
| `get_linkedin_analytics` | Análises da página do LinkedIn | `accountId`, `days?` |
| `get_linkedin_posts_analytics` | Análises por publicação da página do LinkedIn | `accountId`, `days?` |
| `get_youtube_analytics` | Análises do canal do YouTube | `accountId`, `days?` |
| `get_youtube_videos_analytics` | Análises por vídeo do canal do YouTube | `accountId`, `days?` |
| `get_twitter_analytics` | Análises da conta do Twitter/X | `accountId`, `days?` |
| `get_twitter_content_analytics` | Análises de conteúdo do Twitter/X | `accountId`, `days?` |
| `get_whatsapp_analytics` | Análises da conta do WhatsApp Business | `accountId`, `days?` |
| `get_tiktok_analytics` | Análises da conta do TikTok | `accountId`, `days?` |
| `get_bluesky_analytics` | Análises da conta do Bluesky | `accountId`, `days?` |
| `get_mastodon_analytics` | Análises da conta do Mastodon | `accountId`, `days?` |
| `get_reddit_account_analytics` | Análises da conta do Reddit | `accountId`, `days?` |
| `get_reddit_submissions_analytics` | Análises dos envios (publicações) do Reddit | `accountId`, `days?` |
| `get_pinterest_analytics` | Análises da conta do Pinterest | `accountId`, `days?` |
| `get_pinterest_pins_analytics` | Análises por pin do Pinterest | `accountId`, `days?` |
| `get_pinterest_top_pins_analytics` | Pins do Pinterest com melhor desempenho (`sortBy`: `IMPRESSION`/`ENGAGEMENT`/`OUTBOUND_CLICK`/`PIN_CLICK`/`SAVE`) | `accountId`, `days?`, `sortBy?` |
| `get_pinterest_top_video_pins_analytics` | Pins de vídeo do Pinterest com melhor desempenho | `accountId`, `days?`, `sortBy?` |
| `get_gmb_analytics` | Análises do local no Google Business Profile (GMB) | `accountId`, `locationId?`, `days?` |

> [!NOTE]
>
> `days` tem padrão `7` (janela de análise retroativa) em todas as ferramentas de análises.

## Melhor horário para publicar (3 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `get_best_time_recommendations` | Lista as recomendações de melhor horário para publicar de todas as contas conectadas do espaço de trabalho | *(nenhum)* |
| `get_best_time_recommendation` | Obtém a recomendação de melhor horário (mapa de calor + melhores janelas) de uma única conta | `socialAccountId` |
| `recompute_best_time_recommendation` | Recalcula a recomendação de melhor horário de uma conta com base no histórico recente de engajamento | `socialAccountId` |

## Notificações (5 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_notifications` | Lista as notificações no app do usuário autenticado (paginação por cursor) | `category?`, `isRead?`, `limit?`, `cursor?` |
| `get_unread_notification_count` | Obtém a contagem de notificações não lidas, opcionalmente por categoria | `category?` |
| `mark_notification_read` | Marca uma notificação como lida | `id` |
| `mark_all_notifications_read` | Marca todas as notificações (opcionalmente dentro de uma categoria) como lidas | `category?` |
| `archive_notification` | Arquiva (dispensa) uma notificação | `id` |

## Conhecimento / RAG (6 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_knowledge` | Lista os documentos de conhecimento usados pelo assistente de IA (RAG) | `search?`, `tags?` (array), `activeOnly?`, `sortBy?`, `sortOrder?` (`ASC`/`DESC`), `limit?`, `offset?` |
| `get_knowledge` | Obtém um documento de conhecimento com o texto extraído e os metadados | `id` |
| `create_knowledge` | Cria um documento de conhecimento a partir de um arquivo enviado ou de uma nota digitada (`sourceType`: `pdf`/`image`/`text_file`/`note`) | `sourceType`, `title`, `fileId?`, `body?`, `tags?`, `isActive?` |
| `update_knowledge` | Atualiza os metadados ou o corpo da nota de um documento de conhecimento | `id`, `title?`, `tags?`, `isActive?`, `body?` |
| `reprocess_knowledge` | Tenta novamente a extração de um documento de conhecimento PDF/imagem/texto que falhou | `id` |
| `delete_knowledge` | Exclui um documento de conhecimento | `id` |

> [!NOTE]
>
> Em `create_knowledge`, `fileId` é obrigatório para os tipos de origem `pdf`/`image`/`text_file`, e
> `body` é obrigatório para `note`.

## Canva (4 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `get_canva_status` | Verifica se o Canva está conectado para o usuário autenticado | *(nenhum)* |
| `list_canva_designs` | Lista os designs do Canva do usuário (paginado, com busca) | `query?`, `continuation?` |
| `export_canva_design` | Exporta um design do Canva como imagem (assíncrono; retorna o ID de um job de exportação) | `designId` |
| `get_canva_export_status` | Consulta o status de um job de exportação de design do Canva | `exportId` |

## Modelos (3 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_templates` | Lista os modelos de conteúdo disponíveis por categoria (`meme`, `quote_card`, `before_after`, `reaction`, `announcement`, `testimonial`) | `category?`, `page?`, `limit?` |
| `get_template` | Obtém um modelo de conteúdo pelo ID | `id` |
| `render_template` | Renderiza um modelo com os valores de campo informados | `id`, `fields` (object) |

## Ajuda e suporte (5 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `create_ticket` | Cria um ticket de suporte (`priority`: `LOW`/`MEDIUM`/`HIGH`, padrão `MEDIUM`) | `subject`, `message`, `priority?` |
| `list_tickets` | Lista seus tickets de suporte | `page?`, `limit?` |
| `get_ticket` | Obtém um ticket de suporte com detalhes | `id` |
| `send_ticket_message` | Envia uma mensagem em um ticket de suporte | `ticketId`, `message` |
| `list_ticket_messages` | Lista todas as mensagens de um ticket de suporte | `ticketId` |

## WhatsApp (6 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_whatsapp_templates` | Lista os modelos de mensagem do WhatsApp Business | `accountId` |
| `get_whatsapp_template` | Obtém um modelo de mensagem do WhatsApp pelo nome | `accountId`, `templateName` |
| `create_whatsapp_template` | Cria um modelo de mensagem do WhatsApp (enviado para aprovação da Meta) (`category`: `MARKETING`/`UTILITY`/`AUTHENTICATION`) | `accountId`, `name`, `language`, `category`, `components` (array) |
| `delete_whatsapp_template` | Exclui um modelo de mensagem do WhatsApp | `accountId`, `templateName` |
| `send_whatsapp_template` | Envia uma mensagem de modelo do WhatsApp para um destinatário (telefone no formato E.164) | `accountId`, `to`, `templateName`, `languageCode`, `components?` |
| `upload_whatsapp_template_media` | Envia a mídia do cabeçalho (imagem/vídeo/documento) de um modelo | `accountId`, `fileType`, `fileUrl?`, `fileBase64?` |

## Auxiliares de integração (9 ferramentas)

Resolvem destinos específicos de cada plataforma (quadros, canais, subreddits, locais) antes de publicar.

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_pinterest_boards` | Lista os quadros do Pinterest de uma conta (selecione um quadro antes de publicar) | `accountId` |
| `create_pinterest_board` | Cria um novo quadro do Pinterest (`privacy`, por exemplo `PUBLIC`/`SECRET`) | `accountId`, `name`, `description?`, `privacy?` |
| `list_reddit_subreddits` | Lista os subreddits dos quais a conta conectada do Reddit é membro | `accountId` |
| `list_reddit_flairs` | Lista os flairs de publicação disponíveis de um subreddit | `accountId`, `subreddit` |
| `list_gmb_locations` | Lista os locais do Google Business Profile (GMB) de uma conta | `accountId` |
| `list_discord_channels` | Lista os canais do Discord disponíveis para uma conta em modo bot | `accountId` |
| `list_slack_channels` | Lista os canais do Slack de um workspace conectado | `accountId` |
| `list_telegram_chats` | Lista os chats/grupos do Telegram disponíveis para uma conta | `accountId` |
| `get_tiktok_creator_info` | Obtém as informações do criador/conta do TikTok (valida os recursos de publicação) | `accountId` |

## Webhooks (10 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_webhook_subscriptions` | Lista todas as assinaturas de webhook do seu espaço de trabalho | *(nenhum)* |
| `get_webhook_subscription` | Obtém uma assinatura de webhook pelo ID | `id` |
| `create_webhook_subscription` | Cria uma nova assinatura de webhook | `url`, `categories` (array), `description?` |
| `update_webhook_subscription` | Atualiza uma assinatura de webhook existente | `id`, `url?`, `categories?`, `description?`, `isActive?`, `regenerateSecret?` |
| `delete_webhook_subscription` | Exclui uma assinatura de webhook | `id` |
| `test_webhook_subscription` | Envia um ping de teste para uma assinatura de webhook | `id` |
| `list_webhook_deliveries` | Lista os logs de entrega de webhooks (filtrável) | `page?`, `limit?`, `subscriptionId?`, `event?`, `status?`, `category?` |
| `get_webhook_delivery` | Obtém um log de entrega de webhook com o payload completo e o status | `id` |
| `retry_webhook_delivery` | Tenta novamente uma entrega de webhook que falhou | `id` |
| `list_webhook_events` | Lista todos os tipos de evento de webhook disponíveis, por categoria | *(nenhum)* |

> [!NOTE]
>
> As `categories` de webhook aceitam: `post`, `inbox`, `account`, `subscription`, `ai`, `team`, `support`.
> O filtro `status` de entrega aceita: `pending`, `success`, `retrying`, `failed`.

## Planos, faturamento e uso (6 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `get_billing` | Obtém as informações de assinatura e faturamento | *(nenhum)* |
| `get_usage` | Obtém o detalhamento de uso do período de faturamento atual | *(nenhum)* |
| `get_plans` | Obtém o catálogo de planos com preços e visibilidade | *(nenhum)* |
| `get_plan_features` | Obtém a matriz de recursos usando o identificador interno: `solo` (Lite), `team` (Standard), `scale` (Advanced) ou `lifetime` (Lifetime). `hobby` é um plano legado descontinuado | `planName` |
| `get_subscription` | Obtém o status da assinatura atual do espaço de trabalho, o plano e os limites | *(nenhum)* |
| `list_invoices` | Lista as faturas da assinatura atual | *(nenhum)* |

## Indicações (2 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `get_referral_code` | Obtém o código de indicação do usuário autenticado | *(nenhum)* |
| `get_referral_stats` | Obtém o código de indicação, o número de indicações, os créditos ganhos e a URL de compartilhamento | *(nenhum)* |

## Chaves de API (3 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_api_keys` | Lista as chaves de API ativas do espaço de trabalho atual | *(nenhum)* |
| `create_api_key` | Cria uma nova chave de API; a chave completa é retornada uma única vez | `name`, `expiresAt?` |
| `revoke_api_key` | Revoga uma chave de API | `id` |

## Tenants / Espaços de trabalho (4 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `list_tenants` | Lista os espaços de trabalho/tenants a que o usuário autenticado pertence | `page?`, `limit?` |
| `create_tenant` | Cria um novo espaço de trabalho/tenant pertencente ao usuário autenticado | `name`, `description?` |
| `delete_tenant` | Exclui um espaço de trabalho/tenant | `id` |
| `leave_tenant` | Sai de um espaço de trabalho/tenant do qual o usuário é membro | `tenantId?` (padrão: o atual) |

## Perfil e preferências (5 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `get_profile` | Obtém seu perfil de usuário | *(nenhum)* |
| `update_profile` | Atualiza o perfil do usuário autenticado | `name?`, `password?`, `email?` |
| `get_user_preferences` | Obtém as preferências do usuário autenticado (configurações de notificação, fuso horário, preferências de interface) | *(nenhum)* |
| `update_user_preferences` | Atualiza (mescla) as preferências do usuário autenticado | `preferences` (object) |
| `get_current_tenant` | Obtém os detalhes do espaço de trabalho (tenant) ativo no momento | *(nenhum)* |

## Organização (2 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `get_organization` | Obtém os detalhes do espaço de trabalho/organização | *(nenhum)* |
| `update_organization` | Atualiza o espaço de trabalho / organização atual | `name?`, `description?`, `color?` (hex), `timezone?` (IANA) |

## Introspecção do MCP (2 ferramentas)

| Ferramenta | Descrição | Params |
| - | - | - |
| `get_mcp_usage` | Obtém o uso de créditos MCP deste espaço de trabalho, os limites e o detalhamento por ferramenta no período atual | *(nenhum)* |
| `list_mcp_tools` | Lista todas as ferramentas MCP disponíveis e seus custos em créditos | *(nenhum)* |

## Exemplos de uso

```json Criar e agendar uma publicação theme={null}
{
  "name": "create_post",
  "arguments": {
    "text": "Shipping our biggest update yet 🚀 Read the changelog → so-me.studio/changelog",
    "socialMedia": "LINKEDIN_PAGE",
    "postType": "TEXT",
    "scheduledAt": "2026-06-20T14:00:00.000Z",
    "accountId": "acct_01HZ..."
  }
}
```

```json IA: gerar, criar e agendar em uma única chamada theme={null}
{
  "name": "generate_and_schedule",
  "arguments": {
    "platform": "INSTAGRAM",
    "socialMedia": "INSTAGRAM",
    "topic": "5 tips for consistent posting as a solo founder",
    "tone": "engaging",
    "scheduledAt": "2026-06-21T16:30:00.000Z"
  }
}
```

```json Gerar uma imagem com IA (4 variações) theme={null}
{
  "name": "generate_image",
  "arguments": {
    "prompt": "minimalist product launch banner, soft gradient background",
    "style": "illustration",
    "aspectRatio": "16:9",
    "provider": "flux_fal",
    "numImages": 4
  }
}
```

```json Obter análises detalhadas do Instagram theme={null}
{
  "name": "get_instagram_media_analytics",
  "arguments": {
    "accountId": "acct_01HZ...",
    "days": 30
  }
}
```

```json Responder em massa a várias DMs com personalização theme={null}
{
  "name": "create_bulk_reply",
  "arguments": {
    "threadIds": ["thr_1", "thr_2", "thr_3"],
    "message": "Hey {{firstName}}, thanks for reaching out! Here's the link you asked for."
  }
}
```

```json Melhor horário para postar em uma conta theme={null}
{
  "name": "get_best_time_recommendation",
  "arguments": {
    "socialAccountId": "acct_01HZ..."
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.