andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2026-01-29 18:18:13 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

adjust aop to amp docs lang (#4179)
Some checks failed
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
Details
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Details
Check Documentation Broken Links / Check broken links (push) Has been cancelled
Details
Notify Downstream / notify-downstream (push) Has been cancelled
Details
Mark stale issues and pull requests / stale (push) Has been cancelled
Details

Browse Source 
* adjust aop to amp docs lang

* whoop no print
This commit is contained in:
Lorenze Jay
2026-01-05 15:30:21 -08:00
committed by GitHub
parent f8deb0fd18
commit 25c0c030ce
203 changed files with 5176 additions and 2715 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/en/enterprise/features/rbac.mdx
View File

@@ -7,10 +7,10 @@ mode: "wide"
## Overview
RBAC in CrewAI AOP enables secure, scalable access management through a combination of organization‑level roles and automation‑level visibility controls.
RBAC in CrewAI AMP enables secure, scalable access management through a combination of organization‑level roles and automation‑level visibility controls.
<Frame>
<img src="/images/enterprise/users_and_roles.png" alt="RBAC overview in CrewAI AOP" />
<img src="/images/enterprise/users_and_roles.png" alt="RBAC overview in CrewAI AMP" />
</Frame>
@@ -28,10 +28,11 @@ You can configure users and roles in Settings → Roles.
<Steps>
<Step title="Open Roles settings">
Go to <b>Settings → Roles</b> in CrewAI AOP.
Go to <b>Settings → Roles</b> in CrewAI AMP.
</Step>
<Step title="Choose a role type">
Use a predefined role (<b>Owner</b>, <b>Member</b>) or click <b>Create role</b> to define a custom one.
Use a predefined role (<b>Owner</b>, <b>Member</b>) or click{" "}
<b>Create role</b> to define a custom one.
</Step>
<Step title="Assign to members">
Select users and assign the role. You can change this anytime.
@@ -40,10 +41,10 @@ You can configure users and roles in Settings → Roles.
### Configuration summary
| Area | Where to configure | Options |
|:---|:---|:---|
| Users & Roles | Settings → Roles | Predefined: Owner, Member; Custom roles |
| Automation visibility | Automation → Settings → Visibility | Private; Whitelist users/roles |
| Area | Where to configure | Options |
| :-------------------- | :--------------------------------- | :-------------------------------------- |
| Users & Roles | Settings → Roles | Predefined: Owner, Member; Custom roles |
| Automation visibility | Automation → Settings → Visibility | Private; Whitelist users/roles |
## Automation‑level Access Control
@@ -70,30 +71,34 @@ You can configure automation‑level access control in Automation → Settings
Navigate to <b>Automation → Settings → Visibility</b>.
</Step>
<Step title="Set visibility">
Choose <b>Private</b> to restrict access. The organization owner always retains access.
Choose <b>Private</b> to restrict access. The organization owner always
retains access.
</Step>
<Step title="Whitelist access">
Add specific users and roles allowed to view, run, and access logs/metrics/settings.
Add specific users and roles allowed to view, run, and access
logs/metrics/settings.
</Step>
<Step title="Save and verify">
Save changes, then confirm that non‑whitelisted users cannot view or run the automation.
Save changes, then confirm that non‑whitelisted users cannot view or run the
automation.
</Step>
</Steps>
### Private visibility: access outcomes
| Action | Owner | Whitelisted user/role | Not whitelisted |
|:---|:---|:---|:---|
| View automation | ✓ | ✓ | ✗ |
| Run automation/API | ✓ | ✓ | ✗ |
| Access logs/metrics/settings | ✓ | ✓ | ✗ |
| Action | Owner | Whitelisted user/role | Not whitelisted |
| :--------------------------- | :---- | :-------------------- | :-------------- |
| View automation | ✓ | ✓ | ✗ |
| Run automation/API | ✓ | ✓ | ✗ |
| Access logs/metrics/settings | ✓ | ✓ | ✗ |
<Tip>
The organization owner always has access. In private mode, only whitelisted users and roles can view, run, and access logs/metrics/settings.
The organization owner always has access. In private mode, only whitelisted
users and roles can view, run, and access logs/metrics/settings.
</Tip>
<Frame>
<img src="/images/enterprise/visibility.png" alt="Automation Visibility settings in CrewAI AOP" />
<img src="/images/enterprise/visibility.png" alt="Automation Visibility settings in CrewAI AMP" />
</Frame>

346
docs/en/enterprise/features/tools-and-integrations.mdx
View File

@@ -18,222 +18,226 @@ Tools & Integrations is the central hub for connecting third‑party apps and ma
<Tabs>
<Tab title="Integrations" icon="plug">
## Agent Apps (Integrations)
## Agent Apps (Integrations)
Connect enterprise‑grade applications (e.g., Gmail, Google Drive, HubSpot, Slack) via OAuth to enable agent actions.
Connect enterprise‑grade applications (e.g., Gmail, Google Drive, HubSpot, Slack) via OAuth to enable agent actions.
<Steps>
<Step title="Connect">
Click <b>Connect</b> on an app and complete OAuth.
</Step>
<Step title="Configure">
Optionally adjust scopes, triggers, and action availability.
</Step>
<Step title="Use in Agents">
Connected services become available as tools for your agents.
</Step>
</Steps>
{" "}
<Steps>
<Step title="Connect">
Click <b>Connect</b> on an app and complete OAuth.
</Step>
<Step title="Configure">
Optionally adjust scopes, triggers, and action availability.
</Step>
<Step title="Use in Agents">
Connected services become available as tools for your agents.
</Step>
</Steps>
<Frame>
![Integrations Grid](/images/enterprise/agent-apps.png)
</Frame>
{" "}
<Frame>![Integrations Grid](/images/enterprise/agent-apps.png)</Frame>
### Connect your Account
### Connect your Account
1. Go to <Link href="https://app.crewai.com/crewai_plus/connectors">Integrations</Link>
2. Click <b>Connect</b> on the desired service
3. Complete the OAuth flow and grant scopes
4. Copy your Enterprise Token from <Link href="https://app.crewai.com/crewai_plus/settings/integrations">Integration Settings</Link>
1. Go to <Link href="https://app.crewai.com/crewai_plus/connectors">Integrations</Link>
2. Click <b>Connect</b> on the desired service
3. Complete the OAuth flow and grant scopes
4. Copy your Enterprise Token from <Link href="https://app.crewai.com/crewai_plus/settings/integrations">Integration Settings</Link>
<Frame>
![Enterprise Token](/images/enterprise/enterprise_action_auth_token.png)
</Frame>
{" "}
<Frame>
![Enterprise Token](/images/enterprise/enterprise_action_auth_token.png)
</Frame>
### Install Integration Tools
### Install Integration Tools
To use the integrations locally, you need to install the latest `crewai-tools` package.
To use the integrations locally, you need to install the latest `crewai-tools` package.
```bash
uv add crewai-tools
```
```bash
uv add crewai-tools
```
### Environment Variable Setup
### Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
</Note>
{" "}
<Note>
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"
```
```bash
export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"
```
Or add it to your `.env` file:
Or add it to your `.env` file:
```
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
```
```
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
```
### Usage Example
### Usage Example
<Tip>
Use the new streamlined approach to integrate enterprise apps. Simply specify the app and its actions directly in the Agent configuration.
</Tip>
{" "}
<Tip>
Use the new streamlined approach to integrate enterprise apps. Simply specify
the app and its actions directly in the Agent configuration.
</Tip>
```python
from crewai import Agent, Task, Crew
```python
from crewai import Agent, Task, Crew
# Create an agent with Gmail capabilities
email_agent = Agent(
role="Email Manager",
goal="Manage and organize email communications",
backstory="An AI assistant specialized in email management and communication.",
apps=['gmail', 'gmail/send_email'] # Using canonical name 'gmail'
)
# Create an agent with Gmail capabilities
email_agent = Agent(
role="Email Manager",
goal="Manage and organize email communications",
backstory="An AI assistant specialized in email management and communication.",
apps=['gmail', 'gmail/send_email'] # Using canonical name 'gmail'
)
# Task to send an email
email_task = Task(
description="Draft and send a follow-up email to john@example.com about the project update",
agent=email_agent,
expected_output="Confirmation that email was sent successfully"
)
# Task to send an email
email_task = Task(
description="Draft and send a follow-up email to john@example.com about the project update",
agent=email_agent,
expected_output="Confirmation that email was sent successfully"
)
# Run the task
crew = Crew(
agents=[email_agent],
tasks=[email_task]
)
# Run the task
crew = Crew(
agents=[email_agent],
tasks=[email_task]
)
# Run the crew
crew.kickoff()
```
# Run the crew
crew.kickoff()
```
### Filtering Tools
### Filtering Tools
```python
from crewai import Agent, Task, Crew
```python
from crewai import Agent, Task, Crew
# Create agent with specific Gmail actions only
gmail_agent = Agent(
role="Gmail Manager",
goal="Manage gmail communications and notifications",
backstory="An AI assistant that helps coordinate gmail communications.",
apps=['gmail/fetch_emails'] # Using canonical name with specific action
)
# Create agent with specific Gmail actions only
gmail_agent = Agent(
role="Gmail Manager",
goal="Manage gmail communications and notifications",
backstory="An AI assistant that helps coordinate gmail communications.",
apps=['gmail/fetch_emails'] # Using canonical name with specific action
)
notification_task = Task(
description="Find the email from john@example.com",
agent=gmail_agent,
expected_output="Email found from john@example.com"
)
notification_task = Task(
description="Find the email from john@example.com",
agent=gmail_agent,
expected_output="Email found from john@example.com"
)
crew = Crew(
agents=[gmail_agent],
tasks=[notification_task]
)
```
crew = Crew(
agents=[gmail_agent],
tasks=[notification_task]
)
```
On a deployed crew, you can specify which actions are available for each integration from the service settings page.
On a deployed crew, you can specify which actions are available for each integration from the service settings page.
<Frame>
![Filter Actions](/images/enterprise/filtering_enterprise_action_tools.png)
</Frame>
{" "}
<Frame>
![Filter Actions](/images/enterprise/filtering_enterprise_action_tools.png)
</Frame>
### Scoped Deployments (multi‑user orgs)
### Scoped Deployments (multi‑user orgs)
You can scope each integration to a specific user. For example, a crew that connects to Google can use a specific user’s Gmail account.
You can scope each integration to a specific user. For example, a crew that connects to Google can use a specific user’s Gmail account.
<Tip>
Useful when different teams/users must keep data access separated.
</Tip>
{" "}
<Tip>Useful when different teams/users must keep data access separated.</Tip>
Use the `user_bearer_token` to scope authentication to the requesting user. If the user isn’t logged in, the crew won’t use connected integrations. Otherwise it falls back to the default bearer token configured for the deployment.
Use the `user_bearer_token` to scope authentication to the requesting user. If the user isn’t logged in, the crew won’t use connected integrations. Otherwise it falls back to the default bearer token configured for the deployment.
<Frame>
![User Bearer Token](/images/enterprise/user_bearer_token.png)
</Frame>
{" "}
<Frame>![User Bearer Token](/images/enterprise/user_bearer_token.png)</Frame>
<div id="catalog"></div>
### Catalog
{" "}
<div id="catalog"></div>
### Catalog
#### Communication & Collaboration
- Gmail — Manage emails and drafts
- Slack — Workspace notifications and alerts
- Microsoft — Office 365 and Teams integration
#### Communication & Collaboration
#### Project Management
- Jira — Issue tracking and project management
- ClickUp — Task and productivity management
- Asana — Team task and project coordination
- Notion — Page and database management
- Linear — Software project and bug tracking
- GitHub — Repository and issue management
- Gmail — Manage emails and drafts
- Slack — Workspace notifications and alerts
- Microsoft — Office 365 and Teams integration
#### Customer Relationship Management
- Salesforce — CRM account and opportunity management
- HubSpot — Sales pipeline and contact management
- Zendesk — Customer support ticket management
#### Project Management
#### Business & Finance
- Stripe — Payment processing and customer management
- Shopify — E‑commerce store and product management
- Jira — Issue tracking and project management
- ClickUp — Task and productivity management
- Asana — Team task and project coordination
- Notion — Page and database management
- Linear — Software project and bug tracking
- GitHub — Repository and issue management
#### Productivity & Storage
- Google Sheets — Spreadsheet data synchronization
- Google Calendar — Event and schedule management
- Box — File storage and document management
#### Customer Relationship Management
…and more to come!
- Salesforce — CRM account and opportunity management
- HubSpot — Sales pipeline and contact management
- Zendesk — Customer support ticket management
#### Business & Finance
- Stripe — Payment processing and customer management
- Shopify — E‑commerce store and product management
#### Productivity & Storage
- Google Sheets — Spreadsheet data synchronization
- Google Calendar — Event and schedule management
- Box — File storage and document management
…and more to come!
</Tab>
<Tab title="Internal Tools" icon="toolbox">
## Internal Tools
## Internal Tools
Create custom tools locally, publish them on CrewAI AOP Tool Repository and use them in your agents.
Create custom tools locally, publish them on CrewAI AMP Tool Repository and use them in your agents.
<Tip>
Before running the commands below, make sure you log in to your CrewAI AOP account by running this command:
```bash
crewai login
```
</Tip>
{" "}
<Tip>
Before running the commands below, make sure you log in to your CrewAI AMP
account by running this command: ```bash crewai login ```
</Tip>
<Frame>
![Internal Tool Detail](/images/enterprise/tools-integrations-internal.png)
</Frame>
{" "}
<Frame>
![Internal Tool Detail](/images/enterprise/tools-integrations-internal.png)
</Frame>
<Steps>
<Step title="Create">
Create a new tool locally.
```bash
crewai tool create your-tool
```
</Step>
<Step title="Publish">
Publish the tool to the CrewAI AOP Tool Repository.
```bash
crewai tool publish
```
</Step>
<Step title="Install">
Install the tool from the CrewAI AOP Tool Repository.
```bash
crewai tool install your-tool
```
</Step>
</Steps>
{" "}
<Steps>
<Step title="Create">
Create a new tool locally. ```bash crewai tool create your-tool ```
</Step>
<Step title="Publish">
Publish the tool to the CrewAI AMP Tool Repository. ```bash crewai tool
publish ```
</Step>
<Step title="Install">
Install the tool from the CrewAI AMP Tool Repository. ```bash crewai tool
install your-tool ```
</Step>
</Steps>
Manage:
Manage:
- Name and description
- Visibility (Private / Public)
- Required environment variables
- Version history and downloads
- Team and role access
- Name and description
- Visibility (Private / Public)
- Required environment variables
- Version history and downloads
- Team and role access
<Frame>
![Internal Tool Detail](/images/enterprise/tool-configs.png)
</Frame>
{" "}
<Frame>![Internal Tool Detail](/images/enterprise/tool-configs.png)</Frame>
</Tab>
</Tabs>
@@ -241,10 +245,18 @@ Tools & Integrations is the central hub for connecting third‑party apps and ma
## Related
<CardGroup cols={2}>
<Card title="Tool Repository" href="/en/enterprise/guides/tool-repository#tool-repository" icon="toolbox">
<Card
title="Tool Repository"
href="/en/enterprise/guides/tool-repository#tool-repository"
icon="toolbox"
>
Create, publish, and version custom tools for your organization.
</Card>
<Card title="Webhook Automation" href="/en/enterprise/guides/webhook-automation" icon="bolt">
<Card
title="Webhook Automation"
href="/en/enterprise/guides/webhook-automation"
icon="bolt"
>
Automate workflows and integrate with external platforms and services.
</Card>
</CardGroup>

35
docs/en/enterprise/features/traces.mdx
View File

@@ -11,7 +11,7 @@ Traces provide comprehensive visibility into your crew executions, helping you m
## What are Traces?
Traces in CrewAI AOP are detailed execution records that capture every aspect of your crew's operation, from initial inputs to final outputs. They record:
Traces in CrewAI AMP are detailed execution records that capture every aspect of your crew's operation, from initial inputs to final outputs. They record:
- Agent thoughts and reasoning
- Task execution details
@@ -20,15 +20,13 @@ Traces in CrewAI AOP are detailed execution records that capture every aspect of
- Execution times
- Cost estimates
<Frame>
![Traces Overview](/images/enterprise/traces-overview.png)
</Frame>
<Frame>![Traces Overview](/images/enterprise/traces-overview.png)</Frame>
## Accessing Traces
<Steps>
<Step title="Navigate to the Traces Tab">
Once in your CrewAI AOP dashboard, click on the **Traces** to view all execution records.
Once in your CrewAI AMP dashboard, click on the **Traces** to view all execution records.
</Step>
<Step title="Select an Execution">
@@ -51,9 +49,7 @@ The top section displays high-level metrics about the execution:
- **Execution Time**: Total duration of the crew run
- **Estimated Cost**: Approximate cost based on token usage
<Frame>
![Execution Summary](/images/enterprise/trace-summary.png)
</Frame>
<Frame>![Execution Summary](/images/enterprise/trace-summary.png)</Frame>
### 2. Tasks & Agents
@@ -64,33 +60,25 @@ This section shows all tasks and agents that were part of the crew execution:
- Status (completed/failed)
- Individual execution time of the task
<Frame>
![Task List](/images/enterprise/trace-tasks.png)
</Frame>
<Frame>![Task List](/images/enterprise/trace-tasks.png)</Frame>
### 3. Final Output
Displays the final result produced by the crew after all tasks are completed.
<Frame>
![Final Output](/images/enterprise/final-output.png)
</Frame>
<Frame>![Final Output](/images/enterprise/final-output.png)</Frame>
### 4. Execution Timeline
A visual representation of when each task started and ended, helping you identify bottlenecks or parallel execution patterns.
<Frame>
![Execution Timeline](/images/enterprise/trace-timeline.png)
</Frame>
<Frame>![Execution Timeline](/images/enterprise/trace-timeline.png)</Frame>
### 5. Detailed Task View
When you click on a specific task in the timeline or task list, you'll see:
<Frame>
![Detailed Task View](/images/enterprise/trace-detailed-task.png)
</Frame>
<Frame>![Detailed Task View](/images/enterprise/trace-detailed-task.png)</Frame>
- **Task Key**: Unique identifier for the task
- **Task ID**: Technical identifier in the system
@@ -104,7 +92,6 @@ When you click on a specific task in the timeline or task list, you'll see:
- **Input**: Any input provided to this task from previous tasks
- **Output**: The actual result produced by the agent
## Using Traces for Debugging
Traces are invaluable for troubleshooting issues with your crews:
@@ -121,6 +108,7 @@ Traces are invaluable for troubleshooting issues with your crews:
<Frame>
![Failure Points](/images/enterprise/failure.png)
</Frame>
</Step>
<Step title="Optimize Performance">
@@ -130,6 +118,7 @@ Traces are invaluable for troubleshooting issues with your crews:
- Excessive token usage
- Redundant tool operations
- Unnecessary API calls
</Step>
<Step title="Improve Cost Efficiency">
@@ -139,6 +128,7 @@ Traces are invaluable for troubleshooting issues with your crews:
- Refine prompts to be more concise
- Cache frequently accessed information
- Structure tasks to minimize redundant operations
</Step>
</Steps>
@@ -153,5 +143,6 @@ CrewAI batches trace uploads to reduce overhead on high-volume runs:
This yields more stable tracing under load while preserving detailed task/agent telemetry.
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with trace analysis or any other CrewAI AOP features.
Contact our support team for assistance with trace analysis or any other
CrewAI AMP features.
</Card>

147
docs/en/enterprise/features/webhook-streaming.mdx
View File

@@ -8,7 +8,7 @@ mode: "wide"
## Overview
Enterprise Event Streaming lets you receive real-time webhook updates about your crews and flows deployed to
CrewAI AOP, such as model calls, tool usage, and flow steps.
CrewAI AMP, such as model calls, tool usage, and flow steps.
## Usage
@@ -16,7 +16,7 @@ When using the Kickoff API, include a `webhooks` object to your request, for exa
```json
{
"inputs": {"foo": "bar"},
"inputs": { "foo": "bar" },
"webhooks": {
"events": ["crew_kickoff_started", "llm_call_started"],
"url": "https://your.endpoint/webhook",
@@ -46,8 +46,8 @@ Each webhook sends a list of events:
"data": {
"model": "gpt-4",
"messages": [
{"role": "system", "content": "You are an assistant."},
{"role": "user", "content": "Summarize this article."}
{ "role": "system", "content": "You are an assistant." },
{ "role": "user", "content": "Summarize this article." }
]
}
}
@@ -65,104 +65,109 @@ CrewAI supports both system events and custom events in Enterprise Event Streami
### Flow Events:
- `flow_created`
- `flow_started`
- `flow_finished`
- `flow_plot`
- `method_execution_started`
- `method_execution_finished`
- `method_execution_failed`
- `flow_created`
- `flow_started`
- `flow_finished`
- `flow_plot`
- `method_execution_started`
- `method_execution_finished`
- `method_execution_failed`
### Agent Events:
- `agent_execution_started`
- `agent_execution_completed`
- `agent_execution_error`
- `lite_agent_execution_started`
- `lite_agent_execution_completed`
- `lite_agent_execution_error`
- `agent_logs_started`
- `agent_logs_execution`
- `agent_evaluation_started`
- `agent_evaluation_completed`
- `agent_evaluation_failed`
- `agent_execution_started`
- `agent_execution_completed`
- `agent_execution_error`
- `lite_agent_execution_started`
- `lite_agent_execution_completed`
- `lite_agent_execution_error`
- `agent_logs_started`
- `agent_logs_execution`
- `agent_evaluation_started`
- `agent_evaluation_completed`
- `agent_evaluation_failed`
### Crew Events:
- `crew_kickoff_started`
- `crew_kickoff_completed`
- `crew_kickoff_failed`
- `crew_train_started`
- `crew_train_completed`
- `crew_train_failed`
- `crew_test_started`
- `crew_test_completed`
- `crew_test_failed`
- `crew_test_result`
- `crew_kickoff_started`
- `crew_kickoff_completed`
- `crew_kickoff_failed`
- `crew_train_started`
- `crew_train_completed`
- `crew_train_failed`
- `crew_test_started`
- `crew_test_completed`
- `crew_test_failed`
- `crew_test_result`
### Task Events:
- `task_started`
- `task_completed`
- `task_failed`
- `task_evaluation`
- `task_started`
- `task_completed`
- `task_failed`
- `task_evaluation`
### Tool Usage Events:
- `tool_usage_started`
- `tool_usage_finished`
- `tool_usage_error`
- `tool_validate_input_error`
- `tool_selection_error`
- `tool_execution_error`
- `tool_usage_started`
- `tool_usage_finished`
- `tool_usage_error`
- `tool_validate_input_error`
- `tool_selection_error`
- `tool_execution_error`
### LLM Events:
- `llm_call_started`
- `llm_call_completed`
- `llm_call_failed`
- `llm_stream_chunk`
- `llm_call_started`
- `llm_call_completed`
- `llm_call_failed`
- `llm_stream_chunk`
### LLM Guardrail Events:
- `llm_guardrail_started`
- `llm_guardrail_completed`
- `llm_guardrail_started`
- `llm_guardrail_completed`
### Memory Events:
- `memory_query_started`
- `memory_query_completed`
- `memory_query_failed`
- `memory_save_started`
- `memory_save_completed`
- `memory_save_failed`
- `memory_retrieval_started`
- `memory_retrieval_completed`
- `memory_query_started`
- `memory_query_completed`
- `memory_query_failed`
- `memory_save_started`
- `memory_save_completed`
- `memory_save_failed`
- `memory_retrieval_started`
- `memory_retrieval_completed`
### Knowledge Events:
- `knowledge_search_query_started`
- `knowledge_search_query_completed`
- `knowledge_search_query_failed`
- `knowledge_query_started`
- `knowledge_query_completed`
- `knowledge_query_failed`
- `knowledge_search_query_started`
- `knowledge_search_query_completed`
- `knowledge_search_query_failed`
- `knowledge_query_started`
- `knowledge_query_completed`
- `knowledge_query_failed`
### Reasoning Events:
- `agent_reasoning_started`
- `agent_reasoning_completed`
- `agent_reasoning_failed`
- `agent_reasoning_started`
- `agent_reasoning_completed`
- `agent_reasoning_failed`
Event names match the internal event bus. See GitHub for the full list of events.
You can emit your own custom events, and they will be delivered through the webhook stream alongside system events.
<CardGroup>
<Card title="GitHub" icon="github" href="https://github.com/crewAIInc/crewAI/tree/main/src/crewai/utilities/events">
Full list of events
</Card>
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with webhook integration or troubleshooting.
</Card>
<Card
title="GitHub"
icon="github"
href="https://github.com/crewAIInc/crewAI/tree/main/src/crewai/utilities/events"
>
Full list of events
</Card>
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with webhook integration or
troubleshooting.
</Card>
</CardGroup>

107
docs/en/enterprise/guides/automation-triggers.mdx
View File

@@ -1,11 +1,11 @@
---
title: "Triggers Overview"
description: "Understand how CrewAI AOP triggers work, how to manage them, and where to find integration-specific playbooks"
description: "Understand how CrewAI AMP triggers work, how to manage them, and where to find integration-specific playbooks"
icon: "face-smile"
mode: "wide"
---
CrewAI AOP triggers connect your automations to real-time events across the tools your teams already use. Instead of polling systems or relying on manual kickoffs, triggers listen for changes—new emails, calendar updates, CRM status changes—and immediately launch the crew or flow you specify.
CrewAI AMP triggers connect your automations to real-time events across the tools your teams already use. Instead of polling systems or relying on manual kickoffs, triggers listen for changes—new emails, calendar updates, CRM status changes—and immediately launch the crew or flow you specify.
<Frame>
![Automation Triggers Overview](/images/enterprise/crew_connectors.png)
@@ -20,37 +20,61 @@ Deep-dive guides walk through setup and sample workflows for each integration:
<a href="/en/enterprise/guides/gmail-trigger">Enable crews when emails arrive or threads update.</a>
</Card>
<Card title="Google Calendar Trigger" icon="calendar-days">
<a href="/en/enterprise/guides/google-calendar-trigger">React to calendar events as they are created, updated, or cancelled.</a>
</Card>
{" "}
<Card title="Google Calendar Trigger" icon="calendar-days">
<a href="/en/enterprise/guides/google-calendar-trigger">
React to calendar events as they are created, updated, or cancelled.
</a>
</Card>
<Card title="Google Drive Trigger" icon="folder-open">
<a href="/en/enterprise/guides/google-drive-trigger">Handle Drive file uploads, edits, and deletions.</a>
</Card>
{" "}
<Card title="Google Drive Trigger" icon="folder-open">
<a href="/en/enterprise/guides/google-drive-trigger">
Handle Drive file uploads, edits, and deletions.
</a>
</Card>
<Card title="Outlook Trigger" icon="envelope-open">
<a href="/en/enterprise/guides/outlook-trigger">Automate responses to new Outlook messages and calendar updates.</a>
</Card>
{" "}
<Card title="Outlook Trigger" icon="envelope-open">
<a href="/en/enterprise/guides/outlook-trigger">
Automate responses to new Outlook messages and calendar updates.
</a>
</Card>
<Card title="OneDrive Trigger" icon="cloud">
<a href="/en/enterprise/guides/onedrive-trigger">Audit file activity and sharing changes in OneDrive.</a>
</Card>
{" "}
<Card title="OneDrive Trigger" icon="cloud">
<a href="/en/enterprise/guides/onedrive-trigger">
Audit file activity and sharing changes in OneDrive.
</a>
</Card>
<Card title="Microsoft Teams Trigger" icon="comments">
<a href="/en/enterprise/guides/microsoft-teams-trigger">Kick off workflows when new Teams chats start.</a>
</Card>
{" "}
<Card title="Microsoft Teams Trigger" icon="comments">
<a href="/en/enterprise/guides/microsoft-teams-trigger">
Kick off workflows when new Teams chats start.
</a>
</Card>
<Card title="HubSpot Trigger" icon="hubspot">
<a href="/en/enterprise/guides/hubspot-trigger">Launch automations from HubSpot workflows and lifecycle events.</a>
</Card>
{" "}
<Card title="HubSpot Trigger" icon="hubspot">
<a href="/en/enterprise/guides/hubspot-trigger">
Launch automations from HubSpot workflows and lifecycle events.
</a>
</Card>
<Card title="Salesforce Trigger" icon="salesforce">
<a href="/en/enterprise/guides/salesforce-trigger">Connect Salesforce processes to CrewAI for CRM automation.</a>
</Card>
{" "}
<Card title="Salesforce Trigger" icon="salesforce">
<a href="/en/enterprise/guides/salesforce-trigger">
Connect Salesforce processes to CrewAI for CRM automation.
</a>
</Card>
<Card title="Slack Trigger" icon="slack">
<a href="/en/enterprise/guides/slack-trigger">Start crews directly from Slack slash commands.</a>
</Card>
{" "}
<Card title="Slack Trigger" icon="slack">
<a href="/en/enterprise/guides/slack-trigger">
Start crews directly from Slack slash commands.
</a>
</Card>
<Card title="Zapier Trigger" icon="bolt">
<a href="/en/enterprise/guides/zapier-trigger">Bridge CrewAI with thousands of Zapier-supported apps.</a>
@@ -76,7 +100,10 @@ To access and manage your automation triggers:
2. Click on the **Triggers** tab to view all available trigger integrations
<Frame caption="Example of available automation triggers for a Gmail deployment">
<img src="/images/enterprise/list-available-triggers.png" alt="List of available automation triggers" />
<img
src="/images/enterprise/list-available-triggers.png"
alt="List of available automation triggers"
/>
</Frame>
This view shows all the trigger integrations available for your deployment, along with their current connection status.
@@ -86,7 +113,10 @@ This view shows all the trigger integrations available for your deployment, alon
Each trigger can be easily enabled or disabled using the toggle switch:
<Frame caption="Enable or disable triggers with toggle">
<img src="/images/enterprise/trigger-selected.png" alt="Enable or disable triggers with toggle" />
<img
src="/images/enterprise/trigger-selected.png"
alt="Enable or disable triggers with toggle"
/>
</Frame>
- **Enabled (blue toggle)**: The trigger is active and will automatically execute your deployment when the specified events occur
@@ -99,7 +129,10 @@ Simply click the toggle to change the trigger state. Changes take effect immedia
Track the performance and history of your triggered executions:
<Frame caption="List of executions triggered by automation">
<img src="/images/enterprise/list-executions.png" alt="List of executions triggered by automation" />
<img
src="/images/enterprise/list-executions.png"
alt="List of executions triggered by automation"
/>
</Frame>
## Building Trigger-Driven Automations
@@ -130,6 +163,7 @@ crewai triggers list
```
This command displays all triggers available based on your connected integrations, showing:
- Integration name and connection status
- Available trigger types
- Trigger names and descriptions
@@ -149,6 +183,7 @@ crewai triggers run microsoft_onedrive/file_changed
```
This command:
- Executes your crew locally
- Passes a complete, realistic trigger payload
- Simulates exactly how your crew will be called in production
@@ -161,7 +196,6 @@ This command:
- If your crew expects parameters that aren't in the trigger payload, execution may fail
</Warning>
### Triggers with Crew
Your existing crew definitions work seamlessly with triggers, you just need to have a task to parse the received payload:
@@ -193,10 +227,12 @@ class MyAutomatedCrew:
The crew will automatically receive and can access the trigger payload through the standard CrewAI context mechanisms.
<Note>
Crew and Flow inputs can include `crewai_trigger_payload`. CrewAI automatically injects this payload:
- Tasks: appended to the first task's description by default ("Trigger Payload: {crewai_trigger_payload}")
- Control via `allow_crewai_trigger_context`: set `True` to always inject, `False` to never inject
- Flows: any `@start()` method that accepts a `crewai_trigger_payload` parameter will receive it
Crew and Flow inputs can include `crewai_trigger_payload`. CrewAI
automatically injects this payload: - Tasks: appended to the first task's
description by default ("Trigger Payload: {crewai_trigger_payload}") - Control
via `allow_crewai_trigger_context`: set `True` to always inject, `False` to
never inject - Flows: any `@start()` method that accepts a
`crewai_trigger_payload` parameter will receive it
</Note>
### Integration with Flows
@@ -264,17 +300,20 @@ def delegate_to_crew(self, crewai_trigger_payload: dict = None):
## Troubleshooting
**Trigger not firing:**
- Verify the trigger is enabled in your deployment's Triggers tab
- Check integration connection status under Tools & Integrations
- Ensure all required environment variables are properly configured
**Execution failures:**
- Check the execution logs for error details
- Use `crewai triggers run <trigger_name>` to test locally and see the exact payload structure
- Verify your crew can handle the `crewai_trigger_payload` parameter
- Ensure your crew doesn't expect parameters that aren't included in the trigger payload
**Development issues:**
- Always test with `crewai triggers run <trigger>` before deploying to see the complete payload
- Remember that `crewai run` does NOT simulate trigger calls—use `crewai triggers run` instead
- Use `crewai triggers list` to verify which triggers are available for your connected integrations

8
docs/en/enterprise/guides/azure-openai-setup.mdx
View File

@@ -19,8 +19,8 @@ This guide walks you through connecting Azure OpenAI with Crew Studio for seamle
</Frame>
</Step>
<Step title="Configure CrewAI AOP Connection">
4. In another tab, open `CrewAI AOP > LLM Connections`. Name your LLM Connection, select Azure as the provider, and choose the same model you selected in Azure.
<Step title="Configure CrewAI AMP Connection">
4. In another tab, open `CrewAI AMP > LLM Connections`. Name your LLM Connection, select Azure as the provider, and choose the same model you selected in Azure.
5. On the same page, add environment variables from step 3:
- One named `AZURE_DEPLOYMENT_TARGET_URL` (using the Target URI). The URL should look like this: https://your-deployment.openai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-08-01-preview
- Another named `AZURE_API_KEY` (using the Key).
@@ -28,7 +28,7 @@ This guide walks you through connecting Azure OpenAI with Crew Studio for seamle
</Step>
<Step title="Set Default Configuration">
7. In `CrewAI AOP > Settings > Defaults > Crew Studio LLM Settings`, set the new LLM Connection and model as defaults.
7. In `CrewAI AMP > Settings > Defaults > Crew Studio LLM Settings`, set the new LLM Connection and model as defaults.
</Step>
<Step title="Configure Network Access">
@@ -37,6 +37,7 @@ This guide walks you through connecting Azure OpenAI with Crew Studio for seamle
- Navigate to `Resource Management > Networking`.
- Ensure that `Allow access from all networks` is enabled. If this setting is restricted, CrewAI may be blocked from accessing your Azure OpenAI endpoint.
</Step>
</Steps>
## Verification
@@ -46,6 +47,7 @@ You're all set! Crew Studio will now use your Azure OpenAI connection. Test the
## Troubleshooting
If you encounter issues:
- Verify the Target URI format matches the expected pattern
- Check that the API key is correct and has proper permissions
- Ensure network access is configured to allow CrewAI connections

18
docs/en/enterprise/guides/build-crew.mdx
View File

@@ -7,7 +7,7 @@ mode: "wide"
## Overview
[CrewAI AOP](https://app.crewai.com) streamlines the process of **creating**, **deploying**, and **managing** your AI agents in production environments.
[CrewAI AMP](https://app.crewai.com) streamlines the process of **creating**, **deploying**, and **managing** your AI agents in production environments.
## Getting Started
@@ -22,21 +22,27 @@ mode: "wide"
### Installation and Setup
<Card title="Follow Standard Installation" icon="wrench" href="/en/installation">
Follow our standard installation guide to set up CrewAI CLI and create your first project.
<Card
title="Follow Standard Installation"
icon="wrench"
href="/en/installation"
>
Follow our standard installation guide to set up CrewAI CLI and create your
first project.
</Card>
### Building Your Crew
<Card title="Quickstart Tutorial" icon="rocket" href="/en/quickstart">
Follow our quickstart guide to create your first agent crew using YAML configuration.
Follow our quickstart guide to create your first agent crew using YAML
configuration.
</Card>
## Support and Resources
For Enterprise-specific support or questions, contact our dedicated support team at [support@crewai.com](mailto:support@crewai.com).
<Card title="Schedule a Demo" icon="calendar" href="mailto:support@crewai.com">
Book time with our team to learn more about Enterprise features and how they can benefit your organization.
Book time with our team to learn more about Enterprise features and how they
can benefit your organization.
</Card>

15
docs/en/enterprise/guides/capture_telemetry_logs.mdx
View File

@@ -1,11 +1,11 @@
---
title: "Open Telemetry Logs"
description: "Understand how to capture telemetry logs from your CrewAI AOP deployments"
description: "Understand how to capture telemetry logs from your CrewAI AMP deployments"
icon: "magnifying-glass-chart"
mode: "wide"
---
CrewAI AOP provides a powerful way to capture telemetry logs from your deployments. This allows you to monitor the performance of your agents and workflows, and to debug issues that may arise.
CrewAI AMP provides a powerful way to capture telemetry logs from your deployments. This allows you to monitor the performance of your agents and workflows, and to debug issues that may arise.
## Prerequisites
@@ -14,22 +14,17 @@ CrewAI AOP provides a powerful way to capture telemetry logs from your deploymen
Your organization should have ENTERPRISE OTEL SETUP enabled
</Card>
<Card title="OTEL collector setup" icon="server">
Your organization should have an OTEL collector setup or a provider like Datadog log intake setup
Your organization should have an OTEL collector setup or a provider like
Datadog log intake setup
</Card>
</CardGroup>
## How to capture telemetry logs
1. Go to settings/organization tab
2. Configure your OTEL collector setup
3. Save
Example to setup OTEL log collection capture to Datadog.
<Frame>
![Capture Telemetry Logs](/images/crewai-otel-export.png)
</Frame>
<Frame>![Capture Telemetry Logs](/images/crewai-otel-export.png)</Frame>

67
docs/en/enterprise/guides/deploy-crew.mdx
View File

@@ -1,22 +1,26 @@
---
title: "Deploy Crew"
description: "Deploying a Crew on CrewAI AOP"
description: "Deploying a Crew on CrewAI AMP"
icon: "rocket"
mode: "wide"
---
<Note>
After creating a crew locally or through Crew Studio, the next step is deploying it to the CrewAI AOP platform. This guide covers multiple deployment methods to help you choose the best approach for your workflow.
After creating a crew locally or through Crew Studio, the next step is
deploying it to the CrewAI AMP platform. This guide covers multiple deployment
methods to help you choose the best approach for your workflow.
</Note>
## Prerequisites
<CardGroup cols={2}>
<Card title="Crew Ready for Deployment" icon="users">
You should have a working crew either built locally or created through Crew Studio
You should have a working crew either built locally or created through Crew
Studio
</Card>
<Card title="GitHub Repository" icon="github">
Your crew code should be in a GitHub repository (for GitHub integration method)
Your crew code should be in a GitHub repository (for GitHub integration
method)
</Card>
</CardGroup>
@@ -39,10 +43,10 @@ The CLI provides the fastest way to deploy locally developed crews to the Enterp
</Step>
<Step title="Authenticate with the Enterprise Platform">
First, you need to authenticate your CLI with the CrewAI AOP platform:
First, you need to authenticate your CLI with the CrewAI AMP platform:
```bash
# If you already have a CrewAI AOP account, or want to create one:
# If you already have a CrewAI AMP account, or want to create one:
crewai login
```
@@ -105,38 +109,38 @@ The CLI provides the fastest way to deploy locally developed crews to the Enterp
The CrewAI CLI offers several commands to manage your deployments:
```bash
# List all your deployments
crewai deploy list
```bash
# List all your deployments
crewai deploy list
# Get the status of your deployment
crewai deploy status
# Get the status of your deployment
crewai deploy status
# View the logs of your deployment
crewai deploy logs
# View the logs of your deployment
crewai deploy logs
# Push updates after code changes
crewai deploy push
# Push updates after code changes
crewai deploy push
# Remove a deployment
crewai deploy remove <deployment_id>
```
# Remove a deployment
crewai deploy remove <deployment_id>
```
## Option 2: Deploy Directly via Web Interface
You can also deploy your crews directly through the CrewAI AOP web interface by connecting your GitHub account. This approach doesn't require using the CLI on your local machine.
You can also deploy your crews directly through the CrewAI AMP web interface by connecting your GitHub account. This approach doesn't require using the CLI on your local machine.
<Steps>
<Step title="Pushing to GitHub">
You need to push your crew to a GitHub repository. If you haven't created a crew yet, you can [follow this tutorial](/en/quickstart).
You need to push your crew to a GitHub repository. If you haven't created a crew yet, you can [follow this tutorial](/en/quickstart).
</Step>
<Step title="Connecting GitHub to CrewAI AOP">
<Step title="Connecting GitHub to CrewAI AMP">
1. Log in to [CrewAI AOP](https://app.crewai.com)
1. Log in to [CrewAI AMP](https://app.crewai.com)
2. Click on the button "Connect GitHub"
<Frame>
@@ -194,7 +198,7 @@ For automated deployments in CI/CD pipelines, you can use the CrewAI API to trig
<Steps>
<Step title="Get Your Personal Access Token">
Navigate to your CrewAI AOP account settings to generate an API token:
Navigate to your CrewAI AMP account settings to generate an API token:
1. Go to [app.crewai.com](https://app.crewai.com)
2. Click on **Settings** → **Account** → **Personal Access Token**
@@ -207,7 +211,7 @@ For automated deployments in CI/CD pipelines, you can use the CrewAI API to trig
Locate the unique identifier for your deployed crew:
1. Go to **Automations** in your CrewAI AOP dashboard
1. Go to **Automations** in your CrewAI AMP dashboard
2. Select your existing automation/crew
3. Click on **Additional Details**
4. Copy the **UUID** - this identifies your specific crew deployment
@@ -238,7 +242,6 @@ For automated deployments in CI/CD pipelines, you can use the CrewAI API to trig
If your automation was first created connected to Git, the API will automatically pull the latest changes from your repository before redeploying.
</Info>
</Step>
<Step title="GitHub Actions Integration Example">
@@ -276,12 +279,14 @@ For automated deployments in CI/CD pipelines, you can use the CrewAI API to trig
</Tip>
</Step>
</Steps>
## ⚠️ Environment Variable Security Requirements
<Warning>
**Important**: CrewAI AOP has security restrictions on environment variable names that can cause deployment failures if not followed.
**Important**: CrewAI AMP has security restrictions on environment variable
names that can cause deployment failures if not followed.
</Warning>
### Blocked Environment Variable Patterns
@@ -289,12 +294,14 @@ For automated deployments in CI/CD pipelines, you can use the CrewAI API to trig
For security reasons, the following environment variable naming patterns are **automatically filtered** and will cause deployment issues:
**Blocked Patterns:**
- Variables ending with `_TOKEN` (e.g., `MY_API_TOKEN`)
- Variables ending with `_PASSWORD` (e.g., `DB_PASSWORD`)
- Variables ending with `_SECRET` (e.g., `API_SECRET`)
- Variables ending with `_KEY` in certain contexts
**Specific Blocked Variables:**
- `GITHUB_USER`, `GITHUB_TOKEN`
- `AWS_REGION`, `AWS_DEFAULT_REGION`
- Various internal CrewAI system variables
@@ -302,6 +309,7 @@ For security reasons, the following environment variable naming patterns are **a
### Allowed Exceptions
Some variables are explicitly allowed despite matching blocked patterns:
- `AZURE_AD_TOKEN`
- `AZURE_OPENAI_AD_TOKEN`
- `ENTERPRISE_ACTION_TOKEN`
@@ -331,7 +339,8 @@ API_CONFIG=secret123
4. **Document changes**: Keep track of renamed variables for your team
<Tip>
If you encounter deployment failures with cryptic environment variable errors, check your variable names against these patterns first.
If you encounter deployment failures with cryptic environment variable errors,
check your variable names against these patterns first.
</Tip>
### Interact with Your Deployed Crew
@@ -339,6 +348,7 @@ If you encounter deployment failures with cryptic environment variable errors, c
Once deployment is complete, you can access your crew through:
1. **REST API**: The platform generates a unique HTTPS endpoint with these key routes:
- `/inputs`: Lists the required input parameters
- `/kickoff`: Initiates an execution with provided inputs
- `/status/{kickoff_id}`: Checks the execution status
@@ -378,5 +388,6 @@ The Enterprise platform also offers:
- **Crew Studio**: Build crews through a chat interface without writing code
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with deployment issues or questions about the Enterprise platform.
Contact our support team for assistance with deployment issues or questions
about the Enterprise platform.
</Card>

50
docs/en/enterprise/guides/enable-crew-studio.mdx
View File

@@ -1,12 +1,13 @@
---
title: "Enable Crew Studio"
description: "Enabling Crew Studio on CrewAI AOP"
description: "Enabling Crew Studio on CrewAI AMP"
icon: "comments"
mode: "wide"
---
<Tip>
Crew Studio is a powerful **no-code/low-code** tool that allows you to quickly scaffold or build Crews through a conversational interface.
Crew Studio is a powerful **no-code/low-code** tool that allows you to quickly
scaffold or build Crews through a conversational interface.
</Tip>
## What is Crew Studio?
@@ -24,7 +25,7 @@ With Crew Studio, you can:
- Select appropriate tools
- Configure necessary inputs
- Generate downloadable code for customization
- Deploy directly to the CrewAI AOP platform
- Deploy directly to the CrewAI AMP platform
## Configuration Steps
@@ -32,7 +33,7 @@ Before you can start using Crew Studio, you need to configure your LLM connectio
<Steps>
<Step title="Set Up LLM Connection">
Go to the **LLM Connections** tab in your CrewAI AOP dashboard and create a new LLM connection.
Go to the **LLM Connections** tab in your CrewAI AMP dashboard and create a new LLM connection.
<Note>
Feel free to use any LLM provider you want that is supported by CrewAI.
@@ -52,6 +53,7 @@ Before you can start using Crew Studio, you need to configure your LLM connectio
<Frame>
![LLM Connection Configuration](/images/enterprise/llm-connection-config.png)
</Frame>
</Step>
<Step title="Verify Connection Added">
@@ -60,6 +62,7 @@ Before you can start using Crew Studio, you need to configure your LLM connectio
<Frame>
![Connection Added](/images/enterprise/connection-added.png)
</Frame>
</Step>
<Step title="Configure LLM Defaults">
@@ -73,6 +76,7 @@ Before you can start using Crew Studio, you need to configure your LLM connectio
<Frame>
![LLM Defaults Configuration](/images/enterprise/llm-defaults.png)
</Frame>
</Step>
</Steps>
@@ -82,7 +86,7 @@ Now that you've configured your LLM connection and default settings, you're read
<Steps>
<Step title="Access Studio">
Navigate to the **Studio** section in your CrewAI AOP dashboard.
Navigate to the **Studio** section in your CrewAI AMP dashboard.
</Step>
<Step title="Start a Conversation">
@@ -93,6 +97,7 @@ Now that you've configured your LLM connection and default settings, you're read
```
The Crew Assistant will ask clarifying questions to better understand your requirements.
</Step>
<Step title="Review Generated Crew">
@@ -104,14 +109,16 @@ Now that you've configured your LLM connection and default settings, you're read
- Tools to be used
This is your opportunity to refine the configuration before proceeding.
</Step>
<Step title="Deploy or Download">
Once you're satisfied with the configuration, you can:
- Download the generated code for local customization
- Deploy the crew directly to the CrewAI AOP platform
- Deploy the crew directly to the CrewAI AMP platform
- Modify the configuration and regenerate the crew
</Step>
<Step title="Test Your Crew">
@@ -120,7 +127,9 @@ Now that you've configured your LLM connection and default settings, you're read
</Steps>
<Tip>
For best results, provide clear, detailed descriptions of what you want your crew to accomplish. Include specific inputs and expected outputs in your description.
For best results, provide clear, detailed descriptions of what you want your
crew to accomplish. Include specific inputs and expected outputs in your
description.
</Tip>
## Example Workflow
@@ -134,11 +143,14 @@ Here's a typical workflow for creating a crew with Crew Studio:
```md
I need a crew that can analyze financial news and provide investment recommendations
```
</Step>
<Step title="Answer Questions">
Respond to clarifying questions from the Crew Assistant to refine your requirements.
</Step>
{" "}
<Step title="Answer Questions">
Respond to clarifying questions from the Crew Assistant to refine your
requirements.
</Step>
<Step title="Review the Plan">
Review the generated crew plan, which might include:
@@ -146,15 +158,18 @@ Here's a typical workflow for creating a crew with Crew Studio:
- A Research Agent to gather financial news
- An Analysis Agent to interpret the data
- A Recommendations Agent to provide investment advice
</Step>
<Step title="Approve or Modify">
Approve the plan or request changes if necessary.
</Step>
{" "}
<Step title="Approve or Modify">
Approve the plan or request changes if necessary.
</Step>
<Step title="Download or Deploy">
Download the code for customization or deploy directly to the platform.
</Step>
{" "}
<Step title="Download or Deploy">
Download the code for customization or deploy directly to the platform.
</Step>
<Step title="Test and Refine">
Test your crew with sample inputs and refine as needed.
@@ -162,5 +177,6 @@ Here's a typical workflow for creating a crew with Crew Studio:
</Steps>
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Crew Studio or any other CrewAI AOP features.
Contact our support team for assistance with Crew Studio or any other CrewAI
AMP features.
</Card>

19
docs/en/enterprise/guides/gmail-trigger.mdx
View File

@@ -10,17 +10,21 @@ mode: "wide"
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.
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 AOP
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" />
<img
src="/images/enterprise/trigger-selected.png"
alt="Enable or disable triggers with toggle"
/>
</Frame>
## Example: Process new emails
@@ -68,7 +72,9 @@ crewai triggers run gmail/new_email_received
The `crewai triggers run` command will execute your crew with a complete Gmail payload, allowing you to test your parsing logic before deployment.
<Warning>
Use `crewai triggers run gmail/new_email_received` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload.
Use `crewai triggers run gmail/new_email_received` (not `crewai run`) to
simulate trigger execution during development. After deployment, your crew
will automatically receive the trigger payload.
</Warning>
## Monitoring Executions
@@ -76,7 +82,10 @@ The `crewai triggers run` command will execute your crew with a complete Gmail p
Track history and performance of triggered runs:
<Frame>
<img src="/images/enterprise/list-executions.png" alt="List of executions triggered by automation" />
<img
src="/images/enterprise/list-executions.png"
alt="List of executions triggered by automation"
/>
</Frame>
## Troubleshooting

19
docs/en/enterprise/guides/google-calendar-trigger.mdx
View File

@@ -10,17 +10,21 @@ mode: "wide"
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.
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 AOP
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" />
<img
src="/images/enterprise/calendar-trigger.png"
alt="Enable or disable triggers with toggle"
/>
</Frame>
## Example: Summarize meeting details
@@ -54,7 +58,9 @@ crewai triggers run google_calendar/event_changed
The `crewai triggers run` command will execute your crew with a complete Calendar payload, allowing you to test your parsing logic before deployment.
<Warning>
Use `crewai triggers run google_calendar/event_changed` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload.
Use `crewai triggers run google_calendar/event_changed` (not `crewai run`) to
simulate trigger execution during development. After deployment, your crew
will automatically receive the trigger payload.
</Warning>
## Monitoring Executions
@@ -62,7 +68,10 @@ The `crewai triggers run` command will execute your crew with a complete Calenda
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" />
<img
src="/images/enterprise/list-executions.png"
alt="List of executions triggered by automation"
/>
</Frame>
## Troubleshooting

19
docs/en/enterprise/guides/google-drive-trigger.mdx
View File

@@ -10,17 +10,21 @@ mode: "wide"
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.
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 AOP
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" />
<img
src="/images/enterprise/gdrive-trigger.png"
alt="Enable or disable triggers with toggle"
/>
</Frame>
## Example: Summarize file activity
@@ -51,7 +55,9 @@ crewai triggers run google_drive/file_changed
The `crewai triggers run` command will execute your crew with a complete Drive payload, allowing you to test your parsing logic before deployment.
<Warning>
Use `crewai triggers run google_drive/file_changed` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload.
Use `crewai triggers run google_drive/file_changed` (not `crewai run`) to
simulate trigger execution during development. After deployment, your crew
will automatically receive the trigger payload.
</Warning>
## Monitoring Executions
@@ -59,7 +65,10 @@ The `crewai triggers run` command will execute your crew with a complete Drive p
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" />
<img
src="/images/enterprise/list-executions.png"
alt="List of executions triggered by automation"
/>
</Frame>
## Troubleshooting

77
docs/en/enterprise/guides/hubspot-trigger.mdx
View File

@@ -5,48 +5,57 @@ icon: "hubspot"
mode: "wide"
---
This guide provides a step-by-step process to set up HubSpot triggers for CrewAI AOP, enabling you to initiate crews directly from HubSpot Workflows.
This guide provides a step-by-step process to set up HubSpot triggers for CrewAI AMP, enabling you to initiate crews directly from HubSpot Workflows.
## Prerequisites
- A CrewAI AOP account
- A CrewAI AMP account
- A HubSpot account with the [HubSpot Workflows](https://knowledge.hubspot.com/workflows/create-workflows) feature
## Setup Steps
<Steps>
<Step title="Connect your HubSpot account with CrewAI AOP">
- Log in to your `CrewAI AOP account > Triggers`
- Select `HubSpot` from the list of available triggers
- Choose the HubSpot account you want to connect with CrewAI AOP
- Follow the on-screen prompts to authorize CrewAI AOP access to your HubSpot account
- A confirmation message will appear once HubSpot is successfully connected with CrewAI AOP
</Step>
<Step title="Create a HubSpot Workflow">
- Log in to your `HubSpot account > Automations > Workflows > New workflow`
- Select the workflow type that fits your needs (e.g., Start from scratch)
- In the workflow builder, click the Plus (+) icon to add a new action.
- Choose `Integrated apps > CrewAI > Kickoff a Crew`.
- Select the Crew you want to initiate.
- Click `Save` to add the action to your workflow
<Frame>
<img src="/images/enterprise/hubspot-workflow-1.png" alt="HubSpot Workflow 1" />
</Frame>
</Step>
<Step title="Use Crew results with other actions">
- After the Kickoff a Crew step, click the Plus (+) icon to add a new action.
- For example, to send an internal email notification, choose `Communications > Send internal email notification`
- In the Body field, click `Insert data`, select `View properties or action outputs from > Action outputs > Crew Result` to include Crew data in the email
<Frame>
<img src="/images/enterprise/hubspot-workflow-2.png" alt="HubSpot Workflow 2" />
</Frame>
- Configure any additional actions as needed
- Review your workflow steps to ensure everything is set up correctly
- Activate the workflow
<Frame>
<img src="/images/enterprise/hubspot-workflow-3.png" alt="HubSpot Workflow 3" />
</Frame>
</Step>
<Step title="Connect your HubSpot account with CrewAI AMP">
- Log in to your `CrewAI AMP account > Triggers` - Select `HubSpot` from the
list of available triggers - Choose the HubSpot account you want to connect
with CrewAI AMP - Follow the on-screen prompts to authorize CrewAI AMP
access to your HubSpot account - A confirmation message will appear once
HubSpot is successfully connected with CrewAI AMP
</Step>
<Step title="Create a HubSpot Workflow">
- Log in to your `HubSpot account > Automations > Workflows > New workflow`
- Select the workflow type that fits your needs (e.g., Start from scratch) -
In the workflow builder, click the Plus (+) icon to add a new action. -
Choose `Integrated apps > CrewAI > Kickoff a Crew`. - Select the Crew you
want to initiate. - Click `Save` to add the action to your workflow
<Frame>
<img
src="/images/enterprise/hubspot-workflow-1.png"
alt="HubSpot Workflow 1"
/>
</Frame>
</Step>
<Step title="Use Crew results with other actions">
- After the Kickoff a Crew step, click the Plus (+) icon to add a new
action. - For example, to send an internal email notification, choose
`Communications > Send internal email notification` - In the Body field,
click `Insert data`, select `View properties or action outputs from > Action
outputs > Crew Result` to include Crew data in the email
<Frame>
<img
src="/images/enterprise/hubspot-workflow-2.png"
alt="HubSpot Workflow 2"
/>
</Frame>
- Configure any additional actions as needed - Review your workflow
steps to ensure everything is set up correctly - Activate the workflow
<Frame>
<img
src="/images/enterprise/hubspot-workflow-3.png"
alt="HubSpot Workflow 3"
/>
</Frame>
</Step>
</Steps>
For more detailed information on available actions and customization options, refer to the [HubSpot Workflows Documentation](https://knowledge.hubspot.com/workflows/create-workflows).

36
docs/en/enterprise/guides/kickoff-crew.mdx
View File

@@ -1,25 +1,23 @@
---
title: "Kickoff Crew"
description: "Kickoff a Crew on CrewAI AOP"
description: "Kickoff a Crew on CrewAI AMP"
icon: "flag-checkered"
mode: "wide"
---
## Overview
Once you've deployed your crew to the CrewAI AOP platform, you can kickoff executions through the web interface or the API. This guide covers both approaches.
Once you've deployed your crew to the CrewAI AMP platform, you can kickoff executions through the web interface or the API. This guide covers both approaches.
## Method 1: Using the Web Interface
### Step 1: Navigate to Your Deployed Crew
1. Log in to [CrewAI AOP](https://app.crewai.com)
1. Log in to [CrewAI AMP](https://app.crewai.com)
2. Click on the crew name from your projects list
3. You'll be taken to the crew's detail page
<Frame>
![Crew Dashboard](/images/enterprise/crew-dashboard.png)
</Frame>
<Frame>![Crew Dashboard](/images/enterprise/crew-dashboard.png)</Frame>
### Step 2: Initiate Execution
@@ -31,9 +29,7 @@ From your crew's detail page, you have two options to kickoff an execution:
2. Enter the required input parameters for your crew in the JSON editor
3. Click the `Send Request` button
<Frame>
![Kickoff Endpoint](/images/enterprise/kickoff-endpoint.png)
</Frame>
<Frame>![Kickoff Endpoint](/images/enterprise/kickoff-endpoint.png)</Frame>
#### Option B: Using the Visual Interface
@@ -41,9 +37,7 @@ From your crew's detail page, you have two options to kickoff an execution:
2. Enter the required inputs in the form fields
3. Click the `Run Crew` button
<Frame>
![Run Crew](/images/enterprise/run-crew.png)
</Frame>
<Frame>![Run Crew](/images/enterprise/run-crew.png)</Frame>
### Step 3: Monitor Execution Progress
@@ -52,9 +46,7 @@ After initiating the execution:
1. You'll receive a response containing a `kickoff_id` - **copy this ID**
2. This ID is essential for tracking your execution
<Frame>
![Copy Task ID](/images/enterprise/copy-task-id.png)
</Frame>
<Frame>![Copy Task ID](/images/enterprise/copy-task-id.png)</Frame>
### Step 4: Check Execution Status
@@ -64,11 +56,10 @@ To monitor the progress of your execution:
2. Paste the `kickoff_id` into the designated field
3. Click the "Get Status" button
<Frame>
![Get Status](/images/enterprise/get-status.png)
</Frame>
<Frame>![Get Status](/images/enterprise/get-status.png)</Frame>
The status response will show:
- Current execution state (`running`, `completed`, etc.)
- Details about which tasks are in progress
- Any outputs produced so far
@@ -83,7 +74,7 @@ Once execution is complete:
## Method 2: Using the API
You can also kickoff crews programmatically using the CrewAI AOP REST API.
You can also kickoff crews programmatically using the CrewAI AMP REST API.
### Authentication
@@ -122,7 +113,7 @@ curl -X GET \
The response will be a JSON object containing an array of required input parameters, for example:
```json
{"inputs":["topic","current_year"]}
{ "inputs": ["topic", "current_year"] }
```
This example shows that this particular crew requires two inputs: `topic` and `current_year`.
@@ -142,7 +133,7 @@ curl -X POST \
The response will include a `kickoff_id` that you'll need for tracking:
```json
{"kickoff_id":"abcd1234-5678-90ef-ghij-klmnopqrstuv"}
{ "kickoff_id": "abcd1234-5678-90ef-ghij-klmnopqrstuv" }
```
### Step 3: Check Execution Status
@@ -182,5 +173,6 @@ If an execution fails:
3. Look for LLM responses and tool usage in the trace details
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with execution issues or questions about the Enterprise platform.
Contact our support team for assistance with execution issues or questions
about the Enterprise platform.
</Card>

14
docs/en/enterprise/guides/microsoft-teams-trigger.mdx
View File

@@ -10,17 +10,21 @@ mode: "wide"
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.
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 AOP
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" />
<img
src="/images/enterprise/msteams-trigger.png"
alt="Enable or disable triggers with toggle"
/>
</Frame>
## Example: Summarize a new chat thread
@@ -52,7 +56,9 @@ crewai triggers run microsoft_teams/teams_message_created
The `crewai triggers run` command will execute your crew with a complete Teams payload, allowing you to test your parsing logic before deployment.
<Warning>
Use `crewai triggers run microsoft_teams/teams_message_created` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload.
Use `crewai triggers run microsoft_teams/teams_message_created` (not `crewai
run`) to simulate trigger execution during development. After deployment, your
crew will automatically receive the trigger payload.
</Warning>
## Troubleshooting

14
docs/en/enterprise/guides/onedrive-trigger.mdx
View File

@@ -10,17 +10,21 @@ mode: "wide"
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.
Connect OneDrive in **Tools & Integrations** and toggle the trigger on for
your deployment.
</Tip>
## Enabling the OneDrive Trigger
1. Open your deployment in CrewAI AOP
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" />
<img
src="/images/enterprise/onedrive-trigger.png"
alt="Enable or disable triggers with toggle"
/>
</Frame>
## Example: Audit file permissions
@@ -51,7 +55,9 @@ crewai triggers run microsoft_onedrive/file_changed
The `crewai triggers run` command will execute your crew with a complete OneDrive payload, allowing you to test your parsing logic before deployment.
<Warning>
Use `crewai triggers run microsoft_onedrive/file_changed` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload.
Use `crewai triggers run microsoft_onedrive/file_changed` (not `crewai run`)
to simulate trigger execution during development. After deployment, your crew
will automatically receive the trigger payload.
</Warning>
## Troubleshooting

14
docs/en/enterprise/guides/outlook-trigger.mdx
View File

@@ -10,17 +10,21 @@ mode: "wide"
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.
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 AOP
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" />
<img
src="/images/enterprise/outlook-trigger.png"
alt="Enable or disable triggers with toggle"
/>
</Frame>
## Example: Summarize a new email
@@ -51,7 +55,9 @@ crewai triggers run microsoft_outlook/email_received
The `crewai triggers run` command will execute your crew with a complete Outlook payload, allowing you to test your parsing logic before deployment.
<Warning>
Use `crewai triggers run microsoft_outlook/email_received` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload.
Use `crewai triggers run microsoft_outlook/email_received` (not `crewai run`)
to simulate trigger execution during development. After deployment, your crew
will automatically receive the trigger payload.
</Warning>
## Troubleshooting

16
docs/en/enterprise/guides/react-component-export.mdx
View File

@@ -1,11 +1,11 @@
---
title: "React Component Export"
description: "Learn how to export and integrate CrewAI AOP React components into your applications"
description: "Learn how to export and integrate CrewAI AMP React components into your applications"
icon: "react"
mode: "wide"
---
This guide explains how to export CrewAI AOP crews as React components and integrate them into your own applications.
This guide explains how to export CrewAI AMP crews as React components and integrate them into your own applications.
## Exporting a React Component
@@ -17,6 +17,7 @@ This guide explains how to export CrewAI AOP crews as React components and integ
<img src="/images/enterprise/export-react-component.png" alt="Export React Component" />
</Frame>
</Step>
</Steps>
## Setting Up Your React Environment
@@ -83,6 +84,7 @@ To run this React component locally, you'll need to set up a React development e
```
- This will start the development server, and your default web browser should open automatically to http://localhost:3000, where you'll see your React app running.
</Step>
</Steps>
## Customization
@@ -90,10 +92,16 @@ To run this React component locally, you'll need to set up a React development e
You can then customise the `CrewLead.jsx` to add color, title etc
<Frame>
<img src="/images/enterprise/customise-react-component.png" alt="Customise React Component" />
<img
src="/images/enterprise/customise-react-component.png"
alt="Customise React Component"
/>
</Frame>
<Frame>
<img src="/images/enterprise/customise-react-component-2.png" alt="Customise React Component" />
<img
src="/images/enterprise/customise-react-component-2.png"
alt="Customise React Component"
/>
</Frame>
## Next Steps

6
docs/en/enterprise/guides/salesforce-trigger.mdx
View File

@@ -5,7 +5,7 @@ icon: "salesforce"
mode: "wide"
---
CrewAI AOP can be triggered from Salesforce to automate customer relationship management workflows and enhance your sales operations.
CrewAI AMP can be triggered from Salesforce to automate customer relationship management workflows and enhance your sales operations.
## Overview
@@ -31,7 +31,7 @@ Salesforce is a leading customer relationship management (CRM) platform that hel
To set up Salesforce triggers:
1. **Contact Support**: Reach out to CrewAI AOP support for assistance with Salesforce trigger setup
1. **Contact Support**: Reach out to CrewAI AMP support for assistance with Salesforce trigger setup
2. **Review Requirements**: Ensure you have the necessary Salesforce permissions and API access
3. **Configure Connection**: Work with the support team to establish the connection between CrewAI and your Salesforce instance
4. **Test Triggers**: Verify the triggers work correctly with your specific use cases
@@ -47,4 +47,4 @@ Common Salesforce + CrewAI trigger scenarios include:
## Next Steps
For detailed setup instructions and advanced configuration options, please contact CrewAI AOP support who can provide tailored guidance for your specific Salesforce environment and business needs.
For detailed setup instructions and advanced configuration options, please contact CrewAI AMP support who can provide tailored guidance for your specific Salesforce environment and business needs.

127
docs/en/enterprise/guides/team-management.mdx
View File

@@ -1,40 +1,39 @@
---
title: "Team Management"
description: "Learn how to invite and manage team members in your CrewAI AOP organization"
description: "Learn how to invite and manage team members in your CrewAI AMP organization"
icon: "users"
mode: "wide"
---
As an administrator of a CrewAI AOP account, you can easily invite new team members to join your organization. This guide will walk you through the process step-by-step.
As an administrator of a CrewAI AMP account, you can easily invite new team members to join your organization. This guide will walk you through the process step-by-step.
## Inviting Team Members
<Steps>
<Step title="Access the Settings Page">
- Log in to your CrewAI AOP account
- Look for the gear icon (⚙️) in the top right corner of the dashboard
- Click on the gear icon to access the **Settings** page:
<Frame caption="Settings page">
<img src="/images/enterprise/settings-page.png" alt="Settings Page" />
</Frame>
</Step>
<Step title="Navigate to the Members Section">
- On the Settings page, you'll see a `Members` tab
- Click on the `Members` tab to access the **Members** page:
<Frame caption="Members tab">
<img src="/images/enterprise/members-tab.png" alt="Members Tab" />
</Frame>
</Step>
<Step title="Invite New Members">
- In the Members section, you'll see a list of current members (including yourself)
- Locate the `Email` input field
- Enter the email address of the person you want to invite
- Click the `Invite` button to send the invitation
</Step>
<Step title="Repeat as Needed">
- You can repeat this process to invite multiple team members
- Each invited member will receive an email invitation to join your organization
</Step>
<Step title="Access the Settings Page">
- Log in to your CrewAI AMP account - Look for the gear icon (⚙️) in the top
right corner of the dashboard - Click on the gear icon to access the
**Settings** page:
<Frame caption="Settings page">
<img src="/images/enterprise/settings-page.png" alt="Settings Page" />
</Frame>
</Step>
<Step title="Navigate to the Members Section">
- On the Settings page, you'll see a `Members` tab - Click on the `Members`
tab to access the **Members** page:
<Frame caption="Members tab">
<img src="/images/enterprise/members-tab.png" alt="Members Tab" />
</Frame>
</Step>
<Step title="Invite New Members">
- In the Members section, you'll see a list of current members (including
yourself) - Locate the `Email` input field - Enter the email address of the
person you want to invite - Click the `Invite` button to send the invitation
</Step>
<Step title="Repeat as Needed">
- You can repeat this process to invite multiple team members - Each invited
member will receive an email invitation to join your organization
</Step>
</Steps>
## Adding Roles
@@ -42,40 +41,44 @@ As an administrator of a CrewAI AOP account, you can easily invite new team memb
You can add roles to your team members to control their access to different parts of the platform.
<Steps>
<Step title="Access the Settings Page">
- Log in to your CrewAI AOP account
- Look for the gear icon (⚙️) in the top right corner of the dashboard
- Click on the gear icon to access the **Settings** page:
<Frame>
<img src="/images/enterprise/settings-page.png" alt="Settings Page" />
</Frame>
</Step>
<Step title="Navigate to the Members Section">
- On the Settings page, you'll see a `Roles` tab
- Click on the `Roles` tab to access the **Roles** page.
<Frame>
<img src="/images/enterprise/roles-tab.png" alt="Roles Tab" />
</Frame>
- Click on the `Add Role` button to add a new role.
- Enter the details and permissions of the role and click the `Create Role` button to create the role.
<Frame>
<img src="/images/enterprise/add-role-modal.png" alt="Add Role Modal" />
</Frame>
</Step>
<Step title="Add Roles to Members">
- In the Members section, you'll see a list of current members (including yourself)
<Frame>
<img src="/images/enterprise/member-accepted-invitation.png" alt="Member Accepted Invitation" />
</Frame>
- Once the member has accepted the invitation, you can add a role to them.
- Navigate back to `Roles` tab
- Go to the member you want to add a role to and under the `Role` column, click on the dropdown
- Select the role you want to add to the member
- Click the `Update` button to save the role
<Frame>
<img src="/images/enterprise/assign-role.png" alt="Add Role to Member" />
</Frame>
</Step>
<Step title="Access the Settings Page">
- Log in to your CrewAI AMP account - Look for the gear icon (⚙️) in the top
right corner of the dashboard - Click on the gear icon to access the
**Settings** page:
<Frame>
<img src="/images/enterprise/settings-page.png" alt="Settings Page" />
</Frame>
</Step>
<Step title="Navigate to the Members Section">
- On the Settings page, you'll see a `Roles` tab - Click on the `Roles` tab
to access the **Roles** page.
<Frame>
<img src="/images/enterprise/roles-tab.png" alt="Roles Tab" />
</Frame>
- Click on the `Add Role` button to add a new role. - Enter the
details and permissions of the role and click the `Create Role` button to
create the role.
<Frame>
<img src="/images/enterprise/add-role-modal.png" alt="Add Role Modal" />
</Frame>
</Step>
<Step title="Add Roles to Members">
- In the Members section, you'll see a list of current members (including
yourself)
<Frame>
<img
src="/images/enterprise/member-accepted-invitation.png"
alt="Member Accepted Invitation"
/>
</Frame>
- Once the member has accepted the invitation, you can add a role to
them. - Navigate back to `Roles` tab - Go to the member you want to add a
role to and under the `Role` column, click on the dropdown - Select the role
you want to add to the member - Click the `Update` button to save the role
<Frame>
<img src="/images/enterprise/assign-role.png" alt="Add Role to Member" />
</Frame>
</Step>
</Steps>
## Important Notes
@@ -85,4 +88,4 @@ You can add roles to your team members to control their access to different part
- **Invitation Acceptance**: Invited members will need to accept the invitation to join your organization
- **Email Notifications**: You may want to inform your team members to check their email (including spam folders) for the invitation
By following these steps, you can easily expand your team and collaborate more effectively within your CrewAI AOP organization.
By following these steps, you can easily expand your team and collaborate more effectively within your CrewAI AMP organization.

17
docs/en/enterprise/guides/tool-repository.mdx
View File

@@ -20,11 +20,11 @@ The repository is not a version control system. Use Git to track code changes an
Before using the Tool Repository, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account
- A [CrewAI AMP](https://app.crewai.com) account
- [CrewAI CLI](/en/concepts/cli#cli) installed
- uv>=0.5.0 installed. Check out [how to upgrade](https://docs.astral.sh/uv/getting-started/installation/#upgrading-uv)
- [Git](https://git-scm.com) installed and configured
- Access permissions to publish or install tools in your CrewAI AOP organization
- Access permissions to publish or install tools in your CrewAI AMP organization
## Installing Tools
@@ -54,11 +54,11 @@ researcher = Agent(
## Adding other packages after installing a tool
After installing a tool from the CrewAI AOP Tool Repository, you need to use the `crewai uv` command to add other packages to your project.
After installing a tool from the CrewAI AMP Tool Repository, you need to use the `crewai uv` command to add other packages to your project.
Using pure `uv` commands will fail due to authentication to tool repository being handled by the CLI. By using the `crewai uv` command, you can add other packages to your project without having to worry about authentication.
Any `uv` command can be used with the `crewai uv` command, making it a powerful tool for managing your project's dependencies without the hassle of managing authentication through environment variables or other methods.
Say that you have installed a custom tool from the CrewAI AOP Tool Repository called "my-tool":
Say that you have installed a custom tool from the CrewAI AMP Tool Repository called "my-tool":
```bash
crewai tool install my-tool
@@ -131,13 +131,13 @@ crewai tool publish
To delete a tool:
1. Go to [CrewAI AOP](https://app.crewai.com)
1. Go to [CrewAI AMP](https://app.crewai.com)
2. Navigate to **Tools**
3. Select the tool
4. Click **Delete**
<Warning>
Deletion is permanent. Deleted tools cannot be restored or re-installed.
Deletion is permanent. Deleted tools cannot be restored or re-installed.
</Warning>
## Security Checks
@@ -146,8 +146,9 @@ Every published version undergoes automated security checks, and are only availa
You can check the security check status of a tool at:
`CrewAI AOP > Tools > Your Tool > Versions`
`CrewAI AMP > Tools > Your Tool > Versions`
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with API integration or troubleshooting.
Contact our support team for assistance with API integration or
troubleshooting.
</Card>

32
docs/en/enterprise/guides/update-crew.mdx
View File

@@ -1,13 +1,14 @@
---
title: "Update Crew"
description: "Updating a Crew on CrewAI AOP"
description: "Updating a Crew on CrewAI AMP"
icon: "pencil"
mode: "wide"
---
<Note>
After deploying your crew to CrewAI AOP, you may need to make updates to the code, security settings, or configuration.
This guide explains how to perform these common update operations.
After deploying your crew to CrewAI AMP, you may need to make updates to the
code, security settings, or configuration. This guide explains how to perform
these common update operations.
</Note>
## Why Update Your Crew?
@@ -15,6 +16,7 @@ This guide explains how to perform these common update operations.
CrewAI won't automatically pick up GitHub updates by default, so you'll need to manually trigger updates, unless you checked the `Auto-update` option when deploying your crew.
There are several reasons you might want to update your crew deployment:
- You want to update the code with a latest commit you pushed to GitHub
- You want to reset the bearer token for security reasons
- You want to update environment variables
@@ -23,12 +25,10 @@ There are several reasons you might want to update your crew deployment:
When you've pushed new commits to your GitHub repository and want to update your deployment:
1. Navigate to your crew in the CrewAI AOP platform
1. Navigate to your crew in the CrewAI AMP platform
2. Click on the `Re-deploy` button on your crew details page
<Frame>
![Re-deploy Button](/images/enterprise/redeploy-button.png)
</Frame>
<Frame>![Re-deploy Button](/images/enterprise/redeploy-button.png)</Frame>
This will trigger an update that you can track using the progress bar. The system will pull the latest code from your repository and rebuild your deployment.
@@ -36,16 +36,15 @@ This will trigger an update that you can track using the progress bar. The syste
If you need to generate a new bearer token (for example, if you suspect the current token might have been compromised):
1. Navigate to your crew in the CrewAI AOP platform
1. Navigate to your crew in the CrewAI AMP platform
2. Find the `Bearer Token` section
3. Click the `Reset` button next to your current token
<Frame>
![Reset Token](/images/enterprise/reset-token.png)
</Frame>
<Frame>![Reset Token](/images/enterprise/reset-token.png)</Frame>
<Warning>
Resetting your bearer token will invalidate the previous token immediately. Make sure to update any applications or scripts that are using the old token.
Resetting your bearer token will invalidate the previous token immediately.
Make sure to update any applications or scripts that are using the old token.
</Warning>
## 3. Updating Environment Variables
@@ -69,7 +68,8 @@ To update the environment variables for your crew:
5. Finally, click the `Update Deployment` button at the bottom of the page to apply the changes
<Note>
Updating environment variables will trigger a new deployment, but this will only update the environment configuration and not the code itself.
Updating environment variables will trigger a new deployment, but this will
only update the environment configuration and not the code itself.
</Note>
## After Updating
@@ -81,9 +81,11 @@ After performing any update:
3. Once complete, test your crew to ensure the changes are working as expected
<Tip>
If you encounter any issues after updating, you can view deployment logs in the platform or contact support for assistance.
If you encounter any issues after updating, you can view deployment logs in
the platform or contact support for assistance.
</Tip>
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with updating your crew or troubleshooting deployment issues.
Contact our support team for assistance with updating your crew or
troubleshooting deployment issues.
</Card>

10
docs/en/enterprise/guides/webhook-automation.mdx
View File

@@ -1,17 +1,17 @@
---
title: "Webhook Automation"
description: "Automate CrewAI AOP workflows using webhooks with platforms like ActivePieces, Zapier, and Make.com"
description: "Automate CrewAI AMP workflows using webhooks with platforms like ActivePieces, Zapier, and Make.com"
icon: "webhook"
mode: "wide"
---
CrewAI AOP allows you to automate your workflow using webhooks. This article will guide you through the process of setting up and using webhooks to kickoff your crew execution, with a focus on integration with ActivePieces, a workflow automation platform similar to Zapier and Make.com.
CrewAI AMP allows you to automate your workflow using webhooks. This article will guide you through the process of setting up and using webhooks to kickoff your crew execution, with a focus on integration with ActivePieces, a workflow automation platform similar to Zapier and Make.com.
## Setting Up Webhooks
<Steps>
<Step title="Accessing the Kickoff Interface">
- Navigate to the CrewAI AOP dashboard
- Navigate to the CrewAI AMP dashboard
- Look for the `/kickoff` section, which is used to start the crew execution
<Frame>
<img src="/images/enterprise/kickoff-interface.png" alt="Kickoff Interface" />
@@ -44,7 +44,7 @@ CrewAI AOP allows you to automate your workflow using webhooks. This article wil
3. Add an HTTP action step
- Set the action to `Send HTTP request`
- Use `POST` as the method
- Set the URL to your CrewAI AOP kickoff endpoint
- Set the URL to your CrewAI AMP kickoff endpoint
- Add necessary headers (e.g., `Bearer Token`)
<Frame>
<img src="/images/enterprise/activepieces-headers.png" alt="ActivePieces Headers" />
@@ -76,6 +76,7 @@ CrewAI AOP allows you to automate your workflow using webhooks. This article wil
<img src="/images/enterprise/activepieces-email.png" alt="ActivePieces Email" />
</Frame>
</Step>
</Steps>
## Webhook Output Examples
@@ -152,4 +153,5 @@ CrewAI AOP allows you to automate your workflow using webhooks. This article wil
}
```
</Tab>
</Tabs>

21
docs/en/enterprise/guides/zapier-trigger.mdx
View File

@@ -5,11 +5,11 @@ icon: "bolt"
mode: "wide"
---
This guide will walk you through the process of setting up Zapier triggers for CrewAI AOP, allowing you to automate workflows between CrewAI AOP and other applications.
This guide will walk you through the process of setting up Zapier triggers for CrewAI AMP, allowing you to automate workflows between CrewAI AMP and other applications.
## Prerequisites
- A CrewAI AOP account
- A CrewAI AMP account
- A Zapier account
- A Slack account (for this specific example)
@@ -32,7 +32,7 @@ This guide will walk you through the process of setting up Zapier triggers for C
- Connect your Slack account if you haven't already.
</Step>
<Step title="Configure the CrewAI AOP Action">
<Step title="Configure the CrewAI AMP Action">
- Add a new action step to your Zap.
- Choose CrewAI+ as your action app and Kickoff as the Action Event
@@ -41,8 +41,8 @@ This guide will walk you through the process of setting up Zapier triggers for C
</Frame>
</Step>
<Step title="Connect your CrewAI AOP account">
- Connect your CrewAI AOP account.
<Step title="Connect your CrewAI AMP account">
- Connect your CrewAI AMP account.
- Select the appropriate Crew for your workflow.
<Frame>
@@ -51,8 +51,8 @@ This guide will walk you through the process of setting up Zapier triggers for C
- Configure the inputs for the Crew using the data from the Slack message.
</Step>
<Step title="Format the CrewAI AOP Output">
- Add another action step to format the text output from CrewAI AOP.
<Step title="Format the CrewAI AMP Output">
- Add another action step to format the text output from CrewAI AMP.
- Use Zapier's formatting tools to convert the Markdown output to HTML.
<Frame>
@@ -67,7 +67,7 @@ This guide will walk you through the process of setting up Zapier triggers for C
- Add a final action step to send the formatted output via email.
- Choose your preferred email service (e.g., Gmail, Outlook).
- Configure the email details, including recipient, subject, and body.
- Insert the formatted CrewAI AOP output into the email body.
- Insert the formatted CrewAI AMP output into the email body.
<Frame>
<img src="/images/enterprise/zapier-7.png" alt="Zapier 7" />
@@ -93,12 +93,13 @@ This guide will walk you through the process of setting up Zapier triggers for C
<img src="/images/enterprise/zapier-9.png" alt="Zapier 12" />
</Frame>
</Step>
</Steps>
## Tips for Success
- Ensure that your CrewAI AOP inputs are correctly mapped from the Slack message.
- Ensure that your CrewAI AMP inputs are correctly mapped from the Slack message.
- Test your Zap thoroughly before turning it on to catch any potential issues.
- Consider adding error handling steps to manage potential failures in the workflow.
By following these steps, you'll have successfully set up Zapier triggers for CrewAI AOP, allowing for automated workflows triggered by Slack messages and resulting in email notifications with CrewAI AOP output.
By following these steps, you'll have successfully set up Zapier triggers for CrewAI AMP, allowing for automated workflows triggered by Slack messages and resulting in email notifications with CrewAI AMP output.

20
docs/en/enterprise/integrations/asana.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage tasks, projects, and team coordination through Asan
Before using the Asana integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- An Asana account with appropriate permissions
- Connected your Asana account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Asana integration, ensure you have:
### 1. Connect Your Asana Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Asana** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for task and project management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -58,6 +60,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `task` (string, required): Task ID - The ID of the Task the comment will be added to. The comment will be authored by the currently authenticated user.
- `text` (string, required): Text (example: "This is a comment.").
</Accordion>
<Accordion title="asana/create_project">
@@ -68,6 +71,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `workspace` (string, required): Workspace - Use Connect Portal Workflow Settings to allow users to select which Workspace to create Projects in. Defaults to the user's first Workspace if left blank.
- `team` (string, optional): Team - Use Connect Portal Workflow Settings to allow users to select which Team to share this Project with. Defaults to the user's first Team if left blank.
- `notes` (string, optional): Notes (example: "These are things we need to purchase.").
</Accordion>
<Accordion title="asana/get_projects">
@@ -76,6 +80,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `archived` (string, optional): Archived - Choose "true" to show archived projects, "false" to display only active projects, or "default" to show both archived and active projects.
- Options: `default`, `true`, `false`
</Accordion>
<Accordion title="asana/get_project_by_id">
@@ -83,6 +88,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `projectFilterId` (string, required): Project ID.
</Accordion>
<Accordion title="asana/create_task">
@@ -97,6 +103,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `dueAtDate` (string, optional): Due At - The date and time (ISO timestamp) at which this task is due. Cannot be used together with Due On. (example: "2019-09-15T02:06:58.147Z").
- `assignee` (string, optional): Assignee - The ID of the Asana user this task will be assigned to. Use Connect Portal Workflow Settings to allow users to select an Assignee.
- `gid` (string, optional): External ID - An ID from your application to associate this task with. You can use this ID to sync updates to this task later.
</Accordion>
<Accordion title="asana/update_task">
@@ -112,6 +119,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `dueAtDate` (string, optional): Due At - The date and time (ISO timestamp) at which this task is due. Cannot be used together with Due On. (example: "2019-09-15T02:06:58.147Z").
- `assignee` (string, optional): Assignee - The ID of the Asana user this task will be assigned to. Use Connect Portal Workflow Settings to allow users to select an Assignee.
- `gid` (string, optional): External ID - An ID from your application to associate this task with. You can use this ID to sync updates to this task later.
</Accordion>
<Accordion title="asana/get_tasks">
@@ -122,6 +130,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `project` (string, optional): Project - The ID of the Project to filter tasks on. Use Connect Portal Workflow Settings to allow users to select a Project.
- `assignee` (string, optional): Assignee - The ID of the assignee to filter tasks on. Use Connect Portal Workflow Settings to allow users to select an Assignee.
- `completedSince` (string, optional): Completed since - Only return tasks that are either incomplete or that have been completed since this time (ISO or Unix timestamp). (example: "2014-04-25T16:15:47-04:00").
</Accordion>
<Accordion title="asana/get_tasks_by_id">
@@ -129,6 +138,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `taskId` (string, required): Task ID.
</Accordion>
<Accordion title="asana/get_task_by_external_id">
@@ -136,6 +146,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `gid` (string, required): External ID - The ID that this task is associated or synced with, from your application.
</Accordion>
<Accordion title="asana/add_task_to_section">
@@ -146,6 +157,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `taskId` (string, required): Task ID - The ID of the task. (example: "1204619611402340").
- `beforeTaskId` (string, optional): Before Task ID - The ID of a task in this section that this task will be inserted before. Cannot be used with After Task ID. (example: "1204619611402340").
- `afterTaskId` (string, optional): After Task ID - The ID of a task in this section that this task will be inserted after. Cannot be used with Before Task ID. (example: "1204619611402340").
</Accordion>
<Accordion title="asana/get_teams">
@@ -153,12 +165,14 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `workspace` (string, required): Workspace - Returns the teams in this workspace visible to the authorized user.
</Accordion>
<Accordion title="asana/get_workspaces">
**Description:** Get a list of workspaces in Asana.
**Parameters:** None required.
</Accordion>
</AccordionGroup>

17
docs/en/enterprise/integrations/box.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage files, folders, and documents through Box. Upload f
Before using the Box integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Box account with appropriate permissions
- Connected your Box account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Box integration, ensure you have:
### 1. Connect Your Box Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Box** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for file and folder management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -66,6 +68,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
}
```
- `file` (string, required): File URL - Files must be smaller than 50MB in size. (example: "https://picsum.photos/200/300").
</Accordion>
<Accordion title="box/save_file_from_object">
@@ -75,6 +78,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `file` (string, required): File - Accepts a File Object containing file data. Files must be smaller than 50MB in size.
- `fileName` (string, required): File Name (example: "qwerty.png").
- `folder` (string, optional): Folder - Use Connect Portal Workflow Settings to allow users to select the File's Folder destination. Defaults to the user's root folder if left blank.
</Accordion>
<Accordion title="box/get_file_by_id">
@@ -82,6 +86,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `fileId` (string, required): File ID - The unique identifier that represents a file. (example: "12345").
</Accordion>
<Accordion title="box/list_files">
@@ -107,6 +112,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
]
}
```
</Accordion>
<Accordion title="box/create_folder">
@@ -120,6 +126,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"id": "123456"
}
```
</Accordion>
<Accordion title="box/move_folder">
@@ -134,6 +141,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"id": "123456"
}
```
</Accordion>
<Accordion title="box/get_folder_by_id">
@@ -141,6 +149,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `folderId` (string, required): Folder ID - The unique identifier that represents a folder. (example: "0").
</Accordion>
<Accordion title="box/search_folders">
@@ -166,6 +175,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
]
}
```
</Accordion>
<Accordion title="box/delete_folder">
@@ -174,6 +184,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `folderId` (string, required): Folder ID - The unique identifier that represents a folder. (example: "0").
- `recursive` (boolean, optional): Recursive - Delete a folder that is not empty by recursively deleting the folder and all of its content.
</Accordion>
</AccordionGroup>

22
docs/en/enterprise/integrations/clickup.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage tasks, projects, and productivity workflows through
Before using the ClickUp integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A ClickUp account with appropriate permissions
- Connected your ClickUp account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the ClickUp integration, ensure you have:
### 1. Connect Your ClickUp Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **ClickUp** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for task and project management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -75,6 +77,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
}
```
Available fields: `space_ids%5B%5D`, `project_ids%5B%5D`, `list_ids%5B%5D`, `statuses%5B%5D`, `include_closed`, `assignees%5B%5D`, `tags%5B%5D`, `due_date_gt`, `due_date_lt`, `date_created_gt`, `date_created_lt`, `date_updated_gt`, `date_updated_lt`
</Accordion>
<Accordion title="clickup/get_task_in_list">
@@ -83,6 +86,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listId` (string, required): List - Select a List to get tasks from. Use Connect Portal User Settings to allow users to select a ClickUp List.
- `taskFilterFormula` (string, optional): Search for tasks that match specified filters. For example: name=task1.
</Accordion>
<Accordion title="clickup/create_task">
@@ -96,6 +100,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `assignees` (string, optional): Assignees - Select a Member (or an array of member IDs) to be assigned to this task. Use Connect Portal User Settings to allow users to select a ClickUp Member.
- `dueDate` (string, optional): Due Date - Specify a date for this task to be due on.
- `additionalFields` (string, optional): Additional Fields - Specify additional fields to include on this task as JSON.
</Accordion>
<Accordion title="clickup/update_task">
@@ -110,6 +115,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `assignees` (string, optional): Assignees - Select a Member (or an array of member IDs) to be assigned to this task. Use Connect Portal User Settings to allow users to select a ClickUp Member.
- `dueDate` (string, optional): Due Date - Specify a date for this task to be due on.
- `additionalFields` (string, optional): Additional Fields - Specify additional fields to include on this task as JSON.
</Accordion>
<Accordion title="clickup/delete_task">
@@ -117,6 +123,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `taskId` (string, required): Task ID - The ID of the task to delete.
</Accordion>
<Accordion title="clickup/get_list">
@@ -124,6 +131,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `spaceId` (string, required): Space ID - The ID of the space containing the lists.
</Accordion>
<Accordion title="clickup/get_custom_fields_in_list">
@@ -131,6 +139,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listId` (string, required): List ID - The ID of the list to get custom fields from.
</Accordion>
<Accordion title="clickup/get_all_fields_in_list">
@@ -138,6 +147,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listId` (string, required): List ID - The ID of the list to get all fields from.
</Accordion>
<Accordion title="clickup/get_space">
@@ -145,6 +155,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `spaceId` (string, optional): Space ID - The ID of the space to retrieve.
</Accordion>
<Accordion title="clickup/get_folders">
@@ -152,12 +163,14 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `spaceId` (string, required): Space ID - The ID of the space containing the folders.
</Accordion>
<Accordion title="clickup/get_member">
**Description:** Get Member information in ClickUp.
**Parameters:** None required.
</Accordion>
</AccordionGroup>
@@ -284,5 +297,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with ClickUp integration setup or troubleshooting.
Contact our support team for assistance with ClickUp integration setup or
troubleshooting.
</Card>

21
docs/en/enterprise/integrations/github.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage repositories, issues, and releases through GitHub.
Before using the GitHub integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A GitHub account with appropriate repository permissions
- Connected your GitHub account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the GitHub integration, ensure you have:
### 1. Connect Your GitHub Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **GitHub** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for repository and issue management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -61,6 +63,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `title` (string, required): Issue Title - Specify the title of the issue to create.
- `body` (string, optional): Issue Body - Specify the body contents of the issue to create.
- `assignees` (string, optional): Assignees - Specify the assignee(s)' GitHub login as an array of strings for this issue. (example: `["octocat"]`).
</Accordion>
<Accordion title="github/update_issue">
@@ -75,6 +78,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `assignees` (string, optional): Assignees - Specify the assignee(s)' GitHub login as an array of strings for this issue. (example: `["octocat"]`).
- `state` (string, optional): State - Specify the updated state of the issue.
- Options: `open`, `closed`
</Accordion>
<Accordion title="github/get_issue_by_number">
@@ -84,6 +88,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `owner` (string, required): Owner - Specify the name of the account owner of the associated repository for this Issue. (example: "abc").
- `repo` (string, required): Repository - Specify the name of the associated repository for this Issue.
- `issue_number` (string, required): Issue Number - Specify the number of the issue to fetch.
</Accordion>
<Accordion title="github/lock_issue">
@@ -95,6 +100,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `issue_number` (string, required): Issue Number - Specify the number of the issue to lock.
- `lock_reason` (string, required): Lock Reason - Specify a reason for locking the issue or pull request conversation.
- Options: `off-topic`, `too heated`, `resolved`, `spam`
</Accordion>
<Accordion title="github/search_issue">
@@ -122,6 +128,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
}
```
Available fields: `assignee`, `creator`, `mentioned`, `labels`
</Accordion>
<Accordion title="github/create_release">
@@ -140,6 +147,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `discussion_category_name` (string, optional): Discussion Category Name - If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository.
- `generate_release_notes` (string, optional): Release Notes - Specify whether the created release should automatically create release notes using the provided name and body specified.
- Options: `true`, `false`
</Accordion>
<Accordion title="github/update_release">
@@ -159,6 +167,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `discussion_category_name` (string, optional): Discussion Category Name - If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository.
- `generate_release_notes` (string, optional): Release Notes - Specify whether the created release should automatically create release notes using the provided name and body specified.
- Options: `true`, `false`
</Accordion>
<Accordion title="github/get_release_by_id">
@@ -168,6 +177,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `owner` (string, required): Owner - Specify the name of the account owner of the associated repository for this Release. (example: "abc").
- `repo` (string, required): Repository - Specify the name of the associated repository for this Release.
- `id` (string, required): Release ID - Specify the release ID of the release to fetch.
</Accordion>
<Accordion title="github/get_release_by_tag_name">
@@ -177,6 +187,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `owner` (string, required): Owner - Specify the name of the account owner of the associated repository for this Release. (example: "abc").
- `repo` (string, required): Repository - Specify the name of the associated repository for this Release.
- `tag_name` (string, required): Name - Specify the tag of the release to fetch. (example: "v1.0.0").
</Accordion>
<Accordion title="github/delete_release">
@@ -186,6 +197,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `owner` (string, required): Owner - Specify the name of the account owner of the associated repository for this Release. (example: "abc").
- `repo` (string, required): Repository - Specify the name of the associated repository for this Release.
- `id` (string, required): Release ID - Specify the ID of the release to delete.
</Accordion>
</AccordionGroup>
@@ -314,5 +326,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with GitHub integration setup or troubleshooting.
Contact our support team for assistance with GitHub integration setup or
troubleshooting.
</Card>

21
docs/en/enterprise/integrations/gmail.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage emails, contacts, and drafts through Gmail. Send em
Before using the Gmail integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Gmail account with appropriate permissions
- Connected your Gmail account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Gmail integration, ensure you have:
### 1. Connect Your Gmail Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Gmail** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for email and contact management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -62,6 +64,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `pageToken` (string, optional): Page token to retrieve a specific page of results.
- `labelIds` (array, optional): Only return messages with labels that match all of the specified label IDs.
- `includeSpamTrash` (boolean, optional): Include messages from SPAM and TRASH in the results. (default: false)
</Accordion>
<Accordion title="gmail/send_email">
@@ -77,6 +80,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `from` (string, optional): Sender email address (if different from authenticated user).
- `replyTo` (string, optional): Reply-to email address.
- `threadId` (string, optional): Thread ID if replying to an existing conversation.
</Accordion>
<Accordion title="gmail/delete_email">
@@ -85,6 +89,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `userId` (string, required): The user's email address or 'me' for the authenticated user.
- `id` (string, required): The ID of the message to delete.
</Accordion>
<Accordion title="gmail/create_draft">
@@ -94,6 +99,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `userId` (string, required): The user's email address or 'me' for the authenticated user.
- `message` (object, required): Message object containing the draft content.
- `raw` (string, required): Base64url encoded email message.
</Accordion>
<Accordion title="gmail/get_message">
@@ -104,6 +110,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `id` (string, required): The ID of the message to retrieve.
- `format` (string, optional): The format to return the message in. Options: "full", "metadata", "minimal", "raw". (default: "full")
- `metadataHeaders` (array, optional): When given and format is METADATA, only include headers specified.
</Accordion>
<Accordion title="gmail/get_attachment">
@@ -113,6 +120,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `userId` (string, required): The user's email address or 'me' for the authenticated user. (default: "me")
- `messageId` (string, required): The ID of the message containing the attachment.
- `id` (string, required): The ID of the attachment to retrieve.
</Accordion>
<Accordion title="gmail/fetch_thread">
@@ -123,6 +131,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `id` (string, required): The ID of the thread to retrieve.
- `format` (string, optional): The format to return the messages in. Options: "full", "metadata", "minimal". (default: "full")
- `metadataHeaders` (array, optional): When given and format is METADATA, only include headers specified.
</Accordion>
<Accordion title="gmail/modify_thread">
@@ -133,6 +142,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `id` (string, required): The ID of the thread to modify.
- `addLabelIds` (array, optional): A list of IDs of labels to add to this thread.
- `removeLabelIds` (array, optional): A list of IDs of labels to remove from this thread.
</Accordion>
<Accordion title="gmail/trash_thread">
@@ -141,6 +151,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `userId` (string, required): The user's email address or 'me' for the authenticated user. (default: "me")
- `id` (string, required): The ID of the thread to trash.
</Accordion>
<Accordion title="gmail/untrash_thread">
@@ -149,6 +160,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `userId` (string, required): The user's email address or 'me' for the authenticated user. (default: "me")
- `id` (string, required): The ID of the thread to untrash.
</Accordion>
</AccordionGroup>
@@ -286,5 +298,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Gmail integration setup or troubleshooting.
Contact our support team for assistance with Gmail integration setup or
troubleshooting.
</Card>

21
docs/en/enterprise/integrations/google_calendar.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage calendar events, schedules, and availability throug
Before using the Google Calendar integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Google account with Google Calendar access
- Connected your Google account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Google Calendar integration, ensure you have:
### 1. Connect Your Google Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Google Calendar** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for calendar access
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -69,6 +71,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `timeZone` (string, optional): Time zone used in the response. The default is UTC.
- `groupExpansionMax` (integer, optional): Maximal number of calendar identifiers to be provided for a single group. Maximum: 100
- `calendarExpansionMax` (integer, optional): Maximal number of calendars for which FreeBusy information is to be provided. Maximum: 50
</Accordion>
<Accordion title="google_calendar/create_event">
@@ -117,6 +120,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
```
- `visibility` (string, optional): Visibility of the event. Options: default, public, private, confidential. Default: default
- `transparency` (string, optional): Whether the event blocks time on the calendar. Options: opaque, transparent. Default: opaque
</Accordion>
<Accordion title="google_calendar/view_events">
@@ -136,6 +140,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `timeZone` (string, optional): Time zone used in the response.
- `updatedMin` (string, optional): Lower bound for an event's last modification time (RFC3339) to filter by.
- `iCalUID` (string, optional): Specifies an event ID in the iCalendar format to be provided in the response.
</Accordion>
<Accordion title="google_calendar/update_event">
@@ -148,6 +153,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Updated event description
- `start_dateTime` (string, optional): Updated start time
- `end_dateTime` (string, optional): Updated end time
</Accordion>
<Accordion title="google_calendar/delete_event">
@@ -156,6 +162,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `calendarId` (string, required): Calendar ID
- `eventId` (string, required): Event ID to delete
</Accordion>
<Accordion title="google_calendar/view_calendar_list">
@@ -167,6 +174,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `showDeleted` (boolean, optional): Whether to include deleted calendar list entries in the result. Default: false
- `showHidden` (boolean, optional): Whether to show hidden entries. Default: false
- `minAccessRole` (string, optional): The minimum access role for the user in the returned entries. Options: freeBusyReader, owner, reader, writer
</Accordion>
</AccordionGroup>
@@ -327,22 +335,26 @@ crew.kickoff()
### Common Issues
**Authentication Errors**
- Ensure your Google account has the necessary permissions for calendar access
- Verify that the OAuth connection includes all required scopes for Google Calendar API
- Check if calendar sharing settings allow the required access level
**Event Creation Issues**
- Verify that time formats are correct (RFC3339 format)
- Ensure attendee email addresses are properly formatted
- Check that the target calendar exists and is accessible
- Verify time zones are correctly specified
**Availability and Time Conflicts**
- Use proper RFC3339 format for time ranges when checking availability
- Ensure time zones are consistent across all operations
- Verify that calendar IDs are correct when checking multiple calendars
**Event Updates and Deletions**
- Verify that event IDs are correct and events exist
- Ensure you have edit permissions for the events
- Check that calendar ownership allows modifications
@@ -350,5 +362,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Google Calendar integration setup or troubleshooting.
Contact our support team for assistance with Google Calendar integration setup
or troubleshooting.
</Card>

30
docs/en/enterprise/integrations/google_contacts.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage contacts and directory information through Google C
Before using the Google Contacts integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Google account with Google Contacts access
- Connected your Google account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Google Contacts integration, ensure you have:
### 1. Connect Your Google Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Google Contacts** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for contacts and directory access
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -61,6 +63,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `personFields` (string, optional): Fields to include (e.g., 'names,emailAddresses,phoneNumbers'). Default: names,emailAddresses,phoneNumbers
- `requestSyncToken` (boolean, optional): Whether the response should include a sync token. Default: false
- `sortOrder` (string, optional): The order in which the connections should be sorted. Options: LAST_MODIFIED_ASCENDING, LAST_MODIFIED_DESCENDING, FIRST_NAME_ASCENDING, LAST_NAME_ASCENDING
</Accordion>
<Accordion title="google_contacts/search_contacts">
@@ -72,6 +75,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `pageSize` (integer, optional): Number of results to return. Minimum: 1, Maximum: 30
- `pageToken` (string, optional): Token specifying which result page to return.
- `sources` (array, optional): The sources to search in. Options: READ_SOURCE_TYPE_CONTACT, READ_SOURCE_TYPE_PROFILE. Default: READ_SOURCE_TYPE_CONTACT
</Accordion>
<Accordion title="google_contacts/list_directory_people">
@@ -84,6 +88,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `readMask` (string, optional): Fields to read (e.g., 'names,emailAddresses')
- `requestSyncToken` (boolean, optional): Whether the response should include a sync token. Default: false
- `mergeSources` (array, optional): Additional data to merge into the directory people responses. Options: CONTACT
</Accordion>
<Accordion title="google_contacts/search_directory_people">
@@ -94,6 +99,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sources` (string, required): Directory sources (use 'DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE')
- `pageSize` (integer, optional): Number of results to return
- `readMask` (string, optional): Fields to read
</Accordion>
<Accordion title="google_contacts/list_other_contacts">
@@ -104,6 +110,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `pageToken` (string, optional): Token specifying which result page to return.
- `readMask` (string, optional): Fields to read
- `requestSyncToken` (boolean, optional): Whether the response should include a sync token. Default: false
</Accordion>
<Accordion title="google_contacts/search_other_contacts">
@@ -113,6 +120,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `query` (string, required): Search query
- `readMask` (string, required): Fields to read (e.g., 'names,emailAddresses')
- `pageSize` (integer, optional): Number of results
</Accordion>
<Accordion title="google_contacts/get_person">
@@ -121,6 +129,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `resourceName` (string, required): The resource name of the person to get (e.g., 'people/c123456789')
- `personFields` (string, optional): Fields to include (e.g., 'names,emailAddresses,phoneNumbers'). Default: names,emailAddresses,phoneNumbers
</Accordion>
<Accordion title="google_contacts/create_contact">
@@ -174,6 +183,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
}
]
```
</Accordion>
<Accordion title="google_contacts/update_contact">
@@ -185,6 +195,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `names` (array, optional): Person's names
- `emailAddresses` (array, optional): Email addresses
- `phoneNumbers` (array, optional): Phone numbers
</Accordion>
<Accordion title="google_contacts/delete_contact">
@@ -192,6 +203,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `resourceName` (string, required): The resource name of the person to delete (e.g., 'people/c123456789')
</Accordion>
<Accordion title="google_contacts/batch_get_people">
@@ -200,6 +212,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `resourceNames` (array, required): Resource names of people to get. Maximum: 200 items
- `personFields` (string, optional): Fields to include (e.g., 'names,emailAddresses,phoneNumbers'). Default: names,emailAddresses,phoneNumbers
</Accordion>
<Accordion title="google_contacts/list_contact_groups">
@@ -209,6 +222,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `pageSize` (integer, optional): Number of contact groups to return. Minimum: 1, Maximum: 1000
- `pageToken` (string, optional): Token specifying which result page to return.
- `groupFields` (string, optional): Fields to include (e.g., 'name,memberCount,clientData'). Default: name,memberCount
</Accordion>
</AccordionGroup>
@@ -377,36 +391,43 @@ crew.kickoff()
### Common Issues
**Permission Errors**
- Ensure your Google account has appropriate permissions for contacts access
- Verify that the OAuth connection includes required scopes for Google Contacts API
- Check that directory access permissions are granted for organization contacts
**Resource Name Format Issues**
- Ensure resource names follow the correct format (e.g., 'people/c123456789' for contacts)
- Verify that contact group resource names use the format 'contactGroups/groupId'
- Check that resource names exist and are accessible
**Search and Query Issues**
- Ensure search queries are properly formatted and not empty
- Use appropriate readMask fields for the data you need
- Verify that search sources are correctly specified (contacts vs profiles)
**Contact Creation and Updates**
- Ensure required fields are provided when creating contacts
- Verify that email addresses and phone numbers are properly formatted
- Check that updatePersonFields parameter includes all fields being updated
**Directory Access Issues**
- Ensure you have appropriate permissions to access organization directory
- Verify that directory sources are correctly specified
- Check that your organization allows API access to directory information
**Pagination and Limits**
- Be mindful of page size limits (varies by endpoint)
- Use pageToken for pagination through large result sets
- Respect API rate limits and implement appropriate delays
**Contact Groups and Organization**
- Ensure contact group names are unique when creating new groups
- Verify that contacts exist before adding them to groups
- Check that you have permissions to modify contact groups
@@ -414,5 +435,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Google Contacts integration setup or troubleshooting.
Contact our support team for assistance with Google Contacts integration setup
or troubleshooting.
</Card>

24
docs/en/enterprise/integrations/google_docs.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to create, edit, and manage Google Docs documents with text m
Before using the Google Docs integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Google account with Google Docs access
- Connected your Google account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Google Docs integration, ensure you have:
### 1. Connect Your Google Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Google Docs** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for document access
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -57,6 +59,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `title` (string, optional): The title for the new document.
</Accordion>
<Accordion title="google_docs/get_document">
@@ -66,6 +69,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `documentId` (string, required): The ID of the document to retrieve.
- `includeTabsContent` (boolean, optional): Whether to include tab content. Default is `false`.
- `suggestionsViewMode` (string, optional): The suggestions view mode to apply to the document. Enum: `DEFAULT_FOR_CURRENT_ACCESS`, `PREVIEW_SUGGESTIONS_ACCEPTED`, `PREVIEW_WITHOUT_SUGGESTIONS`. Default is `DEFAULT_FOR_CURRENT_ACCESS`.
</Accordion>
<Accordion title="google_docs/batch_update">
@@ -75,6 +79,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `documentId` (string, required): The ID of the document to update.
- `requests` (array, required): A list of updates to apply to the document. Each item is an object representing a request.
- `writeControl` (object, optional): Provides control over how write requests are executed. Contains `requiredRevisionId` (string) and `targetRevisionId` (string).
</Accordion>
<Accordion title="google_docs/insert_text">
@@ -84,6 +89,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `documentId` (string, required): The ID of the document to update.
- `text` (string, required): The text to insert.
- `index` (integer, optional): The zero-based index where to insert the text. Default is `1`.
</Accordion>
<Accordion title="google_docs/replace_text">
@@ -94,6 +100,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `containsText` (string, required): The text to find and replace.
- `replaceText` (string, required): The text to replace it with.
- `matchCase` (boolean, optional): Whether the search should respect case. Default is `false`.
</Accordion>
<Accordion title="google_docs/delete_content_range">
@@ -103,6 +110,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `documentId` (string, required): The ID of the document to update.
- `startIndex` (integer, required): The start index of the range to delete.
- `endIndex` (integer, required): The end index of the range to delete.
</Accordion>
<Accordion title="google_docs/insert_page_break">
@@ -111,6 +119,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `documentId` (string, required): The ID of the document to update.
- `index` (integer, optional): The zero-based index where to insert the page break. Default is `1`.
</Accordion>
<Accordion title="google_docs/create_named_range">
@@ -121,6 +130,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `name` (string, required): The name for the named range.
- `startIndex` (integer, required): The start index of the range.
- `endIndex` (integer, required): The end index of the range.
</Accordion>
</AccordionGroup>
@@ -216,29 +226,35 @@ crew.kickoff()
### Common Issues
**Authentication Errors**
- Ensure your Google account has the necessary permissions for Google Docs access.
- Verify that the OAuth connection includes all required scopes (`https://www.googleapis.com/auth/documents`).
**Document ID Issues**
- Double-check document IDs for correctness.
- Ensure the document exists and is accessible to your account.
- Document IDs can be found in the Google Docs URL.
**Text Insertion and Range Operations**
- When using `insert_text` or `delete_content_range`, ensure index positions are valid.
- Remember that Google Docs uses zero-based indexing.
- The document must have content at the specified index positions.
**Batch Update Request Formatting**
- When using `batch_update`, ensure the `requests` array is correctly formatted according to the Google Docs API documentation.
- Complex updates require specific JSON structures for each request type.
**Replace Text Operations**
- For `replace_text`, ensure the `containsText` parameter exactly matches the text you want to replace.
- Use `matchCase` parameter to control case sensitivity.
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Google Docs integration setup or troubleshooting.
Contact our support team for assistance with Google Docs integration setup or
troubleshooting.
</Card>

16
docs/en/enterprise/integrations/google_drive.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage files and folders through Google Drive. Upload, dow
Before using the Google Drive integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Google account with Google Drive access
- Connected your Google account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Google Drive integration, ensure you have:
### 1. Connect Your Google Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Google Drive** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for file and folder management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -57,6 +59,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the file to retrieve.
</Accordion>
<Accordion title="google_drive/list_files">
@@ -68,6 +71,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `page_token` (string, optional): Token for retrieving the next page of results.
- `order_by` (string, optional): Sort order (example: "name", "createdTime desc", "modifiedTime").
- `spaces` (string, optional): Comma-separated list of spaces to query (drive, appDataFolder, photos).
</Accordion>
<Accordion title="google_drive/upload_file">
@@ -79,6 +83,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `mime_type` (string, optional): MIME type of the file (example: "text/plain", "application/pdf").
- `parent_folder_id` (string, optional): ID of the parent folder where the file should be created.
- `description` (string, optional): Description of the file.
</Accordion>
<Accordion title="google_drive/download_file">
@@ -87,6 +92,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the file to download.
- `mime_type` (string, optional): MIME type for export (required for Google Workspace documents).
</Accordion>
<Accordion title="google_drive/create_folder">
@@ -96,6 +102,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `name` (string, required): Name of the folder to create.
- `parent_folder_id` (string, optional): ID of the parent folder where the new folder should be created.
- `description` (string, optional): Description of the folder.
</Accordion>
<Accordion title="google_drive/delete_file">
@@ -103,6 +110,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the file to delete.
</Accordion>
<Accordion title="google_drive/share_file">
@@ -116,6 +124,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `domain` (string, optional): The domain to share with (required for domain type).
- `send_notification_email` (boolean, optional): Whether to send a notification email (default: true).
- `email_message` (string, optional): A plain text custom message to include in the notification email.
</Accordion>
<Accordion title="google_drive/update_file">
@@ -129,6 +138,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): New description for the file.
- `add_parents` (string, optional): Comma-separated list of parent folder IDs to add.
- `remove_parents` (string, optional): Comma-separated list of parent folder IDs to remove.
</Accordion>
</AccordionGroup>

22
docs/en/enterprise/integrations/google_sheets.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage spreadsheet data through Google Sheets. Read rows,
Before using the Google Sheets integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Google account with Google Sheets access
- Connected your Google account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
- Spreadsheets with proper column headers for data operations
@@ -22,7 +22,7 @@ Before using the Google Sheets integration, ensure you have:
### 1. Connect Your Google Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Google Sheets** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for spreadsheet access
@@ -37,7 +37,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -61,6 +63,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `ranges` (array, optional): The ranges to retrieve from the spreadsheet.
- `includeGridData` (boolean, optional): True if grid data should be returned. Default: false
- `fields` (string, optional): The fields to include in the response. Use this to improve performance by only returning needed data.
</Accordion>
<Accordion title="google_sheets/get_values">
@@ -72,6 +75,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `valueRenderOption` (string, optional): How values should be represented in the output. Options: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA. Default: FORMATTED_VALUE
- `dateTimeRenderOption` (string, optional): How dates, times, and durations should be represented in the output. Options: SERIAL_NUMBER, FORMATTED_STRING. Default: SERIAL_NUMBER
- `majorDimension` (string, optional): The major dimension that results should use. Options: ROWS, COLUMNS. Default: ROWS
</Accordion>
<Accordion title="google_sheets/update_values">
@@ -88,6 +92,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
]
```
- `valueInputOption` (string, optional): How the input data should be interpreted. Options: RAW, USER_ENTERED. Default: USER_ENTERED
</Accordion>
<Accordion title="google_sheets/append_values">
@@ -105,6 +110,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
```
- `valueInputOption` (string, optional): How the input data should be interpreted. Options: RAW, USER_ENTERED. Default: USER_ENTERED
- `insertDataOption` (string, optional): How the input data should be inserted. Options: OVERWRITE, INSERT_ROWS. Default: INSERT_ROWS
</Accordion>
<Accordion title="google_sheets/create_spreadsheet">
@@ -122,6 +128,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
}
]
```
</Accordion>
</AccordionGroup>
@@ -319,31 +326,37 @@ crew.kickoff()
### Common Issues
**Permission Errors**
- Ensure your Google account has edit access to the target spreadsheets
- Verify that the OAuth connection includes required scopes for Google Sheets API
- Check that spreadsheets are shared with the authenticated account
**Spreadsheet Structure Issues**
- Ensure worksheets have proper column headers before creating or updating rows
- Verify that range notation (A1 format) is correct for the target cells
- Check that the specified spreadsheet ID exists and is accessible
**Data Type and Format Issues**
- Ensure data values match the expected format for each column
- Use proper date formats for date columns (ISO format recommended)
- Verify that numeric values are properly formatted for number columns
**Range and Cell Reference Issues**
- Use proper A1 notation for ranges (e.g., "A1:C10", "Sheet1!A1:B5")
- Ensure range references don't exceed the actual spreadsheet dimensions
- Verify that sheet names in range references match actual sheet names
**Value Input and Rendering Options**
- Choose appropriate `valueInputOption` (RAW vs USER_ENTERED) for your data
- Select proper `valueRenderOption` based on how you want data formatted
- Consider `dateTimeRenderOption` for consistent date/time handling
**Spreadsheet Creation Issues**
- Ensure spreadsheet titles are unique and follow naming conventions
- Verify that sheet properties are properly structured when creating sheets
- Check that you have permissions to create new spreadsheets in your account
@@ -351,5 +364,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Google Sheets integration setup or troubleshooting.
Contact our support team for assistance with Google Sheets integration setup
or troubleshooting.
</Card>

28
docs/en/enterprise/integrations/google_slides.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to create, edit, and manage Google Slides presentations. Crea
Before using the Google Slides integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Google account with Google Slides access
- Connected your Google account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Google Slides integration, ensure you have:
### 1. Connect Your Google Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Google Slides** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for presentations, spreadsheets, and drive access
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -57,6 +59,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `title` (string, required): The title of the presentation.
</Accordion>
<Accordion title="google_slides/get_presentation">
@@ -65,6 +68,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `presentationId` (string, required): The ID of the presentation to retrieve.
- `fields` (string, optional): The fields to include in the response. Use this to improve performance by only returning needed data.
</Accordion>
<Accordion title="google_slides/batch_update_presentation">
@@ -89,6 +93,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"requiredRevisionId": "revision_id_string"
}
```
</Accordion>
<Accordion title="google_slides/get_page">
@@ -97,6 +102,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `presentationId` (string, required): The ID of the presentation.
- `pageObjectId` (string, required): The ID of the page to retrieve.
</Accordion>
<Accordion title="google_slides/get_thumbnail">
@@ -105,6 +111,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `presentationId` (string, required): The ID of the presentation.
- `pageObjectId` (string, required): The ID of the page for thumbnail generation.
</Accordion>
<Accordion title="google_slides/import_data_from_sheet">
@@ -114,6 +121,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `presentationId` (string, required): The ID of the presentation.
- `sheetId` (string, required): The ID of the Google Sheet to import from.
- `dataRange` (string, required): The range of data to import from the sheet.
</Accordion>
<Accordion title="google_slides/upload_file_to_drive">
@@ -122,6 +130,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file` (string, required): The file data to upload.
- `presentationId` (string, required): The ID of the presentation to link the uploaded file.
</Accordion>
<Accordion title="google_slides/link_file_to_presentation">
@@ -130,6 +139,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `presentationId` (string, required): The ID of the presentation.
- `fileId` (string, required): The ID of the file to link.
</Accordion>
<Accordion title="google_slides/get_all_presentations">
@@ -138,6 +148,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `pageSize` (integer, optional): The number of presentations to return per page.
- `pageToken` (string, optional): A token for pagination.
</Accordion>
<Accordion title="google_slides/delete_presentation">
@@ -145,6 +156,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `presentationId` (string, required): The ID of the presentation to delete.
</Accordion>
</AccordionGroup>
@@ -346,36 +358,43 @@ crew.kickoff()
### Common Issues
**Permission Errors**
- Ensure your Google account has appropriate permissions for Google Slides
- Verify that the OAuth connection includes required scopes for presentations, spreadsheets, and drive access
- Check that presentations are shared with the authenticated account
**Presentation ID Issues**
- Verify that presentation IDs are correct and presentations exist
- Ensure you have access permissions to the presentations you're trying to modify
- Check that presentation IDs are properly formatted
**Content Update Issues**
- Ensure batch update requests are properly formatted according to Google Slides API specifications
- Verify that object IDs for slides and elements exist in the presentation
- Check that write control revision IDs are current if using optimistic concurrency
**Data Import Issues**
- Verify that Google Sheet IDs are correct and accessible
- Ensure data ranges are properly specified using A1 notation
- Check that you have read permissions for the source spreadsheets
**File Upload and Linking Issues**
- Ensure file data is properly encoded for upload
- Verify that Drive file IDs are correct when linking files
- Check that you have appropriate Drive permissions for file operations
**Page and Thumbnail Operations**
- Verify that page object IDs exist in the specified presentation
- Ensure presentations have content before attempting to generate thumbnails
- Check that page structure is valid for thumbnail generation
**Pagination and Listing Issues**
- Use appropriate page sizes for listing presentations
- Implement proper pagination using page tokens for large result sets
- Handle empty result sets gracefully
@@ -383,5 +402,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Google Slides integration setup or troubleshooting.
Contact our support team for assistance with Google Slides integration setup
or troubleshooting.
</Card>

43
docs/en/enterprise/integrations/hubspot.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage companies and contacts within HubSpot. Create new r
Before using the HubSpot integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription.
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription.
- A HubSpot account with appropriate permissions.
- Connected your HubSpot account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors).
@@ -21,7 +21,7 @@ Before using the HubSpot integration, ensure you have:
### 1. Connect Your HubSpot Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors).
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors).
2. Find **HubSpot** in the Authentication Integrations section.
3. Click **Connect** and complete the OAuth flow.
4. Grant the necessary permissions for company and contact management.
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -115,6 +117,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `web_technologies` (string, optional): Web Technologies used. Must be one of the predefined values.
- `website` (string, optional): Website URL.
- `founded_year` (string, optional): Year Founded.
</Accordion>
<Accordion title="hubspot/create_contact">
@@ -214,6 +217,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `hs_whatsapp_phone_number` (string, optional): WhatsApp Phone Number.
- `work_email` (string, optional): Work email.
- `hs_googleplusid` (string, optional): googleplus ID.
</Accordion>
<Accordion title="hubspot/create_deal">
@@ -229,6 +233,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `dealtype` (string, optional): The type of deal. Available values: `newbusiness`, `existingbusiness`.
- `description` (string, optional): A description of the deal.
- `hs_priority` (string, optional): The priority of the deal. Available values: `low`, `medium`, `high`.
</Accordion>
<Accordion title="hubspot/create_record_engagements">
@@ -246,6 +251,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `hs_meeting_body` (string, optional): The description for the meeting. (Used for `MEETING`)
- `hs_meeting_start_time` (string, optional): The start time of the meeting. (Used for `MEETING`)
- `hs_meeting_end_time` (string, optional): The end time of the meeting. (Used for `MEETING`)
</Accordion>
<Accordion title="hubspot/update_company">
@@ -263,6 +269,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `numberofemployees` (number, optional): Number of Employees.
- `annualrevenue` (number, optional): Annual Revenue.
- `description` (string, optional): Description.
</Accordion>
<Accordion title="hubspot/create_record_any">
@@ -271,6 +278,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordType` (string, required): The object type ID of the custom object.
- Additional parameters depend on the custom object's schema.
</Accordion>
<Accordion title="hubspot/update_contact">
@@ -285,6 +293,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `company` (string, optional): Company Name.
- `jobtitle` (string, optional): Job Title.
- `lifecyclestage` (string, optional): Lifecycle Stage.
</Accordion>
<Accordion title="hubspot/update_deal">
@@ -298,6 +307,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `pipeline` (string, optional): The pipeline the deal belongs to.
- `closedate` (string, optional): The date the deal is expected to close.
- `dealtype` (string, optional): The type of deal.
</Accordion>
<Accordion title="hubspot/update_record_engagements">
@@ -309,6 +319,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `hs_task_subject` (string, optional): The title of the task.
- `hs_task_body` (string, optional): The notes for the task.
- `hs_task_status` (string, optional): The status of the task.
</Accordion>
<Accordion title="hubspot/update_record_any">
@@ -318,6 +329,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `recordId` (string, required): The ID of the record to update.
- `recordType` (string, required): The object type ID of the custom object.
- Additional parameters depend on the custom object's schema.
</Accordion>
<Accordion title="hubspot/list_companies">
@@ -325,6 +337,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `paginationParameters` (object, optional): Use `pageCursor` to fetch subsequent pages.
</Accordion>
<Accordion title="hubspot/list_contacts">
@@ -332,6 +345,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `paginationParameters` (object, optional): Use `pageCursor` to fetch subsequent pages.
</Accordion>
<Accordion title="hubspot/list_deals">
@@ -339,6 +353,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `paginationParameters` (object, optional): Use `pageCursor` to fetch subsequent pages.
</Accordion>
<Accordion title="hubspot/get_records_engagements">
@@ -347,6 +362,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `objectName` (string, required): The type of engagement to fetch (e.g., "notes").
- `paginationParameters` (object, optional): Use `pageCursor` to fetch subsequent pages.
</Accordion>
<Accordion title="hubspot/get_records_any">
@@ -355,6 +371,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordType` (string, required): The object type ID of the custom object.
- `paginationParameters` (object, optional): Use `pageCursor` to fetch subsequent pages.
</Accordion>
<Accordion title="hubspot/get_company">
@@ -362,6 +379,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): The ID of the company to retrieve.
</Accordion>
<Accordion title="hubspot/get_contact">
@@ -369,6 +387,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): The ID of the contact to retrieve.
</Accordion>
<Accordion title="hubspot/get_deal">
@@ -376,6 +395,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): The ID of the deal to retrieve.
</Accordion>
<Accordion title="hubspot/get_record_by_id_engagements">
@@ -383,6 +403,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): The ID of the engagement to retrieve.
</Accordion>
<Accordion title="hubspot/get_record_by_id_any">
@@ -391,6 +412,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordType` (string, required): The object type ID of the custom object.
- `recordId` (string, required): The ID of the record to retrieve.
</Accordion>
<Accordion title="hubspot/search_companies">
@@ -399,6 +421,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `filterFormula` (object, optional): A filter in disjunctive normal form (OR of ANDs).
- `paginationParameters` (object, optional): Use `pageCursor` to fetch subsequent pages.
</Accordion>
<Accordion title="hubspot/search_contacts">
@@ -407,6 +430,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `filterFormula` (object, optional): A filter in disjunctive normal form (OR of ANDs).
- `paginationParameters` (object, optional): Use `pageCursor` to fetch subsequent pages.
</Accordion>
<Accordion title="hubspot/search_deals">
@@ -415,6 +439,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `filterFormula` (object, optional): A filter in disjunctive normal form (OR of ANDs).
- `paginationParameters` (object, optional): Use `pageCursor` to fetch subsequent pages.
</Accordion>
<Accordion title="hubspot/search_records_engagements">
@@ -423,6 +448,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `engagementFilterFormula` (object, optional): A filter for engagements.
- `paginationParameters` (object, optional): Use `pageCursor` to fetch subsequent pages.
</Accordion>
<Accordion title="hubspot/search_records_any">
@@ -432,6 +458,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `recordType` (string, required): The object type ID to search.
- `filterFormula` (string, optional): The filter formula to apply.
- `paginationParameters` (object, optional): Use `pageCursor` to fetch subsequent pages.
</Accordion>
<Accordion title="hubspot/delete_record_companies">
@@ -439,6 +466,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): The ID of the company to delete.
</Accordion>
<Accordion title="hubspot/delete_record_contacts">
@@ -446,6 +474,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): The ID of the contact to delete.
</Accordion>
<Accordion title="hubspot/delete_record_deals">
@@ -453,6 +482,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): The ID of the deal to delete.
</Accordion>
<Accordion title="hubspot/delete_record_engagements">
@@ -460,6 +490,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): The ID of the engagement to delete.
</Accordion>
<Accordion title="hubspot/delete_record_any">
@@ -468,6 +499,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordType` (string, required): The object type ID of the custom object.
- `recordId` (string, required): The ID of the record to delete.
</Accordion>
<Accordion title="hubspot/get_contacts_by_list_id">
@@ -476,6 +508,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listId` (string, required): The ID of the list to get contacts from.
- `paginationParameters` (object, optional): Use `pageCursor` for subsequent pages.
</Accordion>
<Accordion title="hubspot/describe_action_schema">
@@ -484,6 +517,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordType` (string, required): The object type ID (e.g., 'companies').
- `operation` (string, required): The operation type (e.g., 'CREATE_RECORD').
</Accordion>
</AccordionGroup>
@@ -577,5 +611,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with HubSpot integration setup or troubleshooting.
Contact our support team for assistance with HubSpot integration setup or
troubleshooting.
</Card>

29
docs/en/enterprise/integrations/jira.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage issues, projects, and workflows through Jira. Creat
Before using the Jira integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Jira account with appropriate project permissions
- Connected your Jira account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Jira integration, ensure you have:
### 1. Connect Your Jira Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Jira** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for issue and project management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -70,6 +72,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"customfield_10001": "value"
}
```
</Accordion>
<Accordion title="jira/update_issue">
@@ -85,6 +88,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- Options: `description`, `descriptionJSON`
- `description` (string, optional): Description - A detailed description of the issue. This field appears only when 'descriptionType' = 'description'.
- `additionalFields` (string, optional): Additional Fields - Specify any other fields that should be included in JSON format.
</Accordion>
<Accordion title="jira/get_issue_by_key">
@@ -92,6 +96,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `issueKey` (string, required): Issue Key (example: "TEST-1234").
</Accordion>
<Accordion title="jira/filter_issues">
@@ -118,6 +123,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
```
Available operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringContains`, `$stringDoesNotContain`, `$stringGreaterThan`, `$stringLessThan`
- `limit` (string, optional): Limit results - Limit the maximum number of issues to return. Defaults to 10 if left blank.
</Accordion>
<Accordion title="jira/search_by_jql">
@@ -131,12 +137,14 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"pageCursor": "cursor_string"
}
```
</Accordion>
<Accordion title="jira/update_issue_any">
**Description:** Update any issue in Jira. Use DESCRIBE_ACTION_SCHEMA to get properties schema for this function.
**Parameters:** No specific parameters - use JIRA_DESCRIBE_ACTION_SCHEMA first to get the expected schema.
</Accordion>
<Accordion title="jira/describe_action_schema">
@@ -146,6 +154,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `issueTypeId` (string, required): Issue Type ID.
- `projectKey` (string, required): Project key.
- `operation` (string, required): Operation Type value, for example CREATE_ISSUE or UPDATE_ISSUE.
</Accordion>
<Accordion title="jira/get_projects">
@@ -158,6 +167,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"pageCursor": "cursor_string"
}
```
</Accordion>
<Accordion title="jira/get_issue_types_by_project">
@@ -165,12 +175,14 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `project` (string, required): Project key.
</Accordion>
<Accordion title="jira/get_issue_types">
**Description:** Get all Issue Types in Jira.
**Parameters:** None required.
</Accordion>
<Accordion title="jira/get_issue_status_by_project">
@@ -178,6 +190,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `project` (string, required): Project key.
</Accordion>
<Accordion title="jira/get_all_assignees_by_project">
@@ -185,6 +198,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `project` (string, required): Project key.
</Accordion>
</AccordionGroup>
@@ -348,31 +362,37 @@ crew.kickoff()
### Common Issues
**Permission Errors**
- Ensure your Jira account has necessary permissions for the target projects
- Verify that the OAuth connection includes required scopes for Jira API
- Check if you have create/edit permissions for issues in the specified projects
**Invalid Project or Issue Keys**
- Double-check project keys and issue keys for correct format (e.g., "PROJ-123")
- Ensure projects exist and are accessible to your account
- Verify that issue keys reference existing issues
**Issue Type and Status Issues**
- Use JIRA_GET_ISSUE_TYPES_BY_PROJECT to get valid issue types for a project
- Use JIRA_GET_ISSUE_STATUS_BY_PROJECT to get valid statuses
- Ensure issue types and statuses are available in the target project
**JQL Query Problems**
- Test JQL queries in Jira's issue search before using in API calls
- Ensure field names in JQL are spelled correctly and exist in your Jira instance
- Use proper JQL syntax for complex queries
**Custom Fields and Schema Issues**
- Use JIRA_DESCRIBE_ACTION_SCHEMA to get the correct schema for complex issue types
- Ensure custom field IDs are correct (e.g., "customfield_10001")
- Verify that custom fields are available in the target project and issue type
**Filter Formula Issues**
- Ensure filter formulas follow the correct JSON structure for disjunctive normal form
- Use valid field names that exist in your Jira configuration
- Test simple filters before building complex multi-condition queries
@@ -380,5 +400,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Jira integration setup or troubleshooting.
Contact our support team for assistance with Jira integration setup or
troubleshooting.
</Card>

