docs: parity for all translations

This commit is contained in:
tonykipkemboi
2025-10-01 14:11:23 -04:00
parent b5161c320d
commit 9e1dae0746
196 changed files with 3167 additions and 1330 deletions

View File

@@ -1,19 +1,19 @@
---
title: "Introdução"
description: "Referência completa para a API REST do CrewAI Enterprise"
description: "Referência completa para a API REST do CrewAI AMP"
icon: "code"
mode: "wide"
---
# CrewAI Enterprise API
# CrewAI AMP API
Bem-vindo à referência da API do CrewAI Enterprise. Esta API permite que você interaja programaticamente com seus crews implantados, possibilitando a integração com seus aplicativos, fluxos de trabalho e serviços.
Bem-vindo à referência da API do CrewAI AMP. Esta API permite que você interaja programaticamente com seus crews implantados, possibilitando a integração com seus aplicativos, fluxos de trabalho e serviços.
## Início Rápido
<Steps>
<Step title="Obtenha suas credenciais de API">
Navegue até a página de detalhes do seu crew no painel do CrewAI Enterprise e copie seu Bearer Token na aba Status.
Navegue até a página de detalhes do seu crew no painel do CrewAI AMP e copie seu Bearer Token na aba Status.
</Step>
<Step title="Descubra os Inputs Necessários">
@@ -46,7 +46,7 @@ curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \
| **User Bearer Token** | Acesso com escopo de usuário | Permissões limitadas, adequado para operações específicas de usuário |
<Tip>
Você pode encontrar ambos os tipos de token na aba Status da página de detalhes do seu crew no painel do CrewAI Enterprise.
Você pode encontrar ambos os tipos de token na aba Status da página de detalhes do seu crew no painel do CrewAI AMP.
</Tip>
## URL Base
@@ -82,7 +82,7 @@ A API utiliza códigos de status HTTP padrão:
## Testes Interativos
<Info>
**Por que não há botão "Enviar"?** Como cada usuário do CrewAI Enterprise possui sua própria URL de crew, utilizamos o **modo referência** em vez de um playground interativo para evitar confusão. Isso mostra exatamente como as requisições devem ser feitas, sem botões de envio não funcionais.
**Por que não há botão "Enviar"?** Como cada usuário do CrewAI AMP possui sua própria URL de crew, utilizamos o **modo referência** em vez de um playground interativo para evitar confusão. Isso mostra exatamente como as requisições devem ser feitas, sem botões de envio não funcionais.
</Info>
Cada página de endpoint mostra para você:

View File