31
docs/en/enterprise/integrations/linear.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage issues, projects, and development workflows through
Before using the Linear integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Linear account with appropriate workspace permissions
- Connected your Linear account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Linear integration, ensure you have:
### 1. Connect Your Linear Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Linear** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for issue and project management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -70,6 +72,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"labelIds": ["a70bdf0f-530a-4887-857d-46151b52b47c"]
}
```
</Accordion>
<Accordion title="linear/update_issue">
@@ -90,6 +93,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"labelIds": ["a70bdf0f-530a-4887-857d-46151b52b47c"]
}
```
</Accordion>
<Accordion title="linear/get_issue_by_id">
@@ -97,6 +101,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `issueId` (string, required): Issue ID - Specify the record ID of the issue to fetch. (example: "90fbc706-18cd-42c9-ae66-6bd344cc8977").
</Accordion>
<Accordion title="linear/get_issue_by_issue_identifier">
@@ -104,6 +109,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `externalId` (string, required): External ID - Specify the human-readable Issue identifier of the issue to fetch. (example: "ABC-1").
</Accordion>
<Accordion title="linear/search_issue">
@@ -131,6 +137,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
```
Available fields: `title`, `number`, `project`, `createdAt`
Available operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$stringContains`, `$stringDoesNotContain`, `$stringGreaterThan`, `$stringLessThan`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$numberGreaterThan`, `$numberLessThan`, `$dateTimeAfter`, `$dateTimeBefore`
</Accordion>
<Accordion title="linear/delete_issue">
@@ -138,6 +145,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `issueId` (string, required): Issue ID - Specify the record ID of the issue to delete. (example: "90fbc706-18cd-42c9-ae66-6bd344cc8977").
</Accordion>
<Accordion title="linear/archive_issue">
@@ -145,6 +153,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `issueId` (string, required): Issue ID - Specify the record ID of the issue to archive. (example: "90fbc706-18cd-42c9-ae66-6bd344cc8977").
</Accordion>
<Accordion title="linear/create_sub_issue">
@@ -161,6 +170,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"lead": "linear_user_id"
}
```
</Accordion>
<Accordion title="linear/create_project">
@@ -183,6 +193,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"description": ""
}
```
</Accordion>
<Accordion title="linear/update_project">
@@ -199,6 +210,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"description": ""
}
```
</Accordion>
<Accordion title="linear/get_project_by_id">
@@ -206,6 +218,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `projectId` (string, required): Project ID - Specify the Project ID of the project to fetch. (example: "a6634484-6061-4ac7-9739-7dc5e52c796b").
</Accordion>
<Accordion title="linear/delete_project">
@@ -213,6 +226,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `projectId` (string, required): Project ID - Specify the Project ID of the project to delete. (example: "a6634484-6061-4ac7-9739-7dc5e52c796b").
</Accordion>
<Accordion title="linear/search_teams">
@@ -238,6 +252,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
}
```
Available fields: `id`, `name`
</Accordion>
</AccordionGroup>
@@ -401,37 +416,44 @@ crew.kickoff()
### Common Issues
**Permission Errors**
- Ensure your Linear account has necessary permissions for the target workspace
- Verify that the OAuth connection includes required scopes for Linear API
- Check if you have create/edit permissions for issues and projects in the workspace
**Invalid IDs and References**
- Double-check team IDs, issue IDs, and project IDs for correct UUID format
- Ensure referenced entities (teams, projects, cycles) exist and are accessible
- Verify that issue identifiers follow the correct format (e.g., "ABC-1")
**Team and Project Association Issues**
- Use LINEAR_SEARCH_TEAMS to get valid team IDs before creating issues or projects
- Ensure teams exist and are active in your workspace
- Verify that team IDs are properly formatted as UUIDs
**Issue Status and Priority Problems**
- Check that status IDs reference valid workflow states for the team
- Ensure priority values are within the valid range for your Linear configuration
- Verify that custom fields and labels exist before referencing them
**Date and Time Format Issues**
- Use ISO 8601 format for due dates and timestamps
- Ensure time zones are handled correctly for due date calculations
- Verify that date values are valid and in the future for due dates
**Search and Filter Issues**
- Ensure search queries are properly formatted and not empty
- Use valid field names in filter formulas: `title`, `number`, `project`, `createdAt`
- Test simple filters before building complex multi-condition queries
- Verify that operator types match the data types of the fields being filtered
**Sub-issue Creation Problems**
- Ensure parent issue IDs are valid and accessible
- Verify that the team ID for sub-issues matches or is compatible with the parent issue's team
- Check that parent issues are not already archived or deleted
@@ -439,5 +461,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Linear integration setup or troubleshooting.
Contact our support team for assistance with Linear integration setup or
troubleshooting.
</Card>

34
docs/en/enterprise/integrations/microsoft_excel.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to create and manage Excel workbooks, worksheets, tables, and
Before using the Microsoft Excel integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Microsoft 365 account with Excel and OneDrive/SharePoint access
- Connected your Microsoft account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Microsoft Excel integration, ensure you have:
### 1. Connect Your Microsoft Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Microsoft Excel** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for files and Excel workbook access
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -68,6 +70,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
}
]
```
</Accordion>
<Accordion title="microsoft_excel/get_workbooks">
@@ -79,6 +82,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `expand` (string, optional): Expand related resources inline
- `top` (integer, optional): Number of items to return. Minimum: 1, Maximum: 999
- `orderby` (string, optional): Order results by specified properties
</Accordion>
<Accordion title="microsoft_excel/get_worksheets">
@@ -91,6 +95,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `expand` (string, optional): Expand related resources inline
- `top` (integer, optional): Number of items to return. Minimum: 1, Maximum: 999
- `orderby` (string, optional): Order results by specified properties
</Accordion>
<Accordion title="microsoft_excel/create_worksheet">
@@ -99,6 +104,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the Excel file
- `name` (string, required): Name of the new worksheet
</Accordion>
<Accordion title="microsoft_excel/get_range_data">
@@ -108,6 +114,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `file_id` (string, required): The ID of the Excel file
- `worksheet_name` (string, required): Name of the worksheet
- `range` (string, required): Range address (e.g., 'A1:C10')
</Accordion>
<Accordion title="microsoft_excel/update_range_data">
@@ -125,6 +132,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
["Jane", 25, "Los Angeles"]
]
```
</Accordion>
<Accordion title="microsoft_excel/add_table">
@@ -135,6 +143,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `worksheet_name` (string, required): Name of the worksheet
- `range` (string, required): Range for the table (e.g., 'A1:D10')
- `has_headers` (boolean, optional): Whether the first row contains headers. Default: true
</Accordion>
<Accordion title="microsoft_excel/get_tables">
@@ -143,6 +152,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the Excel file
- `worksheet_name` (string, required): Name of the worksheet
</Accordion>
<Accordion title="microsoft_excel/add_table_row">
@@ -156,6 +166,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
```json
["John Doe", 35, "Manager", "Sales"]
```
</Accordion>
<Accordion title="microsoft_excel/create_chart">
@@ -167,6 +178,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `chart_type` (string, required): Type of chart (e.g., 'ColumnClustered', 'Line', 'Pie')
- `source_data` (string, required): Range of data for the chart (e.g., 'A1:B10')
- `series_by` (string, optional): How to interpret the data ('Auto', 'Columns', or 'Rows'). Default: Auto
</Accordion>
<Accordion title="microsoft_excel/get_cell">
@@ -177,6 +189,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `worksheet_name` (string, required): Name of the worksheet
- `row` (integer, required): Row number (0-based)
- `column` (integer, required): Column number (0-based)
</Accordion>
<Accordion title="microsoft_excel/get_used_range">
@@ -185,6 +198,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the Excel file
- `worksheet_name` (string, required): Name of the worksheet
</Accordion>
<Accordion title="microsoft_excel/list_charts">
@@ -193,6 +207,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the Excel file
- `worksheet_name` (string, required): Name of the worksheet
</Accordion>
<Accordion title="microsoft_excel/delete_worksheet">
@@ -201,6 +216,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the Excel file
- `worksheet_name` (string, required): Name of the worksheet to delete
</Accordion>
<Accordion title="microsoft_excel/delete_table">
@@ -210,6 +226,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `file_id` (string, required): The ID of the Excel file
- `worksheet_name` (string, required): Name of the worksheet
- `table_name` (string, required): Name of the table to delete
</Accordion>
<Accordion title="microsoft_excel/list_names">
@@ -217,6 +234,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the Excel file
</Accordion>
</AccordionGroup>
@@ -421,36 +439,43 @@ crew.kickoff()
### Common Issues
**Permission Errors**
- Ensure your Microsoft account has appropriate permissions for Excel and OneDrive/SharePoint
- Verify that the OAuth connection includes required scopes (Files.Read.All, Files.ReadWrite.All)
- Check that you have access to the specific workbooks you're trying to modify
**File ID and Path Issues**
- Verify that file IDs are correct and files exist in your OneDrive or SharePoint
- Ensure file paths are properly formatted when creating new workbooks
- Check that workbook files have the correct .xlsx extension
**Worksheet and Range Issues**
- Verify that worksheet names exist in the specified workbook
- Ensure range addresses are properly formatted (e.g., 'A1:C10')
- Check that ranges don't exceed worksheet boundaries
**Data Format Issues**
- Ensure data values are properly formatted for Excel (strings, numbers, integers)
- Verify that 2D arrays for ranges have consistent row and column counts
- Check that table data includes proper headers when has_headers is true
**Chart Creation Issues**
- Verify that chart types are supported (ColumnClustered, Line, Pie, etc.)
- Ensure source data ranges contain appropriate data for the chart type
- Check that the source data range exists and contains data
**Table Management Issues**
- Ensure table names are unique within worksheets
- Verify that table ranges don't overlap with existing tables
- Check that new row data matches the table's column structure
**Cell and Range Operations**
- Verify that row and column indices are 0-based for cell operations
- Ensure ranges contain data when using get_used_range
- Check that named ranges exist before referencing them
@@ -458,5 +483,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Microsoft Excel integration setup or troubleshooting.
Contact our support team for assistance with Microsoft Excel integration setup
or troubleshooting.
</Card>

28
docs/en/enterprise/integrations/microsoft_onedrive.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to upload, download, and manage files and folders in Microsof
Before using the Microsoft OneDrive integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Microsoft account with OneDrive access
- Connected your Microsoft account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Microsoft OneDrive integration, ensure you have:
### 1. Connect Your Microsoft Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Microsoft OneDrive** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for file access
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -59,6 +61,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `top` (integer, optional): Number of items to retrieve (max 1000). Default is `50`.
- `orderby` (string, optional): Order by field (e.g., "name asc", "lastModifiedDateTime desc"). Default is "name asc".
- `filter` (string, optional): OData filter expression.
</Accordion>
<Accordion title="microsoft_onedrive/get_file_info">
@@ -66,6 +69,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `item_id` (string, required): The ID of the file or folder.
</Accordion>
<Accordion title="microsoft_onedrive/download_file">
@@ -73,6 +77,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `item_id` (string, required): The ID of the file to download.
</Accordion>
<Accordion title="microsoft_onedrive/upload_file">
@@ -81,6 +86,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_name` (string, required): Name of the file to upload.
- `content` (string, required): Base64 encoded file content.
</Accordion>
<Accordion title="microsoft_onedrive/create_folder">
@@ -88,6 +94,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `folder_name` (string, required): Name of the folder to create.
</Accordion>
<Accordion title="microsoft_onedrive/delete_item">
@@ -95,6 +102,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `item_id` (string, required): The ID of the file or folder to delete.
</Accordion>
<Accordion title="microsoft_onedrive/copy_item">
@@ -104,6 +112,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `item_id` (string, required): The ID of the file or folder to copy.
- `parent_id` (string, optional): The ID of the destination folder (optional, defaults to root).
- `new_name` (string, optional): New name for the copied item (optional).
</Accordion>
<Accordion title="microsoft_onedrive/move_item">
@@ -113,6 +122,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `item_id` (string, required): The ID of the file or folder to move.
- `parent_id` (string, required): The ID of the destination folder.
- `new_name` (string, optional): New name for the item (optional).
</Accordion>
<Accordion title="microsoft_onedrive/search_files">
@@ -121,6 +131,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `query` (string, required): Search query string.
- `top` (integer, optional): Number of results to return (max 1000). Default is `50`.
</Accordion>
<Accordion title="microsoft_onedrive/share_item">
@@ -130,6 +141,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `item_id` (string, required): The ID of the file or folder to share.
- `type` (string, optional): Type of sharing link. Enum: `view`, `edit`, `embed`. Default is `view`.
- `scope` (string, optional): Scope of the sharing link. Enum: `anonymous`, `organization`. Default is `anonymous`.
</Accordion>
<Accordion title="microsoft_onedrive/get_thumbnails">
@@ -137,6 +149,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `item_id` (string, required): The ID of the file.
</Accordion>
</AccordionGroup>
@@ -232,29 +245,35 @@ crew.kickoff()
### Common Issues
**Authentication Errors**
- Ensure your Microsoft account has the necessary permissions for file access (e.g., `Files.Read`, `Files.ReadWrite`).
- Verify that the OAuth connection includes all required scopes.
**File Upload Issues**
- Ensure `file_name` and `content` are provided for file uploads.
- Content must be Base64 encoded for binary files.
- Check that you have write permissions to OneDrive.
**File/Folder ID Issues**
- Double-check item IDs for correctness when accessing specific files or folders.
- Item IDs are returned by other operations like `list_files` or `search_files`.
- Ensure the referenced items exist and are accessible.
**Search and Filter Operations**
- Use appropriate search terms for `search_files` operations.
- For `filter` parameters, use proper OData syntax.
**File Operations (Copy/Move)**
- For `move_item`, ensure both `item_id` and `parent_id` are provided.
- For `copy_item`, only `item_id` is required; `parent_id` defaults to root if not specified.
- Verify that destination folders exist and are accessible.
**Sharing Link Creation**
- Ensure the item exists before creating sharing links.
- Choose appropriate `type` and `scope` based on your sharing requirements.
- `anonymous` scope allows access without sign-in; `organization` requires organizational account.
@@ -262,5 +281,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Microsoft OneDrive integration setup or troubleshooting.
Contact our support team for assistance with Microsoft OneDrive integration
setup or troubleshooting.
</Card>

22
docs/en/enterprise/integrations/microsoft_outlook.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to access and manage Outlook emails, calendar events, and con
Before using the Microsoft Outlook integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Microsoft account with Outlook access
- Connected your Microsoft account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Microsoft Outlook integration, ensure you have:
### 1. Connect Your Microsoft Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Microsoft Outlook** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for mail, calendar, and contact access
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -62,6 +64,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `orderby` (string, optional): Order by field (e.g., "receivedDateTime desc"). Default is "receivedDateTime desc".
- `select` (string, optional): Select specific properties to return.
- `expand` (string, optional): Expand related resources inline.
</Accordion>
<Accordion title="microsoft_outlook/send_email">
@@ -77,6 +80,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `importance` (string, optional): Message importance level. Enum: `low`, `normal`, `high`. Default is `normal`.
- `reply_to` (array, optional): Array of reply-to email addresses.
- `save_to_sent_items` (boolean, optional): Whether to save the message to Sent Items folder. Default is `true`.
</Accordion>
<Accordion title="microsoft_outlook/get_calendar_events">
@@ -87,6 +91,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `skip` (integer, optional): Number of events to skip. Default is `0`.
- `filter` (string, optional): OData filter expression (e.g., "start/dateTime ge '2024-01-01T00:00:00Z'").
- `orderby` (string, optional): Order by field (e.g., "start/dateTime asc"). Default is "start/dateTime asc".
</Accordion>
<Accordion title="microsoft_outlook/create_calendar_event">
@@ -100,6 +105,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `timezone` (string, optional): Time zone (e.g., 'Pacific Standard Time'). Default is `UTC`.
- `location` (string, optional): Event location.
- `attendees` (array, optional): Array of attendee email addresses.
</Accordion>
<Accordion title="microsoft_outlook/get_contacts">
@@ -110,6 +116,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `skip` (integer, optional): Number of contacts to skip. Default is `0`.
- `filter` (string, optional): OData filter expression.
- `orderby` (string, optional): Order by field (e.g., "displayName asc"). Default is "displayName asc".
</Accordion>
<Accordion title="microsoft_outlook/create_contact">
@@ -124,6 +131,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `homePhones` (array, optional): Array of home phone numbers.
- `jobTitle` (string, optional): Contact's job title.
- `companyName` (string, optional): Contact's company name.
</Accordion>
</AccordionGroup>
@@ -219,30 +227,36 @@ crew.kickoff()
### Common Issues
**Authentication Errors**
- Ensure your Microsoft account has the necessary permissions for mail, calendar, and contact access.
- Required scopes include: `Mail.Read`, `Mail.Send`, `Calendars.Read`, `Calendars.ReadWrite`, `Contacts.Read`, `Contacts.ReadWrite`.
- Verify that the OAuth connection includes all required scopes.
**Email Sending Issues**
- Ensure `to_recipients`, `subject`, and `body` are provided for `send_email`.
- Check that email addresses are properly formatted.
- Verify that the account has `Mail.Send` permissions.
**Calendar Event Creation**
- Ensure `subject`, `start_datetime`, and `end_datetime` are provided.
- Use proper ISO 8601 format for datetime fields (e.g., '2024-01-20T10:00:00').
- Verify timezone settings if events appear at incorrect times.
**Contact Management**
- For `create_contact`, ensure `displayName` is provided as it's required.
- When providing `emailAddresses`, use the proper object format with `address` and `name` properties.
**Search and Filter Issues**
- Use proper OData syntax for `filter` parameters.
- For date filters, use ISO 8601 format (e.g., "receivedDateTime ge '2024-01-01T00:00:00Z'").
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Microsoft Outlook integration setup or troubleshooting.
Contact our support team for assistance with Microsoft Outlook integration
setup or troubleshooting.
</Card>