@@ -4,6 +4,84 @@ description: "Atualizações de produto, melhorias e correções do CrewAI"
icon: "clock"
mode: "wide"
---
<Update label="30 set 2025">
## v1.0.0a1
[Ver release no GitHub](https://github.com/crewAIInc/crewAI/releases/tag/1.0.0a1)
## O que mudou
### Melhorias e correções principais
- Corrigido o controle de permissões do atributo `actions` na configuração de agentes
- Fluxos de CI e publicação atualizados para suportar a nova estrutura de monorepo
- Migração para Python 3.13 e atualização do metadado dos pacotes
### Novos recursos e melhorias
- Novos atributos `apps` e `actions` nos agentes para controles avançados em runtime
- Repositório `crewai-tools` incorporado ao workspace principal (monorepo)
- Versão incrementada para 1.0.0a1 em todos os pacotes (marco alpha)
### Limpeza e infraestrutura
- Novo pipeline de CI com versionamento fixo e estratégia de publicação
- Unificação do código interno para gerenciar múltiplos pacotes
</Update>
<Update label="26 set 2025">
## v0.201.1
[Ver release no GitHub](https://github.com/crewAIInc/crewAI/releases/tag/0.201.1)
## O que mudou
### Melhorias e correções principais
- Provedor de embeddings Watson renomeado para `watsonx` com prefixos de ambiente atualizados
- Compatibilidade do ChromaDB com providers `watsonx` e `voyageai`
### Limpeza e descontinuações
- Padronização dos prefixos de variáveis de ambiente para todos os providers
- Versão do CrewAI atualizada para 0.201.1 com dependências internas revisadas
</Update>
<Update label="24 set 2025">
## v0.201.0
[Ver release no GitHub](https://github.com/crewAIInc/crewAI/releases/tag/0.201.0)
## O que mudou
### Melhorias e correções principais
- Parâmetro `ready` agora é opcional em `_create_reasoning_plan`
- Correções no tratamento de configuração aninhada para embedders
- Suporte ao parâmetro `batch_size` para evitar limites de tokens
- Corrigido o nome do diretório na documentação do Quickstart
- Resolvidos problemas de cache da duração de testes e exportação de eventos
- Adicionada lógica de fallback nas configurações de crew
### Novos recursos e melhorias
- Introduzido gerenciamento de contexto da plataforma thread-safe
- Adicionado comando `crewai uv` para executar `uv` diretamente via CLI
- Possibilidade de marcar traces como falhas para fluxos de observabilidade
- Suporte a tipos de embedding personalizados e migração entre providers
- ChromaDB atualizado para v1.1.0 com correções de compatibilidade e melhorias de tipagem
- Validações compatíveis com Pydantic e reorganização dos grupos de dependências
### Documentação e guias
- Cobertura do changelog atualizada para os releases 0.193.x
- Documentado suporte a metadados de eventos no LLM Guardrail
- Orientações adicionais sobre fallback e visibilidade de parâmetros de configuração
### Limpeza e descontinuações
- Resolvidos problemas de Ruff e MyPy em diversos módulos
- Melhorias nas anotações de tipos e consolidação de utilidades
- Descontinuação de utilitários antigos em favor de importações compatíveis com Pydantic
### Contribuidores
- Novo contribuidor: @qizwiz (primeira contribuição)
</Update>
<Update label="20 set 2025">
## v0.193.2

View File

@@ -20,7 +20,7 @@ Pense em um agente como um membro especializado da equipe com habilidades, compe
</Tip>
<Note type="info" title="Aprimoramento Empresarial: Construtor Visual de Agentes">
O CrewAI Enterprise inclui um Construtor Visual de Agentes, que simplifica a criação e configuração de agentes sem escrever código. Projete seus agentes visualmente e teste-os em tempo real.
O CrewAI AMP inclui um Construtor Visual de Agentes, que simplifica a criação e configuração de agentes sem escrever código. Projete seus agentes visualmente e teste-os em tempo real.
![Visual Agent Builder Screenshot](/images/enterprise/crew-studio-interface.png)

View File

@@ -4,7 +4,7 @@ description: Aprenda a usar o CLI do CrewAI para interagir com o CrewAI.
icon: terminal
mode: "wide"
---
<Warning>A partir da versão 0.140.0, a plataforma CrewAI Enterprise iniciou um processo de migração de seu provedor de login. Como resultado, o fluxo de autenticação via CLI foi atualizado. Usuários que utlizam o Google para fazer login, ou que criaram conta após 3 de julho de 2025 não poderão fazer login com versões anteriores da biblioteca `crewai`.</Warning>
<Warning>A partir da versão 0.140.0, a plataforma CrewAI AMP iniciou um processo de migração de seu provedor de login. Como resultado, o fluxo de autenticação via CLI foi atualizado. Usuários que utlizam o Google para fazer login, ou que criaram conta após 3 de julho de 2025 não poderão fazer login com versões anteriores da biblioteca `crewai`.</Warning>
## Visão Geral
@@ -201,9 +201,9 @@ def crew(self) -> Crew:
### 10. Deploy
Implemente o crew ou flow no [CrewAI Enterprise](https://app.crewai.com).
Implemente o crew ou flow no [CrewAI AMP](https://app.crewai.com).
- **Autenticação**: Você precisa estar autenticado para implementar no CrewAI Enterprise.
- **Autenticação**: Você precisa estar autenticado para implementar no CrewAI AMP.
Você pode fazer login ou criar uma conta com:
```shell Terminal
crewai login
@@ -218,7 +218,7 @@ Implemente o crew ou flow no [CrewAI Enterprise](https://app.crewai.com).
### 11. Gerenciamento de Organização
Gerencie suas organizações no CrewAI Enterprise.
Gerencie suas organizações no CrewAI AMP.
```shell Terminal
crewai org [COMMAND] [OPTIONS]
@@ -242,17 +242,17 @@ crewai org switch <organization_id>
```
<Note>
Você deve estar autenticado no CrewAI Enterprise para usar estes comandos de gerenciamento de organização.
Você deve estar autenticado no CrewAI AMP para usar estes comandos de gerenciamento de organização.
</Note>
- **Criar um deployment** (continuação):
- Vincula o deployment ao respectivo repositório remoto do GitHub (normalmente detectado automaticamente).
- **Implantar o Crew**: Depois de autenticado, você pode implantar seu crew ou flow no CrewAI Enterprise.
- **Implantar o Crew**: Depois de autenticado, você pode implantar seu crew ou flow no CrewAI AMP.
```shell Terminal
crewai deploy push
```
- Inicia o processo de deployment na plataforma CrewAI Enterprise.
- Inicia o processo de deployment na plataforma CrewAI AMP.
- Após a iniciação bem-sucedida, será exibida a mensagem Deployment created successfully! juntamente com o Nome do Deployment e um Deployment ID (UUID) único.
- **Status do Deployment**: Você pode verificar o status do seu deployment com:
@@ -277,7 +277,7 @@ Você deve estar autenticado no CrewAI Enterprise para usar estes comandos de ge
```shell Terminal
crewai deploy remove
```
Isto exclui o deployment da plataforma CrewAI Enterprise.
Isto exclui o deployment da plataforma CrewAI AMP.
- **Comando de Ajuda**: Você pode obter ajuda sobre o CLI com:
```shell Terminal
@@ -285,7 +285,7 @@ Você deve estar autenticado no CrewAI Enterprise para usar estes comandos de ge
```
Isto exibe a mensagem de ajuda para o CLI CrewAI Deploy.
Assista ao vídeo tutorial para uma demonstração passo-a-passo de implantação do seu crew no [CrewAI Enterprise](http://app.crewai.com) usando o CLI.
Assista ao vídeo tutorial para uma demonstração passo-a-passo de implantação do seu crew no [CrewAI AMP](http://app.crewai.com) usando o CLI.
<iframe
className="w-full aspect-video rounded-xl"
@@ -351,7 +351,7 @@ crewai config reset
#### Parâmetros de Configuração Disponíveis
- `enterprise_base_url`: URL base da instância CrewAI Enterprise
- `enterprise_base_url`: URL base da instância CrewAI AMP
- `oauth2_provider`: Provedor OAuth2 usado para autenticação (ex: workos, okta, auth0)
- `oauth2_audience`: Valor de audiência OAuth2, tipicamente usado para identificar a API ou recurso de destino
- `oauth2_client_id`: ID do cliente OAuth2 emitido pelo provedor, usado durante solicitações de autenticação
@@ -368,7 +368,7 @@ Exemplo de saída:
| Parâmetro | Valor | Descrição |
| :------------------- | :---------------------- | :------------------------------------------------------------ |
| enterprise_base_url | https://app.crewai.com | URL base da instância CrewAI Enterprise |
| enterprise_base_url | https://app.crewai.com | URL base da instância CrewAI AMP |
| org_name | Not set | Nome da organização atualmente ativa |
| org_uuid | Not set | UUID da organização atualmente ativa |
| oauth2_provider | workos | Provedor OAuth2 (ex.: workos, okta, auth0) |

View File

@@ -20,7 +20,7 @@ O CrewAI utiliza uma arquitetura de event bus para emitir eventos ao longo do ci
Quando ações específicas ocorrem no CrewAI (como a inicialização de um Crew, um Agent concluindo uma tarefa ou o uso de uma ferramenta), o sistema emite os eventos correspondentes. Você pode registrar handlers para esses eventos para executar código personalizado quando eles acontecerem.
<Note type="info" title="Aprimoramento Enterprise: Prompt Tracing">
O CrewAI Enterprise fornece o recurso Prompt Tracing, que aproveita o sistema de eventos para rastrear, armazenar e visualizar todos os prompts, respostas e metadados associados. Isso proporciona poderosas capacidades de depuração e transparência nas operações dos seus agentes.
O CrewAI AMP fornece o recurso Prompt Tracing, que aproveita o sistema de eventos para rastrear, armazenar e visualizar todos os prompts, respostas e metadados associados. Isso proporciona poderosas capacidades de depuração e transparência nas operações dos seus agentes.
![Prompt Tracing Dashboard](/images/enterprise/traces-overview.png)

View File

@@ -14,7 +14,7 @@ As tarefas fornecem todos os detalhes necessários para sua execução, como des
As tarefas dentro do CrewAI podem ser colaborativas, exigindo que múltiplos agentes trabalhem juntos. Isso é gerenciado por meio das propriedades da tarefa e orquestrado pelo processo do Crew, potencializando o trabalho em equipe e a eficiência.
<Note type="info" title="Aprimoramento Empresarial: Construtor Visual de Tarefas">
O CrewAI Enterprise inclui um Construtor Visual de Tarefas no Crew Studio, que simplifica a criação e o encadeamento de tarefas complexas. Projete seus fluxos de tarefas visualmente e teste-os em tempo real sem necessidade de escrever código.
O CrewAI AMP inclui um Construtor Visual de Tarefas no Crew Studio, que simplifica a criação e o encadeamento de tarefas complexas. Projete seus fluxos de tarefas visualmente e teste-os em tempo real sem necessidade de escrever código.
![Task Builder Screenshot](/images/enterprise/crew-studio-interface.png)

View File

@@ -17,7 +17,7 @@ Isso inclui ferramentas do [CrewAI Toolkit](https://github.com/joaomdmoura/crewa
permitindo desde buscas simples até interações complexas e trabalho em equipe eficiente entre agentes.
<Note type="info" title="Aprimoramento para Empresas: Repositório de Ferramentas">
O CrewAI Enterprise oferece um Repositório de Ferramentas abrangente, com integrações pré-construídas para sistemas empresariais e APIs comuns. Implemente agentes com ferramentas corporativas em minutos em vez de dias.
O CrewAI AMP oferece um Repositório de Ferramentas abrangente, com integrações pré-construídas para sistemas empresariais e APIs comuns. Implemente agentes com ferramentas corporativas em minutos em vez de dias.
O Repositório de Ferramentas Empresariais inclui:
- Conectores pré-construídos para sistemas empresariais populares

View File

@@ -1,180 +0,0 @@
---
title: Integrações
description: "Aplicativos conectados para que seus agentes possam tomar ações."
icon: "plug"
mode: "wide"
---
## Visão Geral
Permita que seus agentes autentiquem com qualquer provedor habilitado para OAuth e tomem ações. Do Salesforce e HubSpot ao Google e GitHub, você conta com mais de 16 serviços integrados.
<Frame>
![Integrações](/images/enterprise/crew_connectors.png)
</Frame>
## Integrações Suportadas
### **Comunicação & Colaboração**
- **Gmail** - Gerencie e-mails e rascunhos
- **Slack** - Notificações e alertas do workspace
- **Microsoft** - Integração com Office 365 e Teams
### **Gerenciamento de Projetos**
- **Jira** - Rastreamento de issues e gerenciamento de projetos
- **ClickUp** - Gerenciamento de tarefas e produtividade
- **Asana** - Coordenação de tarefas e projetos de equipe
- **Notion** - Gerenciamento de páginas e bases de dados
- **Linear** - Gerenciamento de projetos de software e bugs
- **GitHub** - Gerenciamento de repositórios e issues
### **Gestão de Relacionamento com o Cliente**
- **Salesforce** - Gerenciamento de contas e oportunidades de CRM
- **HubSpot** - Gestão de pipeline de vendas e contatos
- **Zendesk** - Administração de chamados de suporte ao cliente
### **Negócios & Finanças**
- **Stripe** - Processamento de pagamentos e gerenciamento de clientes
- **Shopify** - Gestão de loja de e-commerce e produtos
### **Produtividade & Armazenamento**
- **Google Sheets** - Sincronização de dados de planilhas
- **Google Calendar** - Gerenciamento de eventos e agendas
- **Box** - Armazenamento de arquivos e gerenciamento de documentos
e mais estão por vir!
## Pré-requisitos
Antes de usar as Integrações de Autenticação, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com). Você pode começar com uma avaliação gratuita.
## Configurando Integrações
### 1. Conecte sua Conta
1. Acesse o [CrewAI Enterprise](https://app.crewai.com)
2. Vá até a aba **Integrações** - https://app.crewai.com/crewai_plus/connectors
3. Clique em **Conectar** no serviço desejado na seção Integrações de Autenticação
4. Complete o fluxo de autenticação OAuth
5. Conceda as permissões necessárias para seu caso de uso
6. Pronto! Obtenha seu Token Enterprise do [CrewAI Enterprise](https://app.crewai.com) na aba **Integration**
<Frame>
![Integrações](/images/enterprise/enterprise_action_auth_token.png)
</Frame>
### 2. Instale as Ferramentas de Integração
Tudo o que você precisa é da versão mais recente do pacote `crewai-tools`.
```bash
uv add crewai-tools
```
## Exemplos de Uso
### Uso Básico
<Tip>
Todos os serviços nos quais você estiver autenticado estarão disponíveis como ferramentas. Portanto, tudo que você precisa fazer é adicionar o `CrewaiEnterpriseTools` ao seu agente e pronto.
</Tip>
```python
from crewai import Agent, Task, Crew
from crewai_tools import CrewaiEnterpriseTools
# Obtenha ferramentas enterprise (a ferramenta Gmail será incluída)
ferramentas_enterprise = CrewaiEnterpriseTools(
enterprise_token="seu_token_enterprise"
)
# imprima as ferramentas
printf(ferramentas_enterprise)
# Crie um agente com capacidades do Gmail
agente_email = Agent(
role="Gerente de E-mails",
goal="Gerenciar e organizar comunicações por e-mail",
backstory="Um assistente de IA especializado em gestão de e-mails e comunicação.",
tools=ferramentas_enterprise
)
# Tarefa para enviar um e-mail
tarefa_email = Task(
description="Redigir e enviar um e-mail de acompanhamento para john@example.com sobre a atualização do projeto",
agent=agente_email,
expected_output="Confirmação de que o e-mail foi enviado com sucesso"
)
# Execute a tarefa
crew = Crew(
agents=[agente_email],
tasks=[tarefa_email]
)
# Execute o crew
crew.kickoff()
```
### Filtrando Ferramentas
```python
from crewai_tools import CrewaiEnterpriseTools
enterprise_tools = CrewaiEnterpriseTools(
actions_list=["gmail_find_email"] # apenas a ferramenta gmail_find_email estará disponível
)
gmail_tool = enterprise_tools["gmail_find_email"]
agente_gmail = Agent(
role="Gerente do Gmail",
goal="Gerenciar comunicações e notificações do gmail",
backstory="Um assistente de IA que ajuda a coordenar comunicações no gmail.",
tools=[gmail_tool]
)
tarefa_notificacao = Task(
description="Encontrar o e-mail de john@example.com",
agent=agente_gmail,
expected_output="E-mail encontrado de john@example.com"
)
# Execute a tarefa
crew = Crew(
agents=[agente_gmail],
tasks=[tarefa_notificacao]
)
```
## Melhores Práticas
### Segurança
- **Princípio do Menor Privilégio**: Conceda apenas as permissões mínimas exigidas para as tarefas dos seus agentes
- **Auditorias Regulares**: Revise periodicamente as integrações conectadas e suas permissões
- **Credenciais Seguras**: Nunca insira credenciais diretamente no código; utilize o fluxo seguro de autenticação do CrewAI
### Filtrando Ferramentas
Em um crew implantado, você pode especificar quais ações estão disponíveis para cada integração a partir da página de configurações do serviço ao qual você se conectou.
<Frame>
![Integrações](/images/enterprise/filtering_enterprise_action_tools.png)
</Frame>
### Implantações com Escopo para organizações multiusuário
Você pode implantar seu crew e associar cada integração a um usuário específico. Por exemplo, um crew que se conecta ao Google pode usar a conta do Gmail de um usuário específico.
<Tip>
Isso é útil para organizações multiusuário, onde você deseja direcionar a integração para um usuário específico.
</Tip>
Use o `user_bearer_token` para direcionar a integração a um usuário específico; assim, quando o crew for iniciado, ele usará o bearer token desse usuário para autenticar com a integração. Se o usuário não estiver logado, o crew não utilizará nenhuma integração conectada. Use o bearer token padrão para autenticar com as integrações que estão sendo implantadas com o crew.
<Frame>
![Integrações](/images/enterprise/user_bearer_token.png)
</Frame>
### Precisa de Ajuda?
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
Entre em contato com nosso time de suporte para assistência com a configuração de integrações ou solução de problemas.
</Card>

View File

@@ -7,10 +7,10 @@ mode: "wide"
## Visão Geral
O RBAC no CrewAI Enterprise permite gerenciar acesso de forma segura e escalável combinando **funções em nível de organização** com **controles de visibilidade em nível de automação**.
O RBAC no CrewAI AMP permite gerenciar acesso de forma segura e escalável combinando **funções em nível de organização** com **controles de visibilidade em nível de automação**.
<Frame>
<img src="/images/enterprise/users_and_roles.png" alt="Visão geral de RBAC no CrewAI Enterprise" />
<img src="/images/enterprise/users_and_roles.png" alt="Visão geral de RBAC no CrewAI AMP" />
</Frame>
@@ -28,7 +28,7 @@ A configuração de usuários e funções é feita em Settings → Roles.
<Steps>
<Step title="Abrir Roles">
Vá em <b>Settings → Roles</b> no CrewAI Enterprise.
Vá em <b>Settings → Roles</b> no CrewAI AMP.
</Step>
<Step title="Escolher a função">
Use <b>Owner</b> ou <b>Member</b>, ou clique em <b>Create role</b> para criar uma função personalizada.
@@ -93,7 +93,7 @@ O owner sempre possui acesso. Em modo privado, somente usuários/funções na wh
</Tip>
<Frame>
<img src="/images/enterprise/visibility.png" alt="Configuração de visibilidade no CrewAI Enterprise" />
<img src="/images/enterprise/visibility.png" alt="Configuração de visibilidade no CrewAI AMP" />
</Frame>

View File

@@ -173,10 +173,10 @@ Ferramentas & Integrações é o hub central para conectar aplicações de terce
## Ferramentas Internas
Crie ferramentas localmente, publique no Repositório de Ferramentas da CrewAI Enterprise e use nos seus agentes.
Crie ferramentas localmente, publique no Repositório de Ferramentas da CrewAI AMP e use nos seus agentes.
<Tip>
Antes de executar os comandos abaixo, faça login na sua conta CrewAI Enterprise:
Antes de executar os comandos abaixo, faça login na sua conta CrewAI AMP:
```bash
crewai login
```

View File

@@ -11,7 +11,7 @@ Traces fornecem visibilidade abrangente sobre as execuções dos seus crews, aju
## O que são Traces?
Traces no CrewAI Enterprise são registros detalhados de execução que capturam todos os aspectos da operação do seu crew, desde as entradas iniciais até as saídas finais. Eles registram:
Traces no CrewAI AMP são registros detalhados de execução que capturam todos os aspectos da operação do seu crew, desde as entradas iniciais até as saídas finais. Eles registram:
- Pensamentos e raciocínio do agente
- Detalhes da execução das tarefas
@@ -28,7 +28,7 @@ Traces no CrewAI Enterprise são registros detalhados de execução que capturam
<Steps>
<Step title="Navegue até a aba Traces">
No seu painel do CrewAI Enterprise, clique em **Traces** para ver todos os registros de execução.
No seu painel do CrewAI AMP, clique em **Traces** para ver todos os registros de execução.
</Step>
<Step title="Selecione uma Execução">
@@ -143,5 +143,5 @@ Traces são indispensáveis para solucionar problemas nos seus crews:
</Steps>
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
Entre em contato com nossa equipe de suporte para assistência com análise de traces ou outros recursos do CrewAI Enterprise.
Entre em contato com nossa equipe de suporte para assistência com análise de traces ou outros recursos do CrewAI AMP.
</Card>

View File

@@ -7,7 +7,7 @@ mode: "wide"
## Visão Geral
O Enterprise Event Streaming permite que você receba atualizações em tempo real via webhook sobre suas crews e flows implantados no CrewAI Enterprise, como chamadas de modelo, uso de ferramentas e etapas do flow.
O Enterprise Event Streaming permite que você receba atualizações em tempo real via webhook sobre suas crews e flows implantados no CrewAI AMP, como chamadas de modelo, uso de ferramentas e etapas do flow.
## Uso

View File

@@ -1,11 +1,11 @@
---
title: "Visão Geral de Triggers"
description: "Entenda como os triggers da CrewAI Enterprise funcionam, como gerenciá-los e onde encontrar playbooks específicos de integração"
description: "Entenda como os triggers da CrewAI AMP funcionam, como gerenciá-los e onde encontrar playbooks específicos de integração"
icon: "bolt"
mode: "wide"
---
Os triggers da CrewAI Enterprise conectam suas automações a eventos em tempo real nas ferramentas que sua equipe já usa. Em vez de fazer polling ou depender de execuções manuais, os triggers escutam mudanças — novos emails, atualizações de calendário, alterações no CRM — e iniciam imediatamente a crew ou flow que você definiu.
Os triggers da CrewAI AMP conectam suas automações a eventos em tempo real nas ferramentas que sua equipe já usa. Em vez de fazer polling ou depender de execuções manuais, os triggers escutam mudanças — novos emails, atualizações de calendário, alterações no CRM — e iniciam imediatamente a crew ou flow que você definiu.
<iframe
className="w-full aspect-video rounded-xl"
@@ -214,6 +214,6 @@ Os triggers transformam suas implantações CrewAI em sistemas orientados por ev
<Callout icon="github" title="Exemplos na prática">
<a href="https://github.com/crewAIInc/crewai-enterprise-trigger-examples">
Repositório CrewAI Enterprise Trigger Examples
Repositório CrewAI AMP Trigger Examples
</a>
</Callout>

View File

@@ -20,7 +20,7 @@ Este guia orienta você na conexão do Azure OpenAI com o Crew Studio para opera
</Step>
<Step title="Configure a Conexão Enterprise do CrewAI">
4. Em outra aba, abra `CrewAI Enterprise > LLM Connections`. Dê um nome à sua LLM Connection, selecione Azure como provedor e escolha o mesmo modelo que você selecionou no Azure.
4. Em outra aba, abra `CrewAI AMP > LLM Connections`. Dê um nome à sua LLM Connection, selecione Azure como provedor e escolha o mesmo modelo que você selecionou no Azure.
5. Na mesma página, adicione as variáveis de ambiente do passo 3:
- Uma chamada `AZURE_DEPLOYMENT_TARGET_URL` (usando o Target URI). A URL deve ser parecida com: https://your-deployment.openai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-08-01-preview
- Outra chamada `AZURE_API_KEY` (usando a Key).
@@ -28,7 +28,7 @@ Este guia orienta você na conexão do Azure OpenAI com o Crew Studio para opera
</Step>
<Step title="Defina Configurações Padrão">
7. Em `CrewAI Enterprise > Settings > Defaults > Crew Studio LLM Settings`, defina a nova LLM Connection e o modelo como padrão.
7. Em `CrewAI AMP > Settings > Defaults > Crew Studio LLM Settings`, defina a nova LLM Connection e o modelo como padrão.
</Step>
<Step title="Configure o Acesso à Rede">

View File

@@ -7,7 +7,7 @@ mode: "wide"
## Visão Geral
[CrewAI Enterprise](https://app.crewai.com) simplifica o processo de **criação**, **implantação** e **gerenciamento** dos seus agentes de IA em ambientes de produção.
[CrewAI AMP](https://app.crewai.com) simplifica o processo de **criação**, **implantação** e **gerenciamento** dos seus agentes de IA em ambientes de produção.
## Primeiros Passos

View File

@@ -1,12 +1,12 @@
---
title: "Deploy Crew"
description: "Implantando um Crew na CrewAI Enterprise"
description: "Implantando um Crew na CrewAI AMP"
icon: "rocket"
mode: "wide"
---
<Note>
Depois de criar um crew localmente ou pelo Crew Studio, o próximo passo é implantá-lo na plataforma CrewAI Enterprise. Este guia cobre múltiplos métodos de implantação para ajudá-lo a escolher a melhor abordagem para o seu fluxo de trabalho.
Depois de criar um crew localmente ou pelo Crew Studio, o próximo passo é implantá-lo na plataforma CrewAI AMP. Este guia cobre múltiplos métodos de implantação para ajudá-lo a escolher a melhor abordagem para o seu fluxo de trabalho.
</Note>
## Pré-requisitos
@@ -39,10 +39,10 @@ A CLI fornece a maneira mais rápida de implantar crews desenvolvidos localmente
</Step>
<Step title="Autentique-se na Plataforma Enterprise">
Primeiro, você precisa autenticar sua CLI com a plataforma CrewAI Enterprise:
Primeiro, você precisa autenticar sua CLI com a plataforma CrewAI AMP:
```bash
# Se já possui uma conta CrewAI Enterprise, ou deseja criar uma:
# Se já possui uma conta CrewAI AMP, ou deseja criar uma:
crewai login
```
@@ -124,7 +124,7 @@ O CrewAI CLI oferece vários comandos para gerenciar suas implantações:
## Opção 2: Implantar Diretamente pela Interface Web
Você também pode implantar seus crews diretamente pela interface web da CrewAI Enterprise conectando sua conta do GitHub. Esta abordagem não requer utilizar a CLI na sua máquina local.
Você também pode implantar seus crews diretamente pela interface web da CrewAI AMP conectando sua conta do GitHub. Esta abordagem não requer utilizar a CLI na sua máquina local.
<Steps>
@@ -134,9 +134,9 @@ Você também pode implantar seus crews diretamente pela interface web da CrewAI
</Step>
<Step title="Conectando o GitHub ao CrewAI Enterprise">
<Step title="Conectando o GitHub ao CrewAI AMP">
1. Faça login em [CrewAI Enterprise](https://app.crewai.com)
1. Faça login em [CrewAI AMP](https://app.crewai.com)
2. Clique no botão "Connect GitHub"
<Frame>
@@ -190,7 +190,7 @@ Você também pode implantar seus crews diretamente pela interface web da CrewAI
## ⚠️ Requisitos de Segurança para Variáveis de Ambiente
<Warning>
**Importante**: A CrewAI Enterprise possui restrições de segurança sobre os nomes de variáveis de ambiente que podem causar falha na implantação caso não sejam seguidas.
**Importante**: A CrewAI AMP possui restrições de segurança sobre os nomes de variáveis de ambiente que podem causar falha na implantação caso não sejam seguidas.
</Warning>
### Padrões de Variáveis de Ambiente Bloqueados

View File

@@ -1,6 +1,6 @@
---
title: "Ativar Crew Studio"
description: "Ativando o Crew Studio no CrewAI Enterprise"
description: "Ativando o Crew Studio no CrewAI AMP"
icon: "comments"
mode: "wide"
---
@@ -24,7 +24,7 @@ Com o Crew Studio, você pode:
- Selecionar as ferramentas apropriadas
- Configurar os inputs necessários
- Gerar código para download e personalização
- Fazer deploy diretamente na plataforma CrewAI Enterprise
- Fazer deploy diretamente na plataforma CrewAI AMP
## Etapas de Configuração
@@ -32,7 +32,7 @@ Antes de começar a usar o Crew Studio, você precisa configurar suas conexões
<Steps>
<Step title="Configurar a Conexão LLM">
Acesse a aba **LLM Connections** no painel do CrewAI Enterprise e crie uma nova conexão LLM.
Acesse a aba **LLM Connections** no painel do CrewAI AMP e crie uma nova conexão LLM.
<Note>
Sinta-se à vontade para utilizar qualquer provedor LLM suportado pelo CrewAI.
@@ -82,7 +82,7 @@ Agora que você configurou sua conexão LLM e os padrões, está pronto para com
<Steps>
<Step title="Acessar o Studio">
Navegue até a seção **Studio** no painel do CrewAI Enterprise.
Navegue até a seção **Studio** no painel do CrewAI AMP.
</Step>
<Step title="Iniciar uma Conversa">
@@ -110,7 +110,7 @@ Agora que você configurou sua conexão LLM e os padrões, está pronto para com
Quando estiver satisfeito com a configuração, você pode:
- Baixar o código gerado para personalização local
- Fazer deploy do crew diretamente na plataforma CrewAI Enterprise
- Fazer deploy do crew diretamente na plataforma CrewAI AMP
- Modificar a configuração e gerar o crew novamente
</Step>
@@ -162,5 +162,5 @@ Veja um fluxo de trabalho típico para criação de um crew com o Crew Studio:
</Steps>
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
Entre em contato com nossa equipe de suporte para obter assistência com o Crew Studio ou qualquer outro recurso do CrewAI Enterprise.
Entre em contato com nossa equipe de suporte para obter assistência com o Crew Studio ou qualquer outro recurso do CrewAI AMP.
</Card>

View File

@@ -0,0 +1,85 @@
---
title: "Gmail Trigger"
description: "Trigger automations when Gmail events occur (e.g., new emails, labels)."
icon: "envelope"
mode: "wide"
---
## Overview
Use the Gmail Trigger to kick off your deployed crews when Gmail events happen in connected accounts, such as receiving a new email or messages matching a label/filter.
<Tip>
Make sure Gmail is connected in Tools & Integrations and the trigger is enabled for your deployment.
</Tip>
## Enabling the Gmail Trigger
1. Open your deployment in CrewAI AMP
2. Go to the **Triggers** tab
3. Locate **Gmail** and switch the toggle to enable
<Frame>
<img src="/images/enterprise/trigger-selected.png" alt="Enable or disable triggers with toggle" />
</Frame>
## Example: Process new emails
When a new email arrives, the Gmail Trigger will send the payload to your Crew or Flow. Below is a Crew example that parses and processes the trigger payload.
```python
@CrewBase
class GmailProcessingCrew:
@agent
def parser(self) -> Agent:
return Agent(
config=self.agents_config['parser'],
)
@task
def parse_gmail_payload(self) -> Task:
return Task(
config=self.tasks_config['parse_gmail_payload'],
agent=self.parser(),
)
@task
def act_on_email(self) -> Task:
return Task(
config=self.tasks_config['act_on_email'],
agent=self.parser(),
)
```
The Gmail payload will be available via the standard context mechanisms. See the payload samples repository for structure and fields.
### Sample payloads & crews
The [CrewAI AMP Trigger Examples repository](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail) includes:
- `new-email-payload-1.json` / `new-email-payload-2.json` — production-style new message alerts with matching crews in `new-email-crew.py`
- `thread-updated-sample-1.json` — follow-up messages on an existing thread, processed by `gmail-alert-crew.py`
Use these samples to validate your parsing logic locally before wiring the trigger to your live Gmail accounts.
## Monitoring Executions
Track history and performance of triggered runs:
<Frame>
<img src="/images/enterprise/list-executions.png" alt="List of executions triggered by automation" />
</Frame>
## Payload Reference
See the sample payloads and field descriptions:
<Card title="Gmail samples in Trigger Examples Repo" href="https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail" icon="envelopes-bulk">
Gmail samples in Trigger Examples Repo
</Card>
## Troubleshooting
- Ensure Gmail is connected in Tools & Integrations
- Verify the Gmail Trigger is enabled on the Triggers tab
- Check the execution logs and confirm the payload is passed as `crewai_trigger_payload`

View File

@@ -0,0 +1,65 @@
---
title: "Google Calendar Trigger"
description: "Kick off crews when Google Calendar events are created, updated, or cancelled"
icon: "calendar"
mode: "wide"
---
## Overview
Use the Google Calendar trigger to launch automations whenever calendar events change. Common use cases include briefing a team before a meeting, notifying stakeholders when a critical event is cancelled, or summarizing daily schedules.
<Tip>
Make sure Google Calendar is connected in **Tools & Integrations** and enabled for the deployment you want to automate.
</Tip>
## Enabling the Google Calendar Trigger
1. Open your deployment in CrewAI AMP
2. Go to the **Triggers** tab
3. Locate **Google Calendar** and switch the toggle to enable
<Frame>
<img src="/images/enterprise/calendar-trigger.png" alt="Enable or disable triggers with toggle" />
</Frame>
## Example: Summarize meeting details
The snippet below mirrors the `calendar-event-crew.py` example in the trigger repository. It parses the payload, analyses the attendees and timing, and produces a meeting brief for downstream tools.
```python
from calendar_event_crew import GoogleCalendarEventTrigger
crew = GoogleCalendarEventTrigger().crew()
result = crew.kickoff({
"crewai_trigger_payload": calendar_payload,
})
print(result.raw)
```
Use `crewai_trigger_payload` exactly as it is delivered by the trigger so the crew can extract the proper fields.
## Sample payloads & crews
The [Google Calendar examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_calendar) show how to handle multiple event types:
- `new-event.json` → standard event creation handled by `calendar-event-crew.py`
- `event-updated.json` / `event-started.json` / `event-ended.json` → in-flight updates processed by `calendar-meeting-crew.py`
- `event-canceled.json` → cancellation workflow that alerts attendees via `calendar-meeting-crew.py`
- Working location events use `calendar-working-location-crew.py` to extract on-site schedules
Each crew transforms raw event metadata (attendees, rooms, working locations) into the summaries your teams need.
## Monitoring Executions
The **Executions** list in the deployment dashboard tracks every triggered run and surfaces payload metadata, output summaries, and errors.
<Frame>
<img src="/images/enterprise/list-executions.png" alt="List of executions triggered by automation" />
</Frame>
## Troubleshooting
- Ensure the correct Google account is connected and the trigger is enabled
- Confirm your workflow handles all-day events (payloads use `start.date` and `end.date` instead of timestamps)
- Check execution logs if reminders or attendee arrays are missing—calendar permissions can limit fields in the payload

View File

@@ -0,0 +1,61 @@
---
title: "Google Drive Trigger"
description: "Respond to Google Drive file events with automated crews"
icon: "folder"
mode: "wide"
---
## Overview
Trigger your automations when files are created, updated, or removed in Google Drive. Typical workflows include summarizing newly uploaded content, enforcing sharing policies, or notifying owners when critical files change.
<Tip>
Connect Google Drive in **Tools & Integrations** and confirm the trigger is enabled for the automation you want to monitor.
</Tip>
## Enabling the Google Drive Trigger
1. Open your deployment in CrewAI AMP
2. Go to the **Triggers** tab
3. Locate **Google Drive** and switch the toggle to enable
<Frame>
<img src="/images/enterprise/gdrive-trigger.png" alt="Enable or disable triggers with toggle" />
</Frame>
## Example: Summarize file activity
The drive example crews parse the payload to extract file metadata, evaluate permissions, and publish a summary.
```python
from drive_file_crew import GoogleDriveFileTrigger
crew = GoogleDriveFileTrigger().crew()
crew.kickoff({
"crewai_trigger_payload": drive_payload,
})
```
## Sample payloads & crews
Explore the [Google Drive examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_drive) to cover different operations:
- `new-file.json` → new uploads processed by `drive-file-crew.py`
- `updated-file.json` → file edits and metadata changes handled by `drive-file-crew.py`
- `deleted-file.json` → deletion events routed through `drive-file-deletion-crew.py`
Each crew highlights the file name, operation type, owner, permissions, and security considerations so downstream systems can respond appropriately.
## Monitoring Executions
Track history and performance of triggered runs with the **Executions** list in the deployment dashboard.
<Frame>
<img src="/images/enterprise/list-executions.png" alt="List of executions triggered by automation" />
</Frame>
## Troubleshooting
- Verify Google Drive is connected and the trigger toggle is enabled
- If a payload is missing permission data, ensure the connected account has access to the file or folder
- The trigger sends file IDs only; use the Drive API if you need to fetch binary content during the crew run

View File

@@ -5,22 +5,22 @@ icon: "hubspot"
mode: "wide"
---
Este guia fornece um processo passo a passo para configurar gatilhos do HubSpot para o CrewAI Enterprise, permitindo iniciar crews diretamente a partir de Workflows do HubSpot.
Este guia fornece um processo passo a passo para configurar gatilhos do HubSpot para o CrewAI AMP, permitindo iniciar crews diretamente a partir de Workflows do HubSpot.
## Pré-requisitos
- Uma conta CrewAI Enterprise
- Uma conta CrewAI AMP
- Uma conta HubSpot com o recurso de [Workflows do HubSpot](https://knowledge.hubspot.com/workflows/create-workflows)
## Etapas de Configuração
<Steps>
<Step title="Conecte sua conta HubSpot com o CrewAI Enterprise">
- Faça login na sua `Conta CrewAI Enterprise > Triggers`
<Step title="Conecte sua conta HubSpot com o CrewAI AMP">
- Faça login na sua `Conta CrewAI AMP > Triggers`
- Selecione `HubSpot` na lista de gatilhos disponíveis
- Escolha a conta HubSpot que deseja conectar ao CrewAI Enterprise
- Siga as instruções na tela para autorizar o acesso do CrewAI Enterprise à sua conta HubSpot
- Uma mensagem de confirmação aparecerá assim que o HubSpot estiver conectado com sucesso ao CrewAI Enterprise
- Escolha a conta HubSpot que deseja conectar ao CrewAI AMP
- Siga as instruções na tela para autorizar o acesso do CrewAI AMP à sua conta HubSpot
- Uma mensagem de confirmação aparecerá assim que o HubSpot estiver conectado com sucesso ao CrewAI AMP
</Step>
<Step title="Crie um Workflow no HubSpot">
- Faça login na sua `Conta HubSpot > Automations > Workflows > New workflow`

View File

@@ -1,19 +1,19 @@
---
title: "Kickoff Crew"
description: "Inicie um Crew no CrewAI Enterprise"
description: "Inicie um Crew no CrewAI AMP"
icon: "flag-checkered"
mode: "wide"
---
## Visão Geral
Uma vez que você tenha implantado seu crew na plataforma CrewAI Enterprise, é possível iniciar execuções pela interface web ou pela API. Este guia aborda ambos os métodos.
Uma vez que você tenha implantado seu crew na plataforma CrewAI AMP, é possível iniciar execuções pela interface web ou pela API. Este guia aborda ambos os métodos.
## Método 1: Usando a Interface Web
### Passo 1: Navegue até seu Crew Implantado
1. Faça login no [CrewAI Enterprise](https://app.crewai.com)
1. Faça login no [CrewAI AMP](https://app.crewai.com)
2. Clique no nome do crew na sua lista de projetos
3. Você será direcionado para a página de detalhes do crew
@@ -83,7 +83,7 @@ Quando a execução for concluída:
## Método 2: Usando a API
Você também pode iniciar crews programaticamente usando a REST API do CrewAI Enterprise.
Você também pode iniciar crews programaticamente usando a REST API do CrewAI AMP.
### Autenticação

View File

@@ -0,0 +1,52 @@
---
title: "Microsoft Teams Trigger"
description: "Kick off crews from Microsoft Teams chat activity"
icon: "microsoft"
mode: "wide"
---
## Overview
Use the Microsoft Teams trigger to start automations whenever a new chat is created. Common patterns include summarizing inbound requests, routing urgent messages to support teams, or creating follow-up tasks in other systems.
<Tip>
Confirm Microsoft Teams is connected under **Tools & Integrations** and enabled in the **Triggers** tab for your deployment.
</Tip>
## Enabling the Microsoft Teams Trigger
1. Open your deployment in CrewAI AMP
2. Go to the **Triggers** tab
3. Locate **Microsoft Teams** and switch the toggle to enable
<Frame caption="Microsoft Teams trigger connection">
<img src="/images/enterprise/msteams-trigger.png" alt="Enable or disable triggers with toggle" />
</Frame>
## Example: Summarize a new chat thread
```python
from teams_chat_created_crew import MicrosoftTeamsChatTrigger
crew = MicrosoftTeamsChatTrigger().crew()
result = crew.kickoff({
"crewai_trigger_payload": teams_payload,
})
print(result.raw)
```
The crew parses thread metadata (subject, created time, roster) and generates an action plan for the receiving team.
## Sample payloads & crews
The [Microsoft Teams examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/microsoft-teams) include:
- `chat-created.json` → chat creation payload processed by `teams-chat-created-crew.py`
The crew demonstrates how to extract participants, initial messages, tenant information, and compliance metadata from the Microsoft Graph webhook payload.
## Troubleshooting
- Ensure the Teams connection is active; it must be refreshed if the tenant revokes permissions
- Confirm the webhook subscription in Microsoft 365 is still valid if payloads stop arriving
- Review execution logs for payload shape mismatches—Graph notifications may omit fields when a chat is private or restricted

View File

@@ -0,0 +1,53 @@
---
title: "OneDrive Trigger"
description: "Automate responses to OneDrive file activity"
icon: "cloud"
mode: "wide"
---
## Overview
Start automations when files change inside OneDrive. You can generate audit summaries, notify security teams about external sharing, or update downstream line-of-business systems with new document metadata.
<Tip>
Connect OneDrive in **Tools & Integrations** and toggle the trigger on for your deployment.
</Tip>
## Enabling the OneDrive Trigger
1. Open your deployment in CrewAI AMP
2. Go to the **Triggers** tab
3. Locate **OneDrive** and switch the toggle to enable
<Frame caption="Microsoft OneDrive trigger connection">
<img src="/images/enterprise/onedrive-trigger.png" alt="Enable or disable triggers with toggle" />
</Frame>
## Example: Audit file permissions
```python
from onedrive_file_crew import OneDriveFileTrigger
crew = OneDriveFileTrigger().crew()
crew.kickoff({
"crewai_trigger_payload": onedrive_payload,
})
```
The crew inspects file metadata, user activity, and permission changes to produce a compliance-friendly summary.
## Sample payloads & crews
The [OneDrive examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/onedrive) showcase how to:
- Parse file metadata, size, and folder paths
- Track who created and last modified the file
- Highlight permission and external sharing changes
`onedrive-file-crew.py` bundles the analysis and summarization tasks so you can add remediation steps as needed.
## Troubleshooting
- Ensure the connected account has permission to read the file metadata included in the webhook
- If the trigger fires but the payload is missing `permissions`, confirm the site-level sharing settings allow Graph to return this field
- For large tenants, filter notifications upstream so the crew only runs on relevant directories

View File

@@ -0,0 +1,52 @@
---
title: "Outlook Trigger"
description: "Launch automations from Outlook emails and calendar updates"
icon: "microsoft"
mode: "wide"
---
## Overview
Automate responses when Outlook delivers a new message or when an event is removed from the calendar. Teams commonly route escalations, file tickets, or alert attendees of cancellations.
<Tip>
Connect Outlook in **Tools & Integrations** and ensure the trigger is enabled for your deployment.
</Tip>
## Enabling the Outlook Trigger
1. Open your deployment in CrewAI AMP
2. Go to the **Triggers** tab
3. Locate **Outlook** and switch the toggle to enable
<Frame caption="Microsoft Outlook trigger connection">
<img src="/images/enterprise/outlook-trigger.png" alt="Enable or disable triggers with toggle" />
</Frame>
## Example: Summarize a new email
```python
from outlook_message_crew import OutlookMessageTrigger
crew = OutlookMessageTrigger().crew()
crew.kickoff({
"crewai_trigger_payload": outlook_payload,
})
```
The crew extracts sender details, subject, body preview, and attachments before generating a structured response.
## Sample payloads & crews
Review the [Outlook examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/outlook) for two common scenarios:
- `new-message.json` → new mail notifications parsed by `outlook-message-crew.py`
- `event-removed.json` → calendar cleanup handled by `outlook-event-removal-crew.py`
Each crew demonstrates how to handle Microsoft Graph payloads, normalize headers, and keep humans in-the-loop with concise summaries.
## Troubleshooting
- Verify the Outlook connector is still authorized; the subscription must be renewed periodically
- If attachments are missing, confirm the webhook subscription includes the `includeResourceData` flag
- Review execution logs when events fail to match—cancellation payloads lack attendee lists by design and the crew should account for that

View File

@@ -1,11 +1,11 @@
---
title: "Exportação de Componentes React"
description: "Aprenda como exportar e integrar componentes React do CrewAI Enterprise em suas aplicações"
description: "Aprenda como exportar e integrar componentes React do CrewAI AMP em suas aplicações"
icon: "react"
mode: "wide"
---
Este guia explica como exportar crews do CrewAI Enterprise como componentes React e integrá-los às suas próprias aplicações.
Este guia explica como exportar crews do CrewAI AMP como componentes React e integrá-los às suas próprias aplicações.
## Exportando um Componente React

View File

@@ -5,7 +5,7 @@ icon: "salesforce"
mode: "wide"
---
A CrewAI Enterprise pode ser acionada a partir do Salesforce para automatizar fluxos de trabalho de gestão de relacionamento com o cliente e aprimorar suas operações de vendas.
A CrewAI AMP pode ser acionada a partir do Salesforce para automatizar fluxos de trabalho de gestão de relacionamento com o cliente e aprimorar suas operações de vendas.
## Visão Geral
@@ -31,7 +31,7 @@ O Salesforce é uma das principais plataformas de gestão de relacionamento com
Para configurar triggers no Salesforce:
1. **Contato com o Suporte**: Entre em contato com o suporte da CrewAI Enterprise para obter assistência na configuração dos triggers no Salesforce
1. **Contato com o Suporte**: Entre em contato com o suporte da CrewAI AMP para obter assistência na configuração dos triggers no Salesforce
2. **Revisar Requisitos**: Certifique-se de possuir as permissões necessárias no Salesforce e acesso à API
3. **Configurar Conexão**: Trabalhe com a equipe de suporte para estabelecer a conexão entre a CrewAI e sua instância do Salesforce
4. **Testar Triggers**: Verifique se os triggers funcionam corretamente para os seus casos de uso específicos
@@ -47,4 +47,4 @@ Cenários comuns de uso de triggers Salesforce + CrewAI incluem:
## Próximos Passos
Para instruções detalhadas de configuração e opções avançadas, entre em contato com o suporte da CrewAI Enterprise, que pode fornecer orientações personalizadas para o seu ambiente Salesforce e necessidades de negócio.
Para instruções detalhadas de configuração e opções avançadas, entre em contato com o suporte da CrewAI AMP, que pode fornecer orientações personalizadas para o seu ambiente Salesforce e necessidades de negócio.

View File

@@ -1,17 +1,17 @@
---
title: "Gestão de Equipes"
description: "Aprenda como convidar e gerenciar membros da equipe em sua organização CrewAI Enterprise"
description: "Aprenda como convidar e gerenciar membros da equipe em sua organização CrewAI AMP"
icon: "users"
mode: "wide"
---
Como administrador de uma conta CrewAI Enterprise, você pode facilmente convidar novos membros para sua organização. Este guia irá orientá-lo passo a passo pelo processo.
Como administrador de uma conta CrewAI AMP, você pode facilmente convidar novos membros para sua organização. Este guia irá orientá-lo passo a passo pelo processo.
## Convidando Membros da Equipe
<Steps>
<Step title="Acesse a Página de Configurações">
- Faça login na sua conta CrewAI Enterprise
- Faça login na sua conta CrewAI AMP
- Procure o ícone de engrenagem (⚙️) no canto superior direito do painel
- Clique no ícone de engrenagem para acessar a página de **Configurações**:
<Frame>
@@ -43,7 +43,7 @@ Você pode adicionar funções aos membros da equipe para controlar o acesso a d
<Steps>
<Step title="Acesse a Página de Configurações">
- Faça login na sua conta CrewAI Enterprise
- Faça login na sua conta CrewAI AMP
- Procure o ícone de engrenagem (⚙️) no canto superior direito do painel
- Clique no ícone de engrenagem para acessar a página de **Configurações**:
<Frame>
@@ -85,4 +85,4 @@ Você pode adicionar funções aos membros da equipe para controlar o acesso a d
- **Aceite do Convite**: Os membros convidados precisarão aceitar o convite para ingressar na sua organização
- **Notificações por E-mail**: Oriente seus membros a verificarem o e-mail (incluindo a pasta de spam) para localizar o convite
Seguindo estes passos, você conseguirá expandir sua equipe e colaborar de forma mais eficaz dentro da sua organização CrewAI Enterprise.
Seguindo estes passos, você conseguirá expandir sua equipe e colaborar de forma mais eficaz dentro da sua organização CrewAI AMP.

View File

@@ -20,11 +20,11 @@ O repositório não é um sistema de controle de versões. Use Git para rastrear
Antes de usar o Repositório de Ferramentas, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com)
- Uma conta [CrewAI AMP](https://app.crewai.com)
- [CrewAI CLI](https://docs.crewai.com/concepts/cli#cli) instalada
- uv>=0.5.0 instalado. Veja [como atualizar](https://docs.astral.sh/uv/getting-started/installation/#upgrading-uv)
- [Git](https://git-scm.com) instalado e configurado
- Permissões de acesso para publicar ou instalar ferramentas em sua organização CrewAI Enterprise
- Permissões de acesso para publicar ou instalar ferramentas em sua organização CrewAI AMP
## Instalando ferramentas
@@ -85,7 +85,7 @@ crewai tool publish
Para excluir uma ferramenta:
1. Acesse o [CrewAI Enterprise](https://app.crewai.com)
1. Acesse o [CrewAI AMP](https://app.crewai.com)
2. Navegue até **Ferramentas**
3. Selecione a ferramenta
4. Clique em **Excluir**
@@ -100,7 +100,7 @@ Cada versão publicada passa por verificações automáticas de segurança e só
Você pode verificar o status das verificações de segurança de uma ferramenta em:
`CrewAI Enterprise > Tools > Your Tool > Versions`
`CrewAI AMP > Tools > Your Tool > Versions`
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
Entre em contato com nossa equipe de suporte para assistência com integração de API ou resolução de problemas.

View File

@@ -1,12 +1,12 @@
---
title: "Atualizar Crew"
description: "Atualizando uma Crew no CrewAI Enterprise"
description: "Atualizando uma Crew no CrewAI AMP"
icon: "pencil"
mode: "wide"
---
<Note>
Após implantar sua crew no CrewAI Enterprise, pode ser necessário fazer atualizações no código, configurações de segurança ou configuração.
Após implantar sua crew no CrewAI AMP, pode ser necessário fazer atualizações no código, configurações de segurança ou configuração.
Este guia explica como realizar essas operações de atualização comuns.
</Note>
@@ -23,7 +23,7 @@ Há várias razões para querer atualizar sua implantação de crew:
Quando você fizer push de novos commits no seu repositório do GitHub e quiser atualizar sua implantação:
1. Navegue até sua crew na plataforma CrewAI Enterprise
1. Navegue até sua crew na plataforma CrewAI AMP
2. Clique no botão `Re-deploy` na página de detalhes da sua crew
<Frame>
@@ -36,7 +36,7 @@ Isso irá acionar uma atualização que pode ser acompanhada pela barra de progr
Se precisar gerar um novo bearer token (por exemplo, se suspeitar que o token atual possa ter sido comprometido):
1. Navegue até sua crew na plataforma CrewAI Enterprise
1. Navegue até sua crew na plataforma CrewAI AMP
2. Encontre a seção `Bearer Token`
3. Clique no botão `Reset` ao lado do token atual

View File

@@ -1,17 +1,17 @@
---
title: "Automação com Webhook"
description: "Automatize fluxos de trabalho do CrewAI Enterprise usando webhooks com plataformas como ActivePieces, Zapier e Make.com"
description: "Automatize fluxos de trabalho do CrewAI AMP usando webhooks com plataformas como ActivePieces, Zapier e Make.com"
icon: "webhook"
mode: "wide"
---
O CrewAI Enterprise permite que você automatize seu fluxo de trabalho usando webhooks. Este artigo irá guiá-lo no processo de configuração e uso de webhooks para iniciar a execução do crew, com foco na integração com o ActivePieces, uma plataforma de automação de fluxos de trabalho semelhante ao Zapier e Make.com.
O CrewAI AMP permite que você automatize seu fluxo de trabalho usando webhooks. Este artigo irá guiá-lo no processo de configuração e uso de webhooks para iniciar a execução do crew, com foco na integração com o ActivePieces, uma plataforma de automação de fluxos de trabalho semelhante ao Zapier e Make.com.
## Configurando Webhooks
<Steps>
<Step title="Acessando a Interface de Kickoff">
- Navegue até o painel do CrewAI Enterprise
- Navegue até o painel do CrewAI AMP
- Procure pela seção `/kickoff`, que é usada para iniciar a execução do crew
<Frame>
<img src="/images/enterprise/kickoff-interface.png" alt="Interface Kickoff" />
@@ -44,7 +44,7 @@ O CrewAI Enterprise permite que você automatize seu fluxo de trabalho usando we
3. Adicione uma etapa de ação HTTP
- Configure a ação como `Send HTTP request`
- Use o método `POST`
- Defina a URL para o endpoint de kickoff do CrewAI Enterprise
- Defina a URL para o endpoint de kickoff do CrewAI AMP
- Adicione os headers necessários (ex.: `Bearer Token`)
<Frame>
<img src="/images/enterprise/activepieces-headers.png" alt="Headers ActivePieces" />

View File

@@ -5,11 +5,11 @@ icon: "bolt"
mode: "wide"
---
Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier para o CrewAI Enterprise, permitindo automatizar fluxos de trabalho entre CrewAI Enterprise e outros aplicativos.
Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier para o CrewAI AMP, permitindo automatizar fluxos de trabalho entre CrewAI AMP e outros aplicativos.
## Pré-requisitos
- Uma conta CrewAI Enterprise
- Uma conta CrewAI AMP
- Uma conta Zapier
- Uma conta Slack (para este exemplo específico)
@@ -32,7 +32,7 @@ Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier
- Conecte sua conta Slack, caso ainda não tenha feito isso.
</Step>
<Step title="Configure a ação do CrewAI Enterprise">
<Step title="Configure a ação do CrewAI AMP">
- Adicione uma nova etapa de ação ao seu Zap.
- Escolha CrewAI+ como o app de ação e Kickoff como Evento de Ação.
@@ -41,8 +41,8 @@ Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier
</Frame>
</Step>
<Step title="Conecte sua conta CrewAI Enterprise">
- Conecte sua conta CrewAI Enterprise.
<Step title="Conecte sua conta CrewAI AMP">
- Conecte sua conta CrewAI AMP.
- Selecione o Crew apropriado para seu fluxo de trabalho.
<Frame>
@@ -51,8 +51,8 @@ Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier
- Configure as entradas para o Crew usando os dados da mensagem do Slack.
</Step>
<Step title="Formate a saída do CrewAI Enterprise">
- Adicione outra etapa de ação para formatar a saída de texto do CrewAI Enterprise.
<Step title="Formate a saída do CrewAI AMP">
- Adicione outra etapa de ação para formatar a saída de texto do CrewAI AMP.
- Utilize as ferramentas de formatação do Zapier para converter a saída em Markdown para HTML.
<Frame>
@@ -67,7 +67,7 @@ Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier
- Adicione uma etapa final de ação para enviar a saída formatada por e-mail.
- Escolha seu serviço de e-mail preferido (ex.: Gmail, Outlook).
- Configure os detalhes do e-mail, incluindo destinatário, assunto e corpo.
- Insira a saída formatada do CrewAI Enterprise no corpo do e-mail.
- Insira a saída formatada do CrewAI AMP no corpo do e-mail.
<Frame>
<img src="/images/enterprise/zapier-7.png" alt="Zapier 7" />
@@ -97,8 +97,8 @@ Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier
## Dicas para o Sucesso
- Certifique-se de que as entradas do CrewAI Enterprise estejam corretamente mapeadas a partir da mensagem do Slack.
- Certifique-se de que as entradas do CrewAI AMP estejam corretamente mapeadas a partir da mensagem do Slack.
- Teste seu Zap cuidadosamente antes de ativá-lo para identificar possíveis problemas.
- Considere adicionar etapas de tratamento de erros para gerenciar possíveis falhas no fluxo.
Seguindo estes passos, você terá configurado com sucesso triggers no Zapier para o CrewAI Enterprise, permitindo fluxos de trabalho automatizados disparados por mensagens no Slack e resultando em notificações por e-mail com a saída do CrewAI Enterprise.
Seguindo estes passos, você terá configurado com sucesso triggers no Zapier para o CrewAI AMP, permitindo fluxos de trabalho automatizados disparados por mensagens no Slack e resultando em notificações por e-mail com a saída do CrewAI AMP.

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem tarefas, projetos e a coordenação da equipe
Antes de usar a integração com o Asana, assegure-se de ter:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Uma conta Asana com as permissões apropriadas
- Sua conta Asana conectada através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Antes de usar a integração com o Asana, assegure-se de ter:
### 1. Conecte sua Conta Asana
1. Acesse [CrewAI Enterprise Integrações](https://app.crewai.com/crewai_plus/connectors)
1. Acesse [CrewAI AMP Integrações](https://app.crewai.com/crewai_plus/connectors)
2. Encontre **Asana** na seção Integrações de Autenticação
3. Clique em **Conectar** e complete o fluxo OAuth
4. Conceda as permissões necessárias para gerenciamento de tarefas e projetos

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem arquivos, pastas e documentos através do Box
Antes de utilizar a integração com o Box, assegure-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Uma conta Box com as permissões apropriadas
- Sua conta Box conectada através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Antes de utilizar a integração com o Box, assegure-se de que você possui:
### 1. Conecte sua conta Box
1. Acesse [Integrações do CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
1. Acesse [Integrações do CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
2. Encontre **Box** na seção de Integrações de Autenticação
3. Clique em **Conectar** e conclua o fluxo de OAuth
4. Conceda as permissões necessárias para gerenciamento de arquivos e pastas

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem tarefas, projetos e fluxos de produtividade p
Antes de utilizar a integração com o ClickUp, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Uma conta ClickUp com as permissões apropriadas
- Sua conta ClickUp conectada pela [Página de Integrações](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Antes de utilizar a integração com o ClickUp, certifique-se de que você possu
### 1. Conecte sua Conta ClickUp
1. Acesse [CrewAI Enterprise Integrações](https://app.crewai.com/crewai_plus/connectors)
1. Acesse [CrewAI AMP Integrações](https://app.crewai.com/crewai_plus/connectors)
2. Encontre **ClickUp** na seção Integrações de Autenticação
3. Clique em **Conectar** e complete o fluxo OAuth
4. Conceda as permissões necessárias para gerenciamento de tarefas e projetos

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem repositórios, issues e releases através do
Antes de usar a integração do GitHub, assegure-se de ter:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Uma conta GitHub com permissões adequadas no repositório
- Conta do GitHub conectada através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Antes de usar a integração do GitHub, assegure-se de ter:
### 1. Conecte sua conta GitHub
1. Acesse [Integrações CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
1. Acesse [Integrações CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
2. Encontre **GitHub** na seção de Integrações de Autenticação
3. Clique em **Conectar** e complete o fluxo OAuth
4. Conceda as permissões necessárias para gerenciamento de repositório e issues

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem e-mails, contatos e rascunhos através do Gma
Antes de usar a integração com o Gmail, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Uma conta do Gmail com as permissões adequadas
- Conectou sua conta do Gmail através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Antes de usar a integração com o Gmail, certifique-se de que você possui:
### 1. Conecte sua Conta do Gmail
1. Navegue até [Integrações CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
1. Navegue até [Integrações CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
2. Encontre **Gmail** na seção de Integrações de Autenticação
3. Clique em **Conectar** e conclua o fluxo OAuth
4. Conceda as permissões necessárias para o gerenciamento de e-mail e contato

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem eventos de calendário, agendas e disponibili
Antes de usar a integração com o Google Calendar, certifique-se de ter:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Uma conta Google com acesso ao Google Calendar
- Sua conta Google conectada pela [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Antes de usar a integração com o Google Calendar, certifique-se de ter:
### 1. Conecte sua Conta Google
1. Acesse [Integrações do CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
1. Acesse [Integrações do CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
2. Encontre **Google Calendar** na seção de Integrações de Autenticação
3. Clique em **Conectar** e complete o fluxo OAuth
4. Conceda as permissões necessárias para acesso ao calendário e contatos

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem dados de planilhas por meio do Google Sheets.
Antes de utilizar a integração com o Google Sheets, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Uma conta Google com acesso ao Google Sheets
- Sua conta Google conectada pela [página de integrações](https://app.crewai.com/crewai_plus/connectors)
- Planilhas com cabeçalhos de coluna adequados para operações com dados
@@ -22,7 +22,7 @@ Antes de utilizar a integração com o Google Sheets, certifique-se de que você
### 1. Conecte sua Conta Google
1. Acesse [Integrações do CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
1. Acesse [Integrações do CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
2. Localize **Google Sheets** na seção Integrações de Autenticação
3. Clique em **Conectar** e conclua o fluxo OAuth
4. Conceda as permissões necessárias para acesso à planilha

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem empresas e contatos dentro do HubSpot. Crie n
Antes de utilizar a integração com o HubSpot, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa.
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa.
- Uma conta HubSpot com permissões adequadas.
- Sua conta HubSpot conectada pela [página de Integrações](https://app.crewai.com/crewai_plus/connectors).
@@ -21,7 +21,7 @@ Antes de utilizar a integração com o HubSpot, certifique-se de que você possu
### 1. Conecte Sua Conta HubSpot
1. Navegue até [CrewAI Enterprise Integrações](https://app.crewai.com/crewai_plus/connectors).
1. Navegue até [CrewAI AMP Integrações](https://app.crewai.com/crewai_plus/connectors).
2. Encontre **HubSpot** na seção de Integrações de Autenticação.
3. Clique em **Conectar** e complete o fluxo OAuth.
4. Conceda as permissões necessárias para gerenciamento de empresas e contatos.

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem problemas, projetos e fluxos de trabalho pelo
Antes de usar a integração com o Jira, certifique-se de ter:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Uma conta Jira com permissões adequadas para o projeto
- Sua conta Jira conectada pela [Página de Integrações](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Antes de usar a integração com o Jira, certifique-se de ter:
### 1. Conectar Sua Conta Jira
1. Acesse [Integrações CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
1. Acesse [Integrações CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
2. Encontre **Jira** na seção de Integrações de Autenticação
3. Clique em **Conectar** e complete o fluxo do OAuth
4. Conceda as permissões necessárias para gestão de issues e projetos

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem issues, projetos e fluxos de trabalho de dese
Antes de utilizar a integração com o Linear, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com uma assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com uma assinatura ativa
- Uma conta Linear com permissões apropriadas no workspace
- Conectou sua conta Linear através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Antes de utilizar a integração com o Linear, certifique-se de que você possui
### 1. Conecte sua Conta Linear
1. Navegue até [Integrações CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
1. Navegue até [Integrações CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
2. Encontre **Linear** na seção Integrações de Autenticação
3. Clique em **Conectar** e complete o fluxo OAuth
4. Conceda as permissões necessárias para gerenciamento de issues e projetos

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem páginas, bancos de dados e conteúdos atrav
Antes de usar a integração com o Notion, certifique-se de que você tem:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Uma conta Notion com permissões adequadas no workspace
- Sua conta Notion conectada através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Antes de usar a integração com o Notion, certifique-se de que você tem:
### 1. Conecte sua Conta Notion
1. Acesse [Integrações do CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
1. Acesse [Integrações do CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
2. Procure por **Notion** na seção de Integrações de Autenticação
3. Clique em **Conectar** e complete o fluxo de OAuth
4. Conceda as permissões necessárias para gerenciamento de páginas e bancos de dados

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem relacionamentos com clientes, processos de ve
Antes de usar a integração Salesforce, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Uma conta Salesforce com permissões apropriadas
- Sua conta Salesforce conectada via a [página de Integrações](https://app.crewai.com/integrations)

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem operações de e-commerce através do Shopify
Antes de utilizar a integração com o Shopify, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com uma assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com uma assinatura ativa
- Uma loja Shopify com permissões administrativas adequadas
- Sua loja Shopify conectada através da [página de Integrações](https://app.crewai.com/integrations)

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem a comunicação da equipe pelo Slack. Envie m
Antes de usar a integração com o Slack, certifique-se de que você tenha:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
- Um workspace do Slack com permissões apropriadas
- Seu workspace do Slack conectado por meio da [página de Integrações](https://app.crewai.com/integrations)

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem pagamentos, assinaturas e faturamento de clie
Antes de usar a integração com o Stripe, certifique-se de que você tem:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com uma assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com uma assinatura ativa
- Uma conta Stripe com permissões apropriadas de API
- Sua conta Stripe conectada através da [página de Integrações](https://app.crewai.com/integrations)

View File

@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem operações de suporte ao cliente através do
Antes de usar a integração com o Zendesk, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com uma assinatura ativa
- Uma conta [CrewAI AMP](https://app.crewai.com) com uma assinatura ativa
- Uma conta Zendesk com permissões apropriadas de API
- Sua conta Zendesk conectada através da [página de Integrações](https://app.crewai.com/integrations)

View File

@@ -1,5 +1,5 @@
---
title: "CrewAI Enterprise"
title: "CrewAI AMP"
description: "Implemente, monitore e escale seus fluxos de trabalho de agentes de IA"
icon: "globe"
mode: "wide"
@@ -7,13 +7,13 @@ mode: "wide"
## Introdução
CrewAI Enterprise fornece uma plataforma para implementar, monitorar e escalar seus crews e agentes em um ambiente de produção.
CrewAI AMP fornece uma plataforma para implementar, monitorar e escalar seus crews e agentes em um ambiente de produção.
<Frame>
<img src="/images/enterprise/crewai-enterprise-dashboard.png" alt="CrewAI Enterprise Dashboard" />
<img src="/images/enterprise/crewai-enterprise-dashboard.png" alt="CrewAI AMP Dashboard" />
</Frame>
CrewAI Enterprise expande o poder do framework open-source com funcionalidades projetadas para implantações em produção, colaboração e escalabilidade. Implemente seus crews em uma infraestrutura gerenciada e monitore sua execução em tempo real.
CrewAI AMP expande o poder do framework open-source com funcionalidades projetadas para implantações em produção, colaboração e escalabilidade. Implemente seus crews em uma infraestrutura gerenciada e monitore sua execução em tempo real.
## Principais Funcionalidades

View File

@@ -1,6 +1,6 @@
---
title: FAQs
description: "Perguntas frequentes sobre CrewAI Enterprise"
description: "Perguntas frequentes sobre CrewAI AMP"
icon: "circle-question"
mode: "wide"
---

View File

@@ -163,7 +163,7 @@ Recomendamos utilizar o template de scaffolding `YAML` para uma abordagem estrut
<Note type="info">
Para equipes e organizações, o CrewAI oferece opções de implantação corporativa que eliminam a complexidade da configuração:
### CrewAI Enterprise (SaaS)
### CrewAI AMP (SaaS)
- Zero instalação necessária - basta se cadastrar gratuitamente em [app.crewai.com](https://app.crewai.com)
- Atualizações e manutenção automáticas
- Infraestrutura e escalabilidade gerenciadas

View File

@@ -1,7 +1,7 @@
---
title: Input Humano na Execução
description: Integrando o CrewAI com input humano durante a execução em processos complexos de tomada de decisão e aproveitando ao máximo todos os atributos e ferramentas do agente.
icon: user-check
icon: user-plus
mode: "wide"
---

View File

@@ -394,7 +394,7 @@ Em vez de repetir o framework estratégico, segue um checklist tático para impl
<Step title="Valide com Testes Empresariais" icon="test-tube">
**Após colocar os agentes em produção:**
- Use [CrewAI Enterprise platform](https://app.crewai.com) para testar seleções de modelo A/B
- Use [CrewAI AMP platform](https://app.crewai.com) para testar seleções de modelo A/B
- Execute múltiplas iterações com inputs reais para medir consistência e performance
- Compare custo vs performance na configuração otimizada
- Compartilhe resultados com o time para tomada coletiva de decisão
@@ -541,7 +541,7 @@ Foque em entender seus requisitos primeiro, e então escolha modelos que melhor
### Validação de Modelos em Nível Enterprise
Para equipes sérias sobre otimização, a **plataforma CrewAI Enterprise** oferece testes sofisticados que vão além do CLI. Ela permite avaliação completa para decisões orientadas por dados na estratégia de LLM.
Para equipes sérias sobre otimização, a **plataforma CrewAI AMP** oferece testes sofisticados que vão além do CLI. Ela permite avaliação completa para decisões orientadas por dados na estratégia de LLM.
<Frame>
![Enterprise Testing Interface](/images/enterprise/enterprise-testing.png)

View File

@@ -0,0 +1,134 @@
---
title: Neatlogs Integration
description: Understand, debug, and share your CrewAI agent runs
icon: magnifying-glass-chart
mode: "wide"
---
# Introduction
Neatlogs helps you **see what your agent did**, **why**, and **share it**.
It captures every step: thoughts, tool calls, responses, evaluations. No raw logs. Just clear, structured traces. Great for debugging and collaboration.
## Why use Neatlogs?
CrewAI agents use multiple tools and reasoning steps. When something goes wrong, you need context — not just errors.
Neatlogs lets you:
- Follow the full decision path
- Add feedback directly on steps
- Chat with the trace using AI assistant
- Share runs publicly for feedback
- Turn insights into tasks
All in one place.
Manage your traces effortlessly
![Traces](/images/neatlogs-1.png)
![Trace Response](/images/neatlogs-2.png)
The best UX to view a CrewAI trace. Post comments anywhere you want. Use AI to debug.
![Trace Details](/images/neatlogs-3.png)
![Ai Chat Bot With A Trace](/images/neatlogs-4.png)
![Comments Drawer](/images/neatlogs-5.png)
## Core Features
- **Trace Viewer**: Track thoughts, tools, and decisions in sequence
- **Inline Comments**: Tag teammates on any trace step
- **Feedback & Evaluation**: Mark outputs as correct or incorrect
- **Error Highlighting**: Automatic flagging of API/tool failures
- **Task Conversion**: Convert comments into assigned tasks
- **Ask the Trace (AI)**: Chat with your trace using Neatlogs AI bot
- **Public Sharing**: Publish trace links to your community
## Quick Setup with CrewAI
<Steps>
<Step title="Sign Up & Get API Key">
Visit [neatlogs.com](https://neatlogs.com/?utm_source=crewAI-docs), create a project, copy the API key.
</Step>
<Step title="Install SDK">
```bash
pip install neatlogs
```
(Latest version 0.8.0, Python 3.8+; MIT license)
</Step>
<Step title="Initialize Neatlogs">
Before starting Crew agents, add:
```python
import neatlogs
neatlogs.init("YOUR_PROJECT_API_KEY")
```
Agents run as usual. Neatlogs captures everything automatically.
</Step>
</Steps>
## Under the Hood
According to GitHub, Neatlogs:
- Captures thoughts, tool calls, responses, errors, and token stats
- Supports AI-powered task generation and robust evaluation workflows
All with just two lines of code.
## Watch It Work
### 🔍 Full Demo (4min)
<iframe
className="w-full aspect-video rounded-xl"
src="https://www.youtube.com/embed/8KDme9T2I7Q?si=b8oHteaBwFNs_Duk"
title="NeatLogs overview"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
></iframe>
### ⚙️ CrewAI Integration (30s)
<iframe
className="w-full aspect-video rounded-xl"
src="https://www.loom.com/embed/9c78b552af43452bb3e4783cb8d91230?sid=e9d7d370-a91a-49b0-809e-2f375d9e801d"
title="Loom video player"
frameBorder="0"
allowFullScreen
></iframe>
## Links & Support
- 📘 [Neatlogs Docs](https://docs.neatlogs.com/)
- 🔐 [Dashboard & API Key](https://app.neatlogs.com/)
- 🐦 [Follow on Twitter](https://twitter.com/neatlogs)
- 📧 Contact: hello@neatlogs.com
- 🛠 [GitHub SDK](https://github.com/NeatLogs/neatlogs)
## TL;DR
With just:
```bash
pip install neatlogs
import neatlogs
neatlogs.init("YOUR_API_KEY")
You can now capture, understand, share, and act on your CrewAI agent runs in seconds.
No setup overhead. Full trace transparency. Full team collaboration.
```

View File

@@ -204,9 +204,9 @@ Siga os passos abaixo para começar a tripular! 🚣‍♂️
</Step>
<Step title="Alternativa para Empresas: Crie no Crew Studio">
Para usuários do CrewAI Enterprise, você pode criar a mesma tripulação sem escrever código:
Para usuários do CrewAI AMP, você pode criar a mesma tripulação sem escrever código:
1. Faça login na sua conta CrewAI Enterprise (crie uma conta gratuita em [app.crewai.com](https://app.crewai.com))
1. Faça login na sua conta CrewAI AMP (crie uma conta gratuita em [app.crewai.com](https://app.crewai.com))
2. Abra o Crew Studio
3. Digite qual automação deseja construir
4. Crie suas tarefas visualmente e conecte-as em sequência
@@ -214,8 +214,8 @@ Siga os passos abaixo para começar a tripular! 🚣‍♂️
![Crew Studio Quickstart](/images/enterprise/crew-studio-interface.png)
<Card title="Experimente o CrewAI Enterprise" icon="rocket" href="https://app.crewai.com">
Comece sua conta gratuita no CrewAI Enterprise
<Card title="Experimente o CrewAI AMP" icon="rocket" href="https://app.crewai.com">
Comece sua conta gratuita no CrewAI AMP
</Card>
</Step>
<Step title="Veja seu relatório final">
@@ -335,9 +335,9 @@ email_summarizer_task:
## Fazendo o Deploy da Sua Tripulação
A forma mais fácil de fazer deploy da sua tripulação em produção é através da [CrewAI Enterprise](http://app.crewai.com).
A forma mais fácil de fazer deploy da sua tripulação em produção é através da [CrewAI AMP](http://app.crewai.com).
Assista a este vídeo tutorial para uma demonstração detalhada de como fazer deploy da sua tripulação na [CrewAI Enterprise](http://app.crewai.com) usando a CLI.
Assista a este vídeo tutorial para uma demonstração detalhada de como fazer deploy da sua tripulação na [CrewAI AMP](http://app.crewai.com) usando a CLI.
<iframe
className="w-full aspect-video rounded-xl"
@@ -354,7 +354,7 @@ Assista a este vídeo tutorial para uma demonstração detalhada de como fazer d
icon="rocket"
href="http://app.crewai.com"
>
Comece com o CrewAI Enterprise e faça o deploy da sua tripulação em ambiente de produção com apenas alguns cliques.
Comece com o CrewAI AMP e faça o deploy da sua tripulação em ambiente de produção com apenas alguns cliques.
</Card>
<Card
title="Junte-se à Comunidade"

View File

@@ -0,0 +1,59 @@
---
title: Zapier Actions Tool
description: The `ZapierActionsAdapter` exposes Zapier actions as CrewAI tools for automation.
icon: bolt
mode: "wide"
---
# `ZapierActionsAdapter`
## Description
Use the Zapier adapter to list and call Zapier actions as CrewAI tools. This enables agents to trigger automations across thousands of apps.
## Installation
This adapter is included with `crewai-tools`. No extra install required.
## Environment Variables
- `ZAPIER_API_KEY` (required): Zapier API key. Get one from the Zapier Actions dashboard at https://actions.zapier.com/ (create an account, then generate an API key). You can also pass `zapier_api_key` directly when constructing the adapter.
## Example
```python Code
from crewai import Agent, Task, Crew
from crewai_tools.adapters.zapier_adapter import ZapierActionsAdapter
adapter = ZapierActionsAdapter(api_key="your_zapier_api_key")
tools = adapter.tools()
agent = Agent(
role="Automator",
goal="Execute Zapier actions",
backstory="Automation specialist",
tools=tools,
verbose=True,
)
task = Task(
description="Create a new Google Sheet and add a row using Zapier actions",
expected_output="Confirmation with created resource IDs",
agent=agent,
)
crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()
```
## Notes & limits
- The adapter lists available actions for your key and creates `BaseTool` wrappers dynamically.
- Handle actionspecific required fields in your task instructions or tool call.
- Rate limits depend on your Zapier plan; see the Zapier Actions docs.
## Notes
- The adapter fetches available actions and generates `BaseTool` wrappers dynamically.

View File

@@ -1,188 +0,0 @@
---
title: Ferramenta Bedrock Invoke Agent
description: Permite que agentes CrewAI invoquem Amazon Bedrock Agents e aproveitem suas capacidades em seus fluxos de trabalho
icon: aws
mode: "wide"
---
# `BedrockInvokeAgentTool`
A `BedrockInvokeAgentTool` permite que agentes CrewAI invoquem Amazon Bedrock Agents e aproveitem suas capacidades em seus fluxos de trabalho.
## Instalação
```bash
uv pip install 'crewai[tools]'
```
## Requisitos
- Credenciais AWS configuradas (através de variáveis de ambiente ou AWS CLI)
- Pacotes `boto3` e `python-dotenv`
- Acesso aos Amazon Bedrock Agents
## Uso
Veja como usar a ferramenta com um agente CrewAI:
```python {2, 4-8}
from crewai import Agent, Task, Crew
from crewai_tools.aws.bedrock.agents.invoke_agent_tool import BedrockInvokeAgentTool
# Initialize the tool
agent_tool = BedrockInvokeAgentTool(
agent_id="your-agent-id",
agent_alias_id="your-agent-alias-id"
)
# Create a CrewAI agent that uses the tool
aws_expert = Agent(
role='AWS Service Expert',
goal='Help users understand AWS services and quotas',
backstory='I am an expert in AWS services and can provide detailed information about them.',
tools=[agent_tool],
verbose=True
)
# Create a task for the agent
quota_task = Task(
description="Find out the current service quotas for EC2 in us-west-2 and explain any recent changes.",
agent=aws_expert
)
# Create a crew with the agent
crew = Crew(
agents=[aws_expert],
tasks=[quota_task],
verbose=2
)
# Run the crew
result = crew.kickoff()
print(result)
```
## Argumentos da Ferramenta
| Argumento | Tipo | Obrigatório | Padrão | Descrição |
|:----------|:-----|:------------|:---------|:----------------------------------------------------|
| **agent_id** | `str` | Sim | None | O identificador único do agente Bedrock |
| **agent_alias_id** | `str` | Sim | None | O identificador único do alias do agente |
| **session_id** | `str` | Não | timestamp | O identificador único da sessão |
| **enable_trace** | `bool` | Não | False | Define se o trace deve ser habilitado para debug |
| **end_session** | `bool` | Não | False | Define se a sessão deve ser encerrada após invocação |
| **description** | `str` | Não | None | Descrição personalizada para a ferramenta |
## Variáveis de Ambiente
```bash
BEDROCK_AGENT_ID=your-agent-id # Alternativa para passar agent_id
BEDROCK_AGENT_ALIAS_ID=your-agent-alias-id # Alternativa para passar agent_alias_id
AWS_REGION=your-aws-region # Padrão é us-west-2
AWS_ACCESS_KEY_ID=your-access-key # Necessário para autenticação AWS
AWS_SECRET_ACCESS_KEY=your-secret-key # Necessário para autenticação AWS
```
## Uso Avançado
### Fluxo de Trabalho Multiagente com Gerenciamento de Sessão
```python {2, 4-22}
from crewai import Agent, Task, Crew, Process
from crewai_tools.aws.bedrock.agents.invoke_agent_tool import BedrockInvokeAgentTool
# Initialize tools with session management
initial_tool = BedrockInvokeAgentTool(
agent_id="your-agent-id",
agent_alias_id="your-agent-alias-id",
session_id="custom-session-id"
)
followup_tool = BedrockInvokeAgentTool(
agent_id="your-agent-id",
agent_alias_id="your-agent-alias-id",
session_id="custom-session-id"
)
final_tool = BedrockInvokeAgentTool(
agent_id="your-agent-id",
agent_alias_id="your-agent-alias-id",
session_id="custom-session-id",
end_session=True
)
# Create agents for different stages
researcher = Agent(
role='AWS Service Researcher',
goal='Gather information about AWS services',
backstory='I am specialized in finding detailed AWS service information.',
tools=[initial_tool]
)
analyst = Agent(
role='Service Compatibility Analyst',
goal='Analyze service compatibility and requirements',
backstory='I analyze AWS services for compatibility and integration possibilities.',
tools=[followup_tool]
)
summarizer = Agent(
role='Technical Documentation Writer',
goal='Create clear technical summaries',
backstory='I specialize in creating clear, concise technical documentation.',
tools=[final_tool]
)
# Create tasks
research_task = Task(
description="Find all available AWS services in us-west-2 region.",
agent=researcher
)
analysis_task = Task(
description="Analyze which services support IPv6 and their implementation requirements.",
agent=analyst
)
summary_task = Task(
description="Create a summary of IPv6-compatible services and their key features.",
agent=summarizer
)
# Create a crew with the agents and tasks
crew = Crew(
agents=[researcher, analyst, summarizer],
tasks=[research_task, analysis_task, summary_task],
process=Process.sequential,
verbose=2
)
# Run the crew
result = crew.kickoff()
```
## Casos de Uso
### Colaborações Híbridas Multiagente
- Crie fluxos de trabalho onde agentes CrewAI colaboram com agentes Bedrock gerenciados executando como serviços na AWS
- Permita cenários em que o processamento de dados sensíveis ocorre dentro do seu ambiente AWS enquanto outros agentes operam externamente
- Conecte agentes CrewAI on-premises a agentes Bedrock baseados na nuvem para fluxos de trabalho distribuídos de inteligência
### Soberania e Conformidade de Dados
- Mantenha fluxos de trabalho agentivos sensíveis a dados dentro do seu ambiente AWS enquanto permite que agentes CrewAI externos orquestrem tarefas
- Mantenha conformidade com requisitos de residência de dados processando informações sensíveis somente em sua conta AWS
- Permita colaborações multiagentes seguras onde alguns agentes não podem acessar dados privados da sua organização
### Integração Transparente com Serviços AWS
- Acesse qualquer serviço AWS por meio do Amazon Bedrock Actions sem escrever código de integração complexo
- Permita que agentes CrewAI interajam com serviços AWS usando solicitações em linguagem natural
- Aproveite as capacidades pré-construídas dos agentes Bedrock para interagir com serviços AWS como Bedrock Knowledge Bases, Lambda e outros
### Arquiteturas de Agentes Híbridos Escaláveis
- Realize tarefas computacionalmente intensivas em agentes Bedrock gerenciados enquanto tarefas leves rodam em CrewAI
- Escale o processamento de agentes distribuindo cargas de trabalho entre agentes CrewAI locais e agentes Bedrock na nuvem
### Colaboração de Agentes Entre Organizações
- Permita colaboração segura entre agentes CrewAI da sua organização e agentes Bedrock de organizações parceiras
- Crie fluxos de trabalho onde a expertise externa de agentes Bedrock pode ser incorporada sem expor dados sensíveis
- Construa ecossistemas de agentes que abrangem fronteiras organizacionais mantendo segurança e controle de dados

View File

@@ -0,0 +1,169 @@
---
title: MongoDB Vector Search Tool
description: The `MongoDBVectorSearchTool` performs vector search on MongoDB Atlas with optional indexing helpers.
icon: "leaf"
mode: "wide"
---
# `MongoDBVectorSearchTool`
## Description
Perform vector similarity queries on MongoDB Atlas collections. Supports index creation helpers and bulk insert of embedded texts.
MongoDB Atlas supports native vector search. Learn more:
https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-overview/
## Installation
Install with the MongoDB extra:
```shell
pip install crewai-tools[mongodb]
```
or
```shell
uv add crewai-tools --extra mongodb
```
## Parameters
### Initialization
- `connection_string` (str, required)
- `database_name` (str, required)
- `collection_name` (str, required)
- `vector_index_name` (str, default `vector_index`)
- `text_key` (str, default `text`)
- `embedding_key` (str, default `embedding`)
- `dimensions` (int, default `1536`)
### Run Parameters
- `query` (str, required): Natural language query to embed and search.
## Quick start
```python Code
from crewai_tools import MongoDBVectorSearchTool
tool = MongoDBVectorSearchTool(
connection_string="mongodb+srv://...",
database_name="mydb",
collection_name="docs",
)
print(tool.run(query="how to create vector index"))
```
## Index creation helpers
Use `create_vector_search_index(...)` to provision an Atlas Vector Search index with the correct dimensions and similarity.
## Common issues
- Authentication failures: ensure your Atlas IP Access List allows your runner and the connection string includes credentials.
- Index not found: create the vector index first; name must match `vector_index_name`.
- Dimensions mismatch: align embedding model dimensions with `dimensions`.
## More examples
### Basic initialization
```python Code
from crewai_tools import MongoDBVectorSearchTool
tool = MongoDBVectorSearchTool(
database_name="example_database",
collection_name="example_collection",
connection_string="<your_mongodb_connection_string>",
)
```
### Custom query configuration
```python Code
from crewai_tools import MongoDBVectorSearchConfig, MongoDBVectorSearchTool
query_config = MongoDBVectorSearchConfig(limit=10, oversampling_factor=2)
tool = MongoDBVectorSearchTool(
database_name="example_database",
collection_name="example_collection",
connection_string="<your_mongodb_connection_string>",
query_config=query_config,
vector_index_name="my_vector_index",
)
rag_agent = Agent(
name="rag_agent",
role="You are a helpful assistant that can answer questions with the help of the MongoDBVectorSearchTool.",
goal="...",
backstory="...",
tools=[tool],
)
```
### Preloading the database and creating the index
```python Code
import os
from crewai_tools import MongoDBVectorSearchTool
tool = MongoDBVectorSearchTool(
database_name="example_database",
collection_name="example_collection",
connection_string="<your_mongodb_connection_string>",
)
# Load text content from a local folder and add to MongoDB
texts = []
for fname in os.listdir("knowledge"):
path = os.path.join("knowledge", fname)
if os.path.isfile(path):
with open(path, "r", encoding="utf-8") as f:
texts.append(f.read())
tool.add_texts(texts)
# Create the Atlas Vector Search index (e.g., 3072 dims for text-embedding-3-large)
tool.create_vector_search_index(dimensions=3072)
```
## Example
```python Code
from crewai import Agent, Task, Crew
from crewai_tools import MongoDBVectorSearchTool
tool = MongoDBVectorSearchTool(
connection_string="mongodb+srv://...",
database_name="mydb",
collection_name="docs",
)
agent = Agent(
role="RAG Agent",
goal="Answer using MongoDB vector search",
backstory="Knowledge retrieval specialist",
tools=[tool],
verbose=True,
)
task = Task(
description="Find relevant content for 'indexing guidance'",
expected_output="A concise answer citing the most relevant matches",
agent=agent,
)
crew = Crew(
agents=[agent],
tasks=[task],
verbose=True,
)
result = crew.kickoff()
```

View File

@@ -0,0 +1,62 @@
---
title: SingleStore Search Tool
description: The `SingleStoreSearchTool` safely executes SELECT/SHOW queries on SingleStore with pooling.
icon: circle
mode: "wide"
---
# `SingleStoreSearchTool`
## Description
Execute readonly queries (`SELECT`/`SHOW`) against SingleStore with connection pooling and input validation.
## Installation
```shell
uv add crewai-tools[singlestore]
```
## Environment Variables
Variables like `SINGLESTOREDB_HOST`, `SINGLESTOREDB_USER`, `SINGLESTOREDB_PASSWORD`, etc., can be used, or `SINGLESTOREDB_URL` as a single DSN.
Generate the API key from the SingleStore dashboard, [docs here](https://docs.singlestore.com/cloud/reference/management-api/#generate-an-api-key).
## Example
```python Code
from crewai import Agent, Task, Crew
from crewai_tools import SingleStoreSearchTool
tool = SingleStoreSearchTool(
tables=["products"],
host="host",
user="user",
password="pass",
database="db",
)
agent = Agent(
role="Analyst",
goal="Query SingleStore",
tools=[tool],
verbose=True,
)
task = Task(
description="List 5 products",
expected_output="5 rows as JSON/text",
agent=agent,
)
crew = Crew(
agents=[agent],
tasks=[task],
verbose=True,
)
result = crew.kickoff()
```

View File

@@ -0,0 +1,90 @@
---
title: OCR Tool
description: The `OCRTool` extracts text from local images or image URLs using an LLM with vision.
icon: image
mode: "wide"
---
# `OCRTool`
## Description
Extract text from images (local path or URL). Uses a visioncapable LLM via CrewAIs LLM interface.
## Installation
No extra install beyond `crewai-tools`. Ensure your selected LLM supports vision.
## Parameters
### Run Parameters
- `image_path_url` (str, required): Local image path or HTTP(S) URL.
## Examples
### Direct usage
```python Code
from crewai_tools import OCRTool
print(OCRTool().run(image_path_url="/tmp/receipt.png"))
```
### With an agent
```python Code
from crewai import Agent, Task, Crew
from crewai_tools import OCRTool
ocr = OCRTool()
agent = Agent(
role="OCR",
goal="Extract text",
tools=[ocr],
)
task = Task(
description="Extract text from https://example.com/invoice.jpg",
expected_output="All detected text in plain text",
agent=agent,
)
crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()
```
## Notes
- Ensure the selected LLM supports image inputs.
- For large images, consider downscaling to reduce token usage.
- You can pass a specific LLM instance to the tool (e.g., `LLM(model="gpt-4o")`) if needed, matching the README guidance.
## Example
```python Code
from crewai import Agent, Task, Crew
from crewai_tools import OCRTool
tool = OCRTool()
agent = Agent(
role="OCR Specialist",
goal="Extract text from images",
backstory="Visionenabled analyst",
tools=[tool],
verbose=True,
)
task = Task(
description="Extract text from https://example.com/receipt.png",
expected_output="All detected text in plain text",
agent=agent,
)
crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()
```

View File

@@ -0,0 +1,77 @@
---
title: PDF Text Writing Tool
description: The `PDFTextWritingTool` writes text to specific positions in a PDF, supporting custom fonts.
icon: file-pdf
mode: "wide"
---
# `PDFTextWritingTool`
## Description
Write text at precise coordinates on a PDF page, optionally embedding a custom TrueType font.
## Parameters
### Run Parameters
- `pdf_path` (str, required): Path to the input PDF.
- `text` (str, required): Text to add.
- `position` (tuple[int, int], required): `(x, y)` coordinates.
- `font_size` (int, default `12`)
- `font_color` (str, default `"0 0 0 rg"`)
- `font_name` (str, default `"F1"`)
- `font_file` (str, optional): Path to `.ttf` file.
- `page_number` (int, default `0`)
## Example
```python Code
from crewai import Agent, Task, Crew
from crewai_tools import PDFTextWritingTool
tool = PDFTextWritingTool()
agent = Agent(
role="PDF Editor",
goal="Annotate PDFs",
backstory="Documentation specialist",
tools=[tool],
verbose=True,
)
task = Task(
description="Write 'CONFIDENTIAL' at (72, 720) on page 1 of ./sample.pdf",
expected_output="Confirmation message",
agent=agent,
)
crew = Crew(
agents=[agent],
tasks=[task],
verbose=True,
)
result = crew.kickoff()
```
### Direct usage
```python Code
from crewai_tools import PDFTextWritingTool
PDFTextWritingTool().run(
pdf_path="./input.pdf",
text="CONFIDENTIAL",
position=(72, 720),
font_size=18,
page_number=0,
)
```
## Tips
- Coordinate origin is the bottomleft corner.
- If using a custom font (`font_file`), ensure it is a valid `.ttf`.

View File

@@ -0,0 +1,113 @@
---
title: Arxiv Paper Tool
description: The `ArxivPaperTool` searches arXiv for papers matching a query and optionally downloads PDFs.
icon: box-archive
mode: "wide"
---
# `ArxivPaperTool`
## Description
The `ArxivPaperTool` queries the arXiv API for academic papers and returns compact, readable results. It can also optionally download PDFs to disk.
## Installation
This tool has no special installation beyond `crewai-tools`.
```shell
uv add crewai-tools
```
No API key is required. This tool uses the public arXiv Atom API.
## Steps to Get Started
1. Initialize the tool.
2. Provide a `search_query` (e.g., "transformer neural network").
3. Optionally set `max_results` (1100) and enable PDF downloads in the constructor.
## Example
```python Code
from crewai import Agent, Task, Crew
from crewai_tools import ArxivPaperTool
tool = ArxivPaperTool(
download_pdfs=False,
save_dir="./arxiv_pdfs",
use_title_as_filename=True,
)
agent = Agent(
role="Researcher",
goal="Find relevant arXiv papers",
backstory="Expert at literature discovery",
tools=[tool],
verbose=True,
)
task = Task(
description="Search arXiv for 'transformer neural network' and list top 5 results.",
expected_output="A concise list of 5 relevant papers with titles, links, and summaries.",
agent=agent,
)
crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()
```
### Direct usage (without Agent)
```python Code
from crewai_tools import ArxivPaperTool
tool = ArxivPaperTool(
download_pdfs=True,
save_dir="./arxiv_pdfs",
)
print(tool.run(search_query="mixture of experts", max_results=3))
```
## Parameters
### Initialization Parameters
- `download_pdfs` (bool, default `False`): Whether to download PDFs.
- `save_dir` (str, default `./arxiv_pdfs`): Directory to save PDFs.
- `use_title_as_filename` (bool, default `False`): Use paper titles for filenames.
### Run Parameters
- `search_query` (str, required): The arXiv search query.
- `max_results` (int, default `5`, range 1100): Number of results.
## Output format
The tool returns a humanreadable list of papers with:
- Title
- Link (abs page)
- Snippet/summary (truncated)
When `download_pdfs=True`, PDFs are saved to disk and the summary mentions saved files.
## Usage Notes
- The tool returns formatted text with key metadata and links.
- When `download_pdfs=True`, PDFs will be stored in `save_dir`.
## Troubleshooting
- If you receive a network timeout, retry or reduce `max_results`.
- Invalid XML errors indicate an arXiv response parse issue; try a simpler query.
- File system errors (e.g., permission denied) may occur when saving PDFs; ensure `save_dir` is writable.
## Related links
- arXiv API docs: https://info.arxiv.org/help/api/index.html
## Error Handling
- Network issues, invalid XML, and OS errors are handled with informative messages.

View File

@@ -0,0 +1,81 @@
---
title: Databricks SQL Query Tool
description: The `DatabricksQueryTool` executes SQL queries against Databricks workspace tables.
icon: trowel-bricks
mode: "wide"
---
# `DatabricksQueryTool`
## Description
Run SQL against Databricks workspace tables with either CLI profile or direct host/token authentication.
## Installation
```shell
uv add crewai-tools[databricks-sdk]
```
## Environment Variables
- `DATABRICKS_CONFIG_PROFILE` or (`DATABRICKS_HOST` + `DATABRICKS_TOKEN`)
Create a personal access token and find host details in the Databricks workspace under User Settings → Developer.
Docs: https://docs.databricks.com/en/dev-tools/auth/pat.html
## Example
```python Code
from crewai import Agent, Task, Crew
from crewai_tools import DatabricksQueryTool
tool = DatabricksQueryTool(
default_catalog="main",
default_schema="default",
)
agent = Agent(
role="Data Analyst",
goal="Query Databricks",
tools=[tool],
verbose=True,
)
task = Task(
description="SELECT * FROM my_table LIMIT 10",
expected_output="10 rows",
agent=agent,
)
crew = Crew(
agents=[agent],
tasks=[task],
verbose=True,
)
result = crew.kickoff()
print(result)
```
## Parameters
- `query` (required): SQL query to execute
- `catalog` (optional): Override default catalog
- `db_schema` (optional): Override default schema
- `warehouse_id` (optional): Override default SQL warehouse
- `row_limit` (optional): Maximum rows to return (default: 1000)
## Defaults on initialization
- `default_catalog`
- `default_schema`
- `default_warehouse_id`
### Error handling & tips
- Authentication errors: verify `DATABRICKS_HOST` begins with `https://` and token is valid.
- Permissions: ensure your SQL warehouse and schema are accessible by your token.
- Limits: longrunning queries should be avoided in agent loops; add filters/limits.

View File

@@ -0,0 +1,66 @@
---
title: SerpApi Google Search Tool
description: The `SerpApiGoogleSearchTool` performs Google searches using the SerpApi service.
icon: google
mode: "wide"
---
# `SerpApiGoogleSearchTool`
## Description
Use the `SerpApiGoogleSearchTool` to run Google searches with SerpApi and retrieve structured results. Requires a SerpApi API key.
## Installation
```shell
uv add crewai-tools[serpapi]
```
## Environment Variables
- `SERPAPI_API_KEY` (required): API key for SerpApi. Create one at https://serpapi.com/ (free tier available).
## Example
```python Code
from crewai import Agent, Task, Crew
from crewai_tools import SerpApiGoogleSearchTool
tool = SerpApiGoogleSearchTool()
agent = Agent(
role="Researcher",
goal="Answer questions using Google search",
backstory="Search specialist",
tools=[tool],
verbose=True,
)
task = Task(
description="Search for the latest CrewAI releases",
expected_output="A concise list of relevant results with titles and links",
agent=agent,
)
crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()
```
## Notes
- Set `SERPAPI_API_KEY` in the environment. Create a key at https://serpapi.com/
- See also Google Shopping via SerpApi: `/en/tools/search-research/serpapi-googleshoppingtool`
## Parameters
### Run Parameters
- `search_query` (str, required): The Google query.
- `location` (str, optional): Geographic location parameter.
## Notes
- This tool wraps SerpApi and returns structured search results.

View File

@@ -0,0 +1,62 @@
---
title: SerpApi Google Shopping Tool
description: The `SerpApiGoogleShoppingTool` searches Google Shopping results using SerpApi.
icon: cart-shopping
mode: "wide"
---
# `SerpApiGoogleShoppingTool`
## Description
Leverage `SerpApiGoogleShoppingTool` to query Google Shopping via SerpApi and retrieve product-oriented results.
## Installation
```shell
uv add crewai-tools[serpapi]
```
## Environment Variables
- `SERPAPI_API_KEY` (required): API key for SerpApi. Create one at https://serpapi.com/ (free tier available).
## Example
```python Code
from crewai import Agent, Task, Crew
from crewai_tools import SerpApiGoogleShoppingTool
tool = SerpApiGoogleShoppingTool()
agent = Agent(
role="Shopping Researcher",
goal="Find relevant products",
backstory="Expert in product search",
tools=[tool],
verbose=True,
)
task = Task(
description="Search Google Shopping for 'wireless noise-canceling headphones'",
expected_output="Top relevant products with titles and links",
agent=agent,
)
crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()
```
## Notes
- Set `SERPAPI_API_KEY` in the environment. Create a key at https://serpapi.com/
- See also Google Web Search via SerpApi: `/en/tools/search-research/serpapi-googlesearchtool`
## Parameters
### Run Parameters
- `search_query` (str, required): Product search query.
- `location` (str, optional): Geographic location parameter.

View File

@@ -0,0 +1,140 @@
---
title: "Tavily Extractor Tool"
description: "Extract structured content from web pages using the Tavily API"
icon: square-poll-horizontal
mode: "wide"
---
The `TavilyExtractorTool` allows CrewAI agents to extract structured content from web pages using the Tavily API. It can process single URLs or lists of URLs and provides options for controlling the extraction depth and including images.
## Installation
To use the `TavilyExtractorTool`, you need to install the `tavily-python` library:
```shell
pip install 'crewai[tools]' tavily-python
```
You also need to set your Tavily API key as an environment variable:
```bash
export TAVILY_API_KEY='your-tavily-api-key'
```
## Example Usage
Here's how to initialize and use the `TavilyExtractorTool` within a CrewAI agent:
```python
import os
from crewai import Agent, Task, Crew
from crewai_tools import TavilyExtractorTool
# Ensure TAVILY_API_KEY is set in your environment
# os.environ["TAVILY_API_KEY"] = "YOUR_API_KEY"
# Initialize the tool
tavily_tool = TavilyExtractorTool()
# Create an agent that uses the tool
extractor_agent = Agent(
role='Web Content Extractor',
goal='Extract key information from specified web pages',
backstory='You are an expert at extracting relevant content from websites using the Tavily API.',
tools=[tavily_tool],
verbose=True
)
# Define a task for the agent
extract_task = Task(
description='Extract the main content from the URL https://example.com using basic extraction depth.',
expected_output='A JSON string containing the extracted content from the URL.',
agent=extractor_agent
)
# Create and run the crew
crew = Crew(
agents=[extractor_agent],
tasks=[extract_task],
verbose=2
)
result = crew.kickoff()
print(result)
```
## Configuration Options
The `TavilyExtractorTool` accepts the following arguments:
- `urls` (Union[List[str], str]): **Required**. A single URL string or a list of URL strings to extract data from.
- `include_images` (Optional[bool]): Whether to include images in the extraction results. Defaults to `False`.
- `extract_depth` (Literal["basic", "advanced"]): The depth of extraction. Use `"basic"` for faster, surface-level extraction or `"advanced"` for more comprehensive extraction. Defaults to `"basic"`.
- `timeout` (int): The maximum time in seconds to wait for the extraction request to complete. Defaults to `60`.
## Advanced Usage
### Multiple URLs with Advanced Extraction
```python
# Example with multiple URLs and advanced extraction
multi_extract_task = Task(
description='Extract content from https://example.com and https://anotherexample.org using advanced extraction.',
expected_output='A JSON string containing the extracted content from both URLs.',
agent=extractor_agent
)
# Configure the tool with custom parameters
custom_extractor = TavilyExtractorTool(
extract_depth='advanced',
include_images=True,
timeout=120
)
agent_with_custom_tool = Agent(
role="Advanced Content Extractor",
goal="Extract comprehensive content with images",
tools=[custom_extractor]
)
```
### Tool Parameters
You can customize the tool's behavior by setting parameters during initialization:
```python
# Initialize with custom configuration
extractor_tool = TavilyExtractorTool(
extract_depth='advanced', # More comprehensive extraction
include_images=True, # Include image results
timeout=90 # Custom timeout
)
```
## Features
- **Single or Multiple URLs**: Extract content from one URL or process multiple URLs in a single request
- **Configurable Depth**: Choose between basic (fast) and advanced (comprehensive) extraction modes
- **Image Support**: Optionally include images in the extraction results
- **Structured Output**: Returns well-formatted JSON containing the extracted content
- **Error Handling**: Robust handling of network timeouts and extraction errors
## Response Format
The tool returns a JSON string representing the structured data extracted from the provided URL(s). The exact structure depends on the content of the pages and the `extract_depth` used.
Common response elements include:
- **Title**: The page title
- **Content**: Main text content of the page
- **Images**: Image URLs and metadata (when `include_images=True`)
- **Metadata**: Additional page information like author, description, etc.
## Use Cases
- **Content Analysis**: Extract and analyze content from competitor websites
- **Research**: Gather structured data from multiple sources for analysis
- **Content Migration**: Extract content from existing websites for migration
- **Monitoring**: Regular extraction of content for change detection
- **Data Collection**: Systematic extraction of information from web sources
Refer to the [Tavily API documentation](https://docs.tavily.com/docs/tavily-api/python-sdk#extract) for detailed information about the response structure and available options.

View File

@@ -0,0 +1,125 @@
---
title: "Tavily Search Tool"
description: "Perform comprehensive web searches using the Tavily Search API"
icon: "magnifying-glass"
mode: "wide"
---
The `TavilySearchTool` provides an interface to the Tavily Search API, enabling CrewAI agents to perform comprehensive web searches. It allows for specifying search depth, topics, time ranges, included/excluded domains, and whether to include direct answers, raw content, or images in the results.
## Installation
To use the `TavilySearchTool`, you need to install the `tavily-python` library:
```shell
pip install 'crewai[tools]' tavily-python
```
## Environment Variables
Ensure your Tavily API key is set as an environment variable:
```bash
export TAVILY_API_KEY='your_tavily_api_key'
```
Get an API key at https://app.tavily.com/ (sign up, then create a key).
## Example Usage
Here's how to initialize and use the `TavilySearchTool` within a CrewAI agent:
```python
import os
from crewai import Agent, Task, Crew
from crewai_tools import TavilySearchTool
# Ensure the TAVILY_API_KEY environment variable is set
# os.environ["TAVILY_API_KEY"] = "YOUR_TAVILY_API_KEY"
# Initialize the tool
tavily_tool = TavilySearchTool()
# Create an agent that uses the tool
researcher = Agent(
role='Market Researcher',
goal='Find information about the latest AI trends',
backstory='An expert market researcher specializing in technology.',
tools=[tavily_tool],
verbose=True
)
# Create a task for the agent
research_task = Task(
description='Search for the top 3 AI trends in 2024.',
expected_output='A JSON report summarizing the top 3 AI trends found.',
agent=researcher
)
# Form the crew and kick it off
crew = Crew(
agents=[researcher],
tasks=[research_task],
verbose=2
)
result = crew.kickoff()
print(result)
```
## Configuration Options
The `TavilySearchTool` accepts the following arguments during initialization or when calling the `run` method:
- `query` (str): **Required**. The search query string.
- `search_depth` (Literal["basic", "advanced"], optional): The depth of the search. Defaults to `"basic"`.
- `topic` (Literal["general", "news", "finance"], optional): The topic to focus the search on. Defaults to `"general"`.
- `time_range` (Literal["day", "week", "month", "year"], optional): The time range for the search. Defaults to `None`.
- `days` (int, optional): The number of days to search back. Relevant if `time_range` is not set. Defaults to `7`.
- `max_results` (int, optional): The maximum number of search results to return. Defaults to `5`.
- `include_domains` (Sequence[str], optional): A list of domains to prioritize in the search. Defaults to `None`.
- `exclude_domains` (Sequence[str], optional): A list of domains to exclude from the search. Defaults to `None`.
- `include_answer` (Union[bool, Literal["basic", "advanced"]], optional): Whether to include a direct answer synthesized from the search results. Defaults to `False`.
- `include_raw_content` (bool, optional): Whether to include the raw HTML content of the searched pages. Defaults to `False`.
- `include_images` (bool, optional): Whether to include image results. Defaults to `False`.
- `timeout` (int, optional): The request timeout in seconds. Defaults to `60`.
## Advanced Usage
You can configure the tool with custom parameters:
```python
# Example: Initialize with specific parameters
custom_tavily_tool = TavilySearchTool(
search_depth='advanced',
max_results=10,
include_answer=True
)
# The agent will use these defaults
agent_with_custom_tool = Agent(
role="Advanced Researcher",
goal="Conduct detailed research with comprehensive results",
tools=[custom_tavily_tool]
)
```
## Features
- **Comprehensive Search**: Access to Tavily's powerful search index
- **Configurable Depth**: Choose between basic and advanced search modes
- **Topic Filtering**: Focus searches on general, news, or finance topics
- **Time Range Control**: Limit results to specific time periods
- **Domain Control**: Include or exclude specific domains
- **Direct Answers**: Get synthesized answers from search results
- **Content Filtering**: Prevent context window issues with automatic content truncation
## Response Format
The tool returns search results as a JSON string containing:
- Search results with titles, URLs, and content snippets
- Optional direct answers to queries
- Optional image results
- Optional raw HTML content (when enabled)
Content for each result is automatically truncated to prevent context window issues while maintaining the most relevant information.

View File

@@ -0,0 +1,31 @@
---
title: Overview
description: Integrations for deploying and automating crews with external platforms
icon: face-smile
mode: "wide"
---
## Available Integrations
<CardGroup cols={2}>
<Card
title="Bedrock Invoke Agent Tool"
icon="cloud"
href="/en/tools/tool-integrations/bedrockinvokeagenttool"
color="#0891B2"
>
Invoke Amazon Bedrock Agents from CrewAI to orchestrate actions across AWS services.
</Card>
<Card
title="CrewAI Automation Tool"
icon="bolt"
href="/en/tools/tool-integrations/crewaiautomationtool"
color="#7C3AED"
>
Automate deployment and operations by integrating CrewAI with external platforms and workflows.
</Card>
</CardGroup>
Use these integrations to connect CrewAI with your infrastructure and workflows.

View File

@@ -0,0 +1,112 @@
---
title: Bright Data Tools
description: Bright Data integrations for SERP search, Web Unlocker scraping, and Dataset API.
icon: spider
mode: "wide"
---
# Bright Data Tools
This set of tools integrates Bright Data services for web extraction.
## Installation
```shell
uv add crewai-tools requests aiohttp
```
## Environment Variables
- `BRIGHT_DATA_API_KEY` (required)
- `BRIGHT_DATA_ZONE` (for SERP/Web Unlocker)
Create credentials at https://brightdata.com/ (sign up, then create an API token and zone).
See their docs: https://developers.brightdata.com/
## Included Tools
- `BrightDataSearchTool`: SERP search (Google/Bing/Yandex) with geo/language/device options.
- `BrightDataWebUnlockerTool`: Scrape pages with anti-bot bypass and rendering.
- `BrightDataDatasetTool`: Run Dataset API jobs and fetch results.
## Examples
### SERP Search
```python Code
from crewai_tools import BrightDataSearchTool
tool = BrightDataSearchTool(
query="CrewAI",
country="us",
)
print(tool.run())
```
### Web Unlocker
```python Code
from crewai_tools import BrightDataWebUnlockerTool
tool = BrightDataWebUnlockerTool(
url="https://example.com",
format="markdown",
)
print(tool.run(url="https://example.com"))
```
### Dataset API
```python Code
from crewai_tools import BrightDataDatasetTool
tool = BrightDataDatasetTool(
dataset_type="ecommerce",
url="https://example.com/product",
)
print(tool.run())
```
## Troubleshooting
- 401/403: verify `BRIGHT_DATA_API_KEY` and `BRIGHT_DATA_ZONE`.
- Empty/blocked content: enable rendering or try a different zone.
## Example
```python Code
from crewai import Agent, Task, Crew
from crewai_tools import BrightDataSearchTool
tool = BrightDataSearchTool(
query="CrewAI",
country="us",
)
agent = Agent(
role="Web Researcher",
goal="Search with Bright Data",
backstory="Finds reliable results",
tools=[tool],
verbose=True,
)
task = Task(
description="Search for CrewAI and summarize top results",
expected_output="Short summary with links",
agent=agent,
)
crew = Crew(
agents=[agent],
tasks=[task],
verbose=True,
)
result = crew.kickoff()
```

View File

@@ -0,0 +1,101 @@
---
title: Serper Scrape Website
description: The `SerperScrapeWebsiteTool` is designed to scrape websites and extract clean, readable content using Serper's scraping API.
icon: globe
mode: "wide"
---
# `SerperScrapeWebsiteTool`
## Description
This tool is designed to scrape website content and extract clean, readable text from any website URL. It utilizes the [serper.dev](https://serper.dev) scraping API to fetch and process web pages, optionally including markdown formatting for better structure and readability.
## Installation
To effectively use the `SerperScrapeWebsiteTool`, follow these steps:
1. **Package Installation**: Confirm that the `crewai[tools]` package is installed in your Python environment.
2. **API Key Acquisition**: Acquire a `serper.dev` API key by registering for an account at `serper.dev`.
3. **Environment Configuration**: Store your obtained API key in an environment variable named `SERPER_API_KEY` to facilitate its use by the tool.
To incorporate this tool into your project, follow the installation instructions below:
```shell
pip install 'crewai[tools]'
```
## Example
The following example demonstrates how to initialize the tool and scrape a website:
```python Code
from crewai_tools import SerperScrapeWebsiteTool
# Initialize the tool for website scraping capabilities
tool = SerperScrapeWebsiteTool()
# Scrape a website with markdown formatting
result = tool.run(url="https://example.com", include_markdown=True)
```
## Arguments
The `SerperScrapeWebsiteTool` accepts the following arguments:
- **url**: Required. The URL of the website to scrape.
- **include_markdown**: Optional. Whether to include markdown formatting in the scraped content. Defaults to `True`.
## Example with Parameters
Here is an example demonstrating how to use the tool with different parameters:
```python Code
from crewai_tools import SerperScrapeWebsiteTool
tool = SerperScrapeWebsiteTool()
# Scrape with markdown formatting (default)
markdown_result = tool.run(
url="https://docs.crewai.com",
include_markdown=True
)
# Scrape without markdown formatting for plain text
plain_result = tool.run(
url="https://docs.crewai.com",
include_markdown=False
)
print("Markdown formatted content:")
print(markdown_result)
print("\nPlain text content:")
print(plain_result)
```
## Use Cases
The `SerperScrapeWebsiteTool` is particularly useful for:
- **Content Analysis**: Extract and analyze website content for research purposes
- **Data Collection**: Gather structured information from web pages
- **Documentation Processing**: Convert web-based documentation into readable formats
- **Competitive Analysis**: Scrape competitor websites for market research
- **Content Migration**: Extract content from existing websites for migration purposes
## Error Handling
The tool includes comprehensive error handling for:
- **Network Issues**: Handles connection timeouts and network errors gracefully
- **API Errors**: Provides detailed error messages for API-related issues
- **Invalid URLs**: Validates and reports issues with malformed URLs
- **Authentication**: Clear error messages for missing or invalid API keys
## Security Considerations
- Always store your `SERPER_API_KEY` in environment variables, never hardcode it in your source code
- Be mindful of rate limits imposed by the Serper API
- Respect robots.txt and website terms of service when scraping content
- Consider implementing delays between requests for large-scale scraping operations