29
docs/en/enterprise/integrations/microsoft_sharepoint.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to access and manage SharePoint sites, lists, and document li
Before using the Microsoft SharePoint integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Microsoft 365 account with SharePoint access
- Connected your Microsoft account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Microsoft SharePoint integration, ensure you have:
### 1. Connect Your Microsoft Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Microsoft SharePoint** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for SharePoint sites and content access
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -63,6 +65,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `top` (integer, optional): Number of items to return. Minimum: 1, Maximum: 999
- `skip` (integer, optional): Number of items to skip. Minimum: 0
- `orderby` (string, optional): Order results by specified properties (e.g., 'displayName desc')
</Accordion>
<Accordion title="microsoft_sharepoint/get_site">
@@ -72,6 +75,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `site_id` (string, required): The ID of the SharePoint site
- `select` (string, optional): Select specific properties to return (e.g., 'displayName,id,webUrl,drives')
- `expand` (string, optional): Expand related resources inline (e.g., 'drives,lists')
</Accordion>
<Accordion title="microsoft_sharepoint/get_site_lists">
@@ -79,6 +83,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `site_id` (string, required): The ID of the SharePoint site
</Accordion>
<Accordion title="microsoft_sharepoint/get_list">
@@ -87,6 +92,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `site_id` (string, required): The ID of the SharePoint site
- `list_id` (string, required): The ID of the list
</Accordion>
<Accordion title="microsoft_sharepoint/get_list_items">
@@ -96,6 +102,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `site_id` (string, required): The ID of the SharePoint site
- `list_id` (string, required): The ID of the list
- `expand` (string, optional): Expand related data (e.g., 'fields')
</Accordion>
<Accordion title="microsoft_sharepoint/create_list_item">
@@ -112,6 +119,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"Status": "Active"
}
```
</Accordion>
<Accordion title="microsoft_sharepoint/update_list_item">
@@ -128,6 +136,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
"Status": "Completed"
}
```
</Accordion>
<Accordion title="microsoft_sharepoint/delete_list_item">
@@ -137,6 +146,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `site_id` (string, required): The ID of the SharePoint site
- `list_id` (string, required): The ID of the list
- `item_id` (string, required): The ID of the item to delete
</Accordion>
<Accordion title="microsoft_sharepoint/upload_file_to_library">
@@ -146,6 +156,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `site_id` (string, required): The ID of the SharePoint site
- `file_path` (string, required): The path where to upload the file (e.g., 'folder/filename.txt')
- `content` (string, required): The file content to upload
</Accordion>
<Accordion title="microsoft_sharepoint/get_drive_items">
@@ -153,6 +164,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `site_id` (string, required): The ID of the SharePoint site
</Accordion>
<Accordion title="microsoft_sharepoint/delete_drive_item">
@@ -161,6 +173,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `site_id` (string, required): The ID of the SharePoint site
- `item_id` (string, required): The ID of the file or folder to delete
</Accordion>
</AccordionGroup>
@@ -363,36 +376,43 @@ crew.kickoff()
### Common Issues
**Permission Errors**
- Ensure your Microsoft account has appropriate permissions for SharePoint sites
- Verify that the OAuth connection includes required scopes (Sites.Read.All, Sites.ReadWrite.All)
- Check that you have access to the specific sites and lists you're trying to access
**Site and List ID Issues**
- Verify that site IDs and list IDs are correct and properly formatted
- Ensure that sites and lists exist and are accessible to your account
- Use the get_sites and get_site_lists actions to discover valid IDs
**Field and Schema Issues**
- Ensure field names match exactly with the SharePoint list schema
- Verify that required fields are included when creating or updating list items
- Check that field types and values are compatible with the list column definitions
**File Upload Issues**
- Ensure file paths are properly formatted and don't contain invalid characters
- Verify that you have write permissions to the target document library
- Check that file content is properly encoded for upload
**OData Query Issues**
- Use proper OData syntax for filter, select, expand, and orderby parameters
- Verify that property names used in queries exist in the target resources
- Test simple queries before building complex filter expressions
**Pagination and Performance**
- Use top and skip parameters appropriately for large result sets
- Implement proper pagination for lists with many items
- Consider using select parameters to return only needed properties
**Document Library Operations**
- Ensure you have proper permissions for document library operations
- Verify that drive item IDs are correct when deleting files or folders
- Check that file paths don't conflict with existing content
@@ -400,5 +420,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Microsoft SharePoint integration setup or troubleshooting.
Contact our support team for assistance with Microsoft SharePoint integration
setup or troubleshooting.
</Card>

23
docs/en/enterprise/integrations/microsoft_teams.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to access Teams data, send messages, create meetings, and man
Before using the Microsoft Teams integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Microsoft account with Teams access
- Connected your Microsoft account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Microsoft Teams integration, ensure you have:
### 1. Connect Your Microsoft Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Microsoft Teams** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for Teams access
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -57,6 +59,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- No parameters required.
</Accordion>
<Accordion title="microsoft_teams/get_channels">
@@ -64,6 +67,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `team_id` (string, required): The ID of the team.
</Accordion>
<Accordion title="microsoft_teams/send_message">
@@ -74,6 +78,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `channel_id` (string, required): The ID of the channel.
- `message` (string, required): The message content.
- `content_type` (string, optional): Content type (html or text). Enum: `html`, `text`. Default is `text`.
</Accordion>
<Accordion title="microsoft_teams/get_messages">
@@ -83,6 +88,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `team_id` (string, required): The ID of the team.
- `channel_id` (string, required): The ID of the channel.
- `top` (integer, optional): Number of messages to retrieve (max 50). Default is `20`.
</Accordion>
<Accordion title="microsoft_teams/create_meeting">
@@ -92,6 +98,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `subject` (string, required): Meeting subject/title.
- `startDateTime` (string, required): Meeting start time (ISO 8601 format with timezone).
- `endDateTime` (string, required): Meeting end time (ISO 8601 format with timezone).
</Accordion>
<Accordion title="microsoft_teams/search_online_meetings_by_join_url">
@@ -99,6 +106,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `join_web_url` (string, required): The join web URL of the meeting to search for.
</Accordion>
</AccordionGroup>
@@ -194,35 +202,42 @@ crew.kickoff()
### Common Issues
**Authentication Errors**
- Ensure your Microsoft account has the necessary permissions for Teams access.
- Required scopes include: `Team.ReadBasic.All`, `Channel.ReadBasic.All`, `ChannelMessage.Send`, `ChannelMessage.Read.All`, `OnlineMeetings.ReadWrite`, `OnlineMeetings.Read`.
- Verify that the OAuth connection includes all required scopes.
**Team and Channel Access**
- Ensure you are a member of the teams you're trying to access.
- Double-check team IDs and channel IDs for correctness.
- Team and channel IDs can be obtained using the `get_teams` and `get_channels` actions.
**Message Sending Issues**
- Ensure `team_id`, `channel_id`, and `message` are provided for `send_message`.
- Verify that you have permissions to send messages to the specified channel.
- Choose appropriate `content_type` (text or html) based on your message format.
**Meeting Creation**
- Ensure `subject`, `startDateTime`, and `endDateTime` are provided.
- Use proper ISO 8601 format with timezone for datetime fields (e.g., '2024-01-20T10:00:00-08:00').
- Verify that the meeting times are in the future.
**Message Retrieval Limitations**
- The `get_messages` action can retrieve a maximum of 50 messages per request.
- Messages are returned in reverse chronological order (newest first).
**Meeting Search**
- For `search_online_meetings_by_join_url`, ensure the join URL is exact and properly formatted.
- The URL should be the complete Teams meeting join URL.
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Microsoft Teams integration setup or troubleshooting.
Contact our support team for assistance with Microsoft Teams integration setup
or troubleshooting.
</Card>

20
docs/en/enterprise/integrations/microsoft_word.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to create, read, and manage Word documents and text files in
Before using the Microsoft Word integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Microsoft account with Word and OneDrive/SharePoint access
- Connected your Microsoft account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Microsoft Word integration, ensure you have:
### 1. Connect Your Microsoft Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Microsoft Word** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for file access
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -61,6 +63,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `expand` (string, optional): Expand related resources inline.
- `top` (integer, optional): Number of items to return (min 1, max 999).
- `orderby` (string, optional): Order results by specified properties.
</Accordion>
<Accordion title="microsoft_word/create_text_document">
@@ -69,6 +72,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_name` (string, required): Name of the text document (should end with .txt).
- `content` (string, optional): Text content for the document. Default is "This is a new text document created via API."
</Accordion>
<Accordion title="microsoft_word/get_document_content">
@@ -76,6 +80,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the document.
</Accordion>
<Accordion title="microsoft_word/get_document_properties">
@@ -83,6 +88,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the document.
</Accordion>
<Accordion title="microsoft_word/delete_document">
@@ -90,6 +96,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `file_id` (string, required): The ID of the document to delete.
</Accordion>
</AccordionGroup>
@@ -185,24 +192,29 @@ crew.kickoff()
### Common Issues
**Authentication Errors**
- Ensure your Microsoft account has the necessary permissions for file access (e.g., `Files.Read.All`, `Files.ReadWrite.All`).
- Verify that the OAuth connection includes all required scopes.
**File Creation Issues**
- When creating text documents, ensure the `file_name` ends with `.txt` extension.
- Verify that you have write permissions to the target location (OneDrive/SharePoint).
**Document Access Issues**
- Double-check document IDs for correctness when accessing specific documents.
- Ensure the referenced documents exist and are accessible.
- Note that this integration works best with text files (.txt) for content operations.
**Content Retrieval Limitations**
- The `get_document_content` action works best with text files (.txt).
- For complex Word documents (.docx), consider using the document properties action to get metadata.
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Microsoft Word integration setup or troubleshooting.
Contact our support team for assistance with Microsoft Word integration setup
or troubleshooting.
</Card>

19
docs/en/enterprise/integrations/notion.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage users and create comments through Notion. Access wo
Before using the Notion integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Notion account with appropriate workspace permissions
- Connected your Notion account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
@@ -21,7 +21,7 @@ Before using the Notion integration, ensure you have:
### 1. Connect Your Notion Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Notion** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for user access and comment creation
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -58,6 +60,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `page_size` (integer, optional): Number of items returned in the response. Minimum: 1, Maximum: 100, Default: 100
- `start_cursor` (string, optional): Cursor for pagination. Return results after this cursor.
</Accordion>
<Accordion title="notion/get_user">
@@ -65,6 +68,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `user_id` (string, required): The ID of the user to retrieve.
</Accordion>
<Accordion title="notion/create_comment">
@@ -96,6 +100,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
}
]
```
</Accordion>
</AccordionGroup>
@@ -254,26 +259,31 @@ crew.kickoff()
### Common Issues
**Permission Errors**
- Ensure your Notion account has appropriate permissions to read user information
- Verify that the OAuth connection includes required scopes for user access and comment creation
- Check that you have permissions to comment on the target pages or discussions
**User Access Issues**
- Ensure you have workspace admin permissions to list all users
- Verify that user IDs are correct and users exist in the workspace
- Check that the workspace allows API access to user information
**Comment Creation Issues**
- Verify that page IDs or discussion IDs are correct and accessible
- Ensure that rich text content follows Notion's API format specifications
- Check that you have comment permissions on the target pages or discussions
**API Rate Limits**
- Be mindful of Notion's API rate limits when making multiple requests
- Implement appropriate delays between requests if needed
- Consider pagination for large user lists
**Parent Object Specification**
- Ensure parent object type is correctly specified (page_id or discussion_id)
- Verify that the parent page or discussion exists and is accessible
- Check that the parent object ID format is correct
@@ -281,5 +291,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Notion integration setup or troubleshooting.
Contact our support team for assistance with Notion integration setup or
troubleshooting.
</Card>

50
docs/en/enterprise/integrations/salesforce.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage customer relationships, sales processes, and data t
Before using the Salesforce integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Salesforce account with appropriate permissions
- Connected your Salesforce account through the [Integrations page](https://app.crewai.com/integrations)
@@ -21,7 +21,7 @@ Before using the Salesforce integration, ensure you have:
### 1. Connect Your Salesforce Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Salesforce** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for CRM and sales management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -65,6 +67,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Title` (string, optional): Title of the contact, such as CEO or Vice President
- `Description` (string, optional): A description of the Contact
- `additionalFields` (object, optional): Additional fields in JSON format for custom Contact fields
</Accordion>
<Accordion title="salesforce/create_record_lead">
@@ -81,6 +84,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Status` (string, optional): Lead Status - Use Connect Portal Workflow Settings to select Lead Status
- `Description` (string, optional): A description of the Lead
- `additionalFields` (object, optional): Additional fields in JSON format for custom Lead fields
</Accordion>
<Accordion title="salesforce/create_record_opportunity">
@@ -96,6 +100,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `OwnerId` (string, optional): The Salesforce user assigned to work on this Opportunity
- `NextStep` (string, optional): Description of next task in closing Opportunity
- `additionalFields` (object, optional): Additional fields in JSON format for custom Opportunity fields
</Accordion>
<Accordion title="salesforce/create_record_task">
@@ -114,6 +119,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `isReminderSet` (boolean, optional): Whether reminder is set
- `reminderDateTime` (string, optional): Reminder Date/Time in ISO format
- `additionalFields` (object, optional): Additional fields in JSON format for custom Task fields
</Accordion>
<Accordion title="salesforce/create_record_account">
@@ -126,12 +132,14 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Phone` (string, optional): Phone number
- `Description` (string, optional): Account description
- `additionalFields` (object, optional): Additional fields in JSON format for custom Account fields
</Accordion>
<Accordion title="salesforce/create_record_any">
**Description:** Create a record of any object type in Salesforce.
**Note:** This is a flexible tool for creating records of custom or unknown object types.
</Accordion>
</AccordionGroup>
@@ -150,6 +158,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Title` (string, optional): Title of the contact
- `Description` (string, optional): A description of the Contact
- `additionalFields` (object, optional): Additional fields in JSON format for custom Contact fields
</Accordion>
<Accordion title="salesforce/update_record_lead">
@@ -167,6 +176,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Status` (string, optional): Lead Status
- `Description` (string, optional): A description of the Lead
- `additionalFields` (object, optional): Additional fields in JSON format for custom Lead fields
</Accordion>
<Accordion title="salesforce/update_record_opportunity">
@@ -183,6 +193,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `OwnerId` (string, optional): The Salesforce user assigned to work on this Opportunity
- `NextStep` (string, optional): Description of next task in closing Opportunity
- `additionalFields` (object, optional): Additional fields in JSON format for custom Opportunity fields
</Accordion>
<Accordion title="salesforce/update_record_task">
@@ -201,6 +212,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `isReminderSet` (boolean, optional): Whether reminder is set
- `reminderDateTime` (string, optional): Reminder Date/Time in ISO format
- `additionalFields` (object, optional): Additional fields in JSON format for custom Task fields
</Accordion>
<Accordion title="salesforce/update_record_account">
@@ -214,12 +226,14 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Phone` (string, optional): Phone number
- `Description` (string, optional): Account description
- `additionalFields` (object, optional): Additional fields in JSON format for custom Account fields
</Accordion>
<Accordion title="salesforce/update_record_any">
**Description:** Update a record of any object type in Salesforce.
**Note:** This is a flexible tool for updating records of custom or unknown object types.
</Accordion>
</AccordionGroup>
@@ -231,6 +245,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): Record ID of the Contact
</Accordion>
<Accordion title="salesforce/get_record_by_id_lead">
@@ -238,6 +253,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): Record ID of the Lead
</Accordion>
<Accordion title="salesforce/get_record_by_id_opportunity">
@@ -245,6 +261,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): Record ID of the Opportunity
</Accordion>
<Accordion title="salesforce/get_record_by_id_task">
@@ -252,6 +269,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): Record ID of the Task
</Accordion>
<Accordion title="salesforce/get_record_by_id_account">
@@ -259,6 +277,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): Record ID of the Account
</Accordion>
<Accordion title="salesforce/get_record_by_id_any">
@@ -267,6 +286,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordType` (string, required): Record Type (e.g., "CustomObject__c")
- `recordId` (string, required): Record ID
</Accordion>
</AccordionGroup>
@@ -282,6 +302,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sortDirection` (string, optional): Sort direction - Options: ASC, DESC
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/search_records_lead">
@@ -293,6 +314,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sortDirection` (string, optional): Sort direction - Options: ASC, DESC
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/search_records_opportunity">
@@ -304,6 +326,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sortDirection` (string, optional): Sort direction - Options: ASC, DESC
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/search_records_task">
@@ -315,6 +338,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sortDirection` (string, optional): Sort direction - Options: ASC, DESC
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/search_records_account">
@@ -326,6 +350,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sortDirection` (string, optional): Sort direction - Options: ASC, DESC
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/search_records_any">
@@ -336,6 +361,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `filterFormula` (string, optional): Filter search criteria
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
</AccordionGroup>
@@ -348,6 +374,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/get_record_by_view_id_lead">
@@ -356,6 +383,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/get_record_by_view_id_opportunity">
@@ -364,6 +392,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/get_record_by_view_id_task">
@@ -372,6 +401,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/get_record_by_view_id_account">
@@ -380,6 +410,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/get_record_by_view_id_any">
@@ -389,6 +420,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `recordType` (string, required): Record Type
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
</AccordionGroup>
@@ -409,6 +441,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Field description
- `helperText` (string, optional): Helper text shown on hover
- `defaultFieldValue` (string, optional): Default field value
</Accordion>
<Accordion title="salesforce/create_custom_field_lead">
@@ -425,6 +458,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Field description
- `helperText` (string, optional): Helper text shown on hover
- `defaultFieldValue` (string, optional): Default field value
</Accordion>
<Accordion title="salesforce/create_custom_field_opportunity">
@@ -441,6 +475,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Field description
- `helperText` (string, optional): Helper text shown on hover
- `defaultFieldValue` (string, optional): Default field value
</Accordion>
<Accordion title="salesforce/create_custom_field_task">
@@ -457,6 +492,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Field description
- `helperText` (string, optional): Helper text shown on hover
- `defaultFieldValue` (string, optional): Default field value
</Accordion>
<Accordion title="salesforce/create_custom_field_account">
@@ -473,12 +509,14 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Field description
- `helperText` (string, optional): Helper text shown on hover
- `defaultFieldValue` (string, optional): Default field value
</Accordion>
<Accordion title="salesforce/create_custom_field_any">
**Description:** Deploy custom fields for any object type.
**Note:** This is a flexible tool for creating custom fields on custom or unknown object types.
</Accordion>
</AccordionGroup>
@@ -490,6 +528,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `query` (string, required): SOQL Query (e.g., "SELECT Id, Name FROM Account WHERE Name = 'Example'")
</Accordion>
<Accordion title="salesforce/create_custom_object">
@@ -500,6 +539,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `pluralLabel` (string, required): Plural Label (e.g., "Accounts")
- `description` (string, optional): A description of the Custom Object
- `recordName` (string, required): Record Name that appears in layouts and searches (e.g., "Account Name")
</Accordion>
<Accordion title="salesforce/describe_action_schema">
@@ -510,6 +550,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `operation` (string, required): Operation Type (e.g., "CREATE_RECORD" or "UPDATE_RECORD")
**Note:** Use this function first when working with custom objects to understand their schema before performing operations.
</Accordion>
</AccordionGroup>
@@ -639,5 +680,6 @@ This comprehensive documentation covers all the Salesforce tools organized by fu
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Salesforce integration setup or troubleshooting.
Contact our support team for assistance with Salesforce integration setup or
troubleshooting.
</Card>

25
docs/en/enterprise/integrations/shopify.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage e-commerce operations through Shopify. Handle custo
Before using the Shopify integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Shopify store with appropriate admin permissions
- Connected your Shopify store through the [Integrations page](https://app.crewai.com/integrations)
@@ -21,7 +21,7 @@ Before using the Shopify integration, ensure you have:
### 1. Connect Your Shopify Store
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Shopify** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for store and product management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -64,6 +66,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `updatedAtMin` (string, optional): Only return customers updated after this date (ISO or Unix timestamp)
- `updatedAtMax` (string, optional): Only return customers updated before this date (ISO or Unix timestamp)
- `limit` (string, optional): Maximum number of customers to return (defaults to 250)
</Accordion>
<Accordion title="shopify/search_customers">
@@ -72,6 +75,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `filterFormula` (object, optional): Advanced filter in disjunctive normal form with field-specific operators
- `limit` (string, optional): Maximum number of customers to return (defaults to 250)
</Accordion>
<Accordion title="shopify/create_customer">
@@ -93,6 +97,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `note` (string, optional): Customer note
- `sendEmailInvite` (boolean, optional): Whether to send email invitation
- `metafields` (object, optional): Additional metafields in JSON format
</Accordion>
<Accordion title="shopify/update_customer">
@@ -115,6 +120,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `note` (string, optional): Customer note
- `sendEmailInvite` (boolean, optional): Whether to send email invitation
- `metafields` (object, optional): Additional metafields in JSON format
</Accordion>
</AccordionGroup>
@@ -131,6 +137,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `updatedAtMin` (string, optional): Only return orders updated after this date (ISO or Unix timestamp)
- `updatedAtMax` (string, optional): Only return orders updated before this date (ISO or Unix timestamp)
- `limit` (string, optional): Maximum number of orders to return (defaults to 250)
</Accordion>
<Accordion title="shopify/create_order">
@@ -144,6 +151,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `financialStatus` (string, optional): Financial status - Options: pending, authorized, partially_paid, paid, partially_refunded, refunded, voided
- `inventoryBehaviour` (string, optional): Inventory behavior - Options: bypass, decrement_ignoring_policy, decrement_obeying_policy
- `note` (string, optional): Order note
</Accordion>
<Accordion title="shopify/update_order">
@@ -158,6 +166,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `financialStatus` (string, optional): Financial status - Options: pending, authorized, partially_paid, paid, partially_refunded, refunded, voided
- `inventoryBehaviour` (string, optional): Inventory behavior - Options: bypass, decrement_ignoring_policy, decrement_obeying_policy
- `note` (string, optional): Order note
</Accordion>
<Accordion title="shopify/get_abandoned_carts">
@@ -170,6 +179,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `createdAtMin` (string, optional): Only return carts created after this date (ISO or Unix timestamp)
- `createdAtMax` (string, optional): Only return carts created before this date (ISO or Unix timestamp)
- `limit` (string, optional): Maximum number of carts to return (defaults to 250)
</Accordion>
</AccordionGroup>
@@ -190,6 +200,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `updatedAtMin` (string, optional): Only return products updated after this date (ISO or Unix timestamp)
- `updatedAtMax` (string, optional): Only return products updated before this date (ISO or Unix timestamp)
- `limit` (string, optional): Maximum number of products to return (defaults to 250)
</Accordion>
<Accordion title="shopify/create_product">
@@ -206,6 +217,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `imageUrl` (string, optional): Product image URL
- `isPublished` (boolean, optional): Whether product is published
- `publishToPointToSale` (boolean, optional): Whether to publish to point of sale
</Accordion>
<Accordion title="shopify/update_product">
@@ -223,6 +235,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `imageUrl` (string, optional): Product image URL
- `isPublished` (boolean, optional): Whether product is published
- `publishToPointToSale` (boolean, optional): Whether to publish to point of sale
</Accordion>
</AccordionGroup>
@@ -234,6 +247,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `productFilterFormula` (object, optional): Advanced filter in disjunctive normal form with support for fields like id, title, vendor, status, handle, tag, created_at, updated_at, published_at
</Accordion>
<Accordion title="shopify/create_product_graphql">
@@ -247,6 +261,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `tags` (string, optional): Product tags as array or comma-separated list
- `media` (object, optional): Media objects with alt text, content type, and source URL
- `additionalFields` (object, optional): Additional product fields like status, requiresSellingPlan, giftCard
</Accordion>
<Accordion title="shopify/update_product_graphql">
@@ -261,6 +276,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `tags` (string, optional): Product tags as array or comma-separated list
- `media` (object, optional): Updated media objects with alt text, content type, and source URL
- `additionalFields` (object, optional): Additional product fields like status, requiresSellingPlan, giftCard
</Accordion>
</AccordionGroup>
@@ -389,5 +405,6 @@ crew.kickoff()
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Shopify integration setup or troubleshooting.
Contact our support team for assistance with Shopify integration setup or
troubleshooting.
</Card>

20
docs/en/enterprise/integrations/slack.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage team communication through Slack. Send messages, se
Before using the Slack integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Slack workspace with appropriate permissions
- Connected your Slack workspace through the [Integrations page](https://app.crewai.com/integrations)
@@ -21,7 +21,7 @@ Before using the Slack integration, ensure you have:
### 1. Connect Your Slack Workspace
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Slack** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for team communication
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -59,6 +61,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- No parameters required - retrieves all channel members
</Accordion>
<Accordion title="slack/get_user_by_email">
@@ -66,6 +69,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `email` (string, required): The email address of a user in the workspace
</Accordion>
<Accordion title="slack/get_users_by_name">
@@ -76,6 +80,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `displayName` (string, required): User's display name to search for
- `paginationParameters` (object, optional): Pagination settings
- `pageCursor` (string, optional): Page cursor for pagination
</Accordion>
</AccordionGroup>
@@ -87,6 +92,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- No parameters required - retrieves all accessible channels
</Accordion>
</AccordionGroup>
@@ -103,6 +109,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `botIcon` (string, required): Bot icon - Can be either an image URL or an emoji (e.g., ":dog:")
- `blocks` (object, optional): Slack Block Kit JSON for rich message formatting with attachments and interactive elements
- `authenticatedUser` (boolean, optional): If true, message appears to come from your authenticated Slack user instead of the application (defaults to false)
</Accordion>
<Accordion title="slack/send_direct_message">
@@ -115,6 +122,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `botIcon` (string, required): Bot icon - Can be either an image URL or an emoji (e.g., ":dog:")
- `blocks` (object, optional): Slack Block Kit JSON for rich message formatting with attachments and interactive elements
- `authenticatedUser` (boolean, optional): If true, message appears to come from your authenticated Slack user instead of the application (defaults to false)
</Accordion>
</AccordionGroup>
@@ -132,6 +140,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `from:@john in:#general` - Search for messages from John in the #general channel
- `has:link after:2023-01-01` - Search for messages with links after January 1, 2023
- `in:@channel before:yesterday` - Search for messages in a specific channel before yesterday
</Accordion>
</AccordionGroup>
@@ -140,6 +149,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
Slack's Block Kit allows you to create rich, interactive messages. Here are some examples of how to use the `blocks` parameter:
### Simple Text with Attachment
```json
[
{
@@ -154,6 +164,7 @@ Slack's Block Kit allows you to create rich, interactive messages. Here are some
```
### Rich Formatting with Sections
```json
[
{
@@ -311,5 +322,6 @@ crew.kickoff()
## Contact Support
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Slack integration setup or troubleshooting.
Contact our support team for assistance with Slack integration setup or
troubleshooting.
</Card>

19
docs/en/enterprise/integrations/stripe.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage payments, subscriptions, and customer billing throu
Before using the Stripe integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Stripe account with appropriate API permissions
- Connected your Stripe account through the [Integrations page](https://app.crewai.com/integrations)
@@ -21,7 +21,7 @@ Before using the Stripe integration, ensure you have:
### 1. Connect Your Stripe Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Stripe** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for payment processing
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -62,6 +64,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `name` (string, optional): Customer's full name
- `description` (string, optional): Customer description for internal reference
- `metadataCreateCustomer` (object, optional): Additional metadata as key-value pairs (e.g., `{"field1": 1, "field2": 2}`)
</Accordion>
<Accordion title="stripe/get_customer_by_id">
@@ -69,6 +72,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `idGetCustomer` (string, required): The Stripe customer ID to retrieve
</Accordion>
<Accordion title="stripe/get_customers">
@@ -79,6 +83,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `createdAfter` (string, optional): Filter customers created after this date (Unix timestamp)
- `createdBefore` (string, optional): Filter customers created before this date (Unix timestamp)
- `limitGetCustomers` (string, optional): Maximum number of customers to return (defaults to 10)
</Accordion>
<Accordion title="stripe/update_customer">
@@ -90,6 +95,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `name` (string, optional): Updated customer name
- `description` (string, optional): Updated customer description
- `metadataUpdateCustomer` (object, optional): Updated metadata as key-value pairs
</Accordion>
</AccordionGroup>
@@ -103,6 +109,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `customerIdCreateSubscription` (string, required): The customer ID for whom the subscription will be created
- `plan` (string, required): The plan ID for the subscription - Use Connect Portal Workflow Settings to allow users to select a plan
- `metadataCreateSubscription` (object, optional): Additional metadata for the subscription
</Accordion>
<Accordion title="stripe/get_subscriptions">
@@ -112,6 +119,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `customerIdGetSubscriptions` (string, optional): Filter subscriptions by customer ID
- `subscriptionStatus` (string, optional): Filter by subscription status - Options: incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid
- `limitGetSubscriptions` (string, optional): Maximum number of subscriptions to return (defaults to 10)
</Accordion>
</AccordionGroup>
@@ -125,6 +133,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `productName` (string, required): The product name
- `description` (string, optional): Product description
- `metadataProduct` (object, optional): Additional product metadata as key-value pairs
</Accordion>
<Accordion title="stripe/get_product_by_id">
@@ -132,6 +141,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `productId` (string, required): The Stripe product ID to retrieve
</Accordion>
<Accordion title="stripe/get_products">
@@ -141,6 +151,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `createdAfter` (string, optional): Filter products created after this date (Unix timestamp)
- `createdBefore` (string, optional): Filter products created before this date (Unix timestamp)
- `limitGetProducts` (string, optional): Maximum number of products to return (defaults to 10)
</Accordion>
</AccordionGroup>
@@ -154,6 +165,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `balanceTransactionType` (string, optional): Filter by transaction type - Options: charge, refund, payment, payment_refund
- `paginationParameters` (object, optional): Pagination settings
- `pageCursor` (string, optional): Page cursor for pagination
</Accordion>
<Accordion title="stripe/get_plans">
@@ -163,6 +175,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `isPlanActive` (boolean, optional): Filter by plan status - true for active plans, false for inactive plans
- `paginationParameters` (object, optional): Pagination settings
- `pageCursor` (string, optional): Page cursor for pagination
</Accordion>
</AccordionGroup>

19
docs/en/enterprise/integrations/zendesk.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage customer support operations through Zendesk. Create
Before using the Zendesk integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Zendesk account with appropriate API permissions
- Connected your Zendesk account through the [Integrations page](https://app.crewai.com/integrations)
@@ -21,7 +21,7 @@ Before using the Zendesk integration, ensure you have:
### 1. Connect Your Zendesk Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Zendesk** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for ticket and user management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -70,6 +72,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `ticketTags` (string, optional): Array of tags to apply (e.g., `["enterprise", "other_tag"]`)
- `ticketExternalId` (string, optional): External ID to link tickets to local records
- `ticketCustomFields` (object, optional): Custom field values in JSON format
</Accordion>
<Accordion title="zendesk/update_ticket">
@@ -88,6 +91,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `ticketTags` (string, optional): Updated tags array
- `ticketExternalId` (string, optional): Updated external ID
- `ticketCustomFields` (object, optional): Updated custom field values
</Accordion>
<Accordion title="zendesk/get_ticket_by_id">
@@ -95,6 +99,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `ticketId` (string, required): The ticket ID to retrieve (e.g., "35436")
</Accordion>
<Accordion title="zendesk/add_comment_to_ticket">
@@ -105,6 +110,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `commentBody` (string, required): Comment message (accepts plain text or HTML, e.g., "Thanks for your help!")
- `isInternalNote` (boolean, optional): Set to true for internal notes instead of public replies (defaults to false)
- `isPublic` (boolean, optional): True for public comments, false for internal notes
</Accordion>
<Accordion title="zendesk/search_tickets">
@@ -126,6 +132,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `dueDate` (object, optional): Filter by due date with operator and value
- `sort_by` (string, optional): Sort field - Options: created_at, updated_at, priority, status, ticket_type
- `sort_order` (string, optional): Sort direction - Options: asc, desc
</Accordion>
</AccordionGroup>
@@ -143,6 +150,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `externalId` (string, optional): Unique identifier from another system
- `details` (string, optional): Additional user details
- `notes` (string, optional): Internal notes about the user
</Accordion>
<Accordion title="zendesk/update_user">
@@ -157,6 +165,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `externalId` (string, optional): Updated external ID
- `details` (string, optional): Updated user details
- `notes` (string, optional): Updated internal notes
</Accordion>
<Accordion title="zendesk/get_user_by_id">
@@ -164,6 +173,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `userId` (string, required): The user ID to retrieve
</Accordion>
<Accordion title="zendesk/search_users">
@@ -176,6 +186,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `externalId` (string, optional): Filter by external ID
- `sort_by` (string, optional): Sort field - Options: created_at, updated_at
- `sort_order` (string, optional): Sort direction - Options: asc, desc
</Accordion>
</AccordionGroup>
@@ -188,6 +199,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `paginationParameters` (object, optional): Pagination settings
- `pageCursor` (string, optional): Page cursor for pagination
</Accordion>
<Accordion title="zendesk/get_ticket_audits">
@@ -197,6 +209,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `ticketId` (string, optional): Get audits for specific ticket (if empty, retrieves audits for all non-archived tickets, e.g., "1234")
- `paginationParameters` (object, optional): Pagination settings
- `pageCursor` (string, optional): Page cursor for pagination
</Accordion>
</AccordionGroup>

20
docs/en/enterprise/introduction.mdx
View File

@@ -1,5 +1,5 @@
---
title: "CrewAI AOP"
title: "CrewAI AMP"
description: "Deploy, monitor, and scale your AI agent workflows"
icon: "globe"
mode: "wide"
@@ -7,13 +7,16 @@ mode: "wide"
## Introduction
CrewAI AOP(Agent Operations Platform) provides a platform for deploying, monitoring, and scaling your crews and agents in a production environment.
CrewAI AMP(Agent Management Platform) provides a platform for deploying, monitoring, and scaling your crews and agents in a production environment.
<Frame>
<img src="/images/enterprise/crewai-enterprise-dashboard.png" alt="CrewAI AOP Dashboard" />
<img
src="/images/enterprise/crewai-enterprise-dashboard.png"
alt="CrewAI AMP Dashboard"
/>
</Frame>
CrewAI AOP extends the power of the open-source framework with features designed for production deployments, collaboration, and scalability. Deploy your crews to a managed infrastructure and monitor their execution in real-time.
CrewAI AMP extends the power of the open-source framework with features designed for production deployments, collaboration, and scalability. Deploy your crews to a managed infrastructure and monitor their execution in real-time.
## Key Features
@@ -22,7 +25,8 @@ CrewAI AOP extends the power of the open-source framework with features designed
Deploy your crews to a managed infrastructure with a few clicks
</Card>
<Card title="API Access" icon="code">
Access your deployed crews via REST API for integration with existing systems
Access your deployed crews via REST API for integration with existing
systems
</Card>
<Card title="Observability" icon="chart-line">
Monitor your crews with detailed execution traces and logs
@@ -57,11 +61,7 @@ CrewAI AOP extends the power of the open-source framework with features designed
<Steps>
<Step title="Sign up for an account">
Create your account at [app.crewai.com](https://app.crewai.com)
<Card
title="Sign Up"
icon="user"
href="https://app.crewai.com/signup"
>
<Card title="Sign Up" icon="user" href="https://app.crewai.com/signup">
Sign Up
</Card>
</Step>

3
docs/en/enterprise/resources/frequently-asked-questions.mdx
View File

@@ -1,6 +1,6 @@
---
title: FAQs
description: "Frequently asked questions about CrewAI AOP"
description: "Frequently asked questions about CrewAI AMP"
icon: "circle-question"
mode: "wide"
---
@@ -148,4 +148,5 @@ mode: "wide"
<Accordion title="How can you control the maximum number of requests per minute that the entire crew can perform?">
The `max_rpm` attribute sets the maximum number of requests per minute the crew can perform to avoid rate limits and will override individual agents' `max_rpm` settings if you set it.
</Accordion>
</AccordionGroup>