docs: Docs updates (#3459)

* docs(cli): document device-code login and config reset guidance; renumber sections

* docs(cli): fix duplicate numbering (renumber Login/API Keys/Configuration sections)

* docs: Fix webhook documentation to include meta dict in all webhook payloads

- Add note explaining that meta objects from kickoff requests are included in all webhook payloads
- Update webhook examples to show proper payload structure including meta field
- Fix webhook examples to match actual API implementation
- Apply changes to English, Korean, and Portuguese documentation

Resolves the documentation gap where meta dict passing to webhooks was not documented despite being implemented in the API.

* WIP: CrewAI docs theme, changelog, GEO, localization

* docs(cli): fix merge markers; ensure mode: "wide"; convert ASCII tables to Markdown (en/pt-BR/ko)

* docs: add group icons across locales; split Automation/Integrations; update tools overviews and links
This commit is contained in:
Tony Kipkemboi
2025-09-05 17:40:11 -04:00
committed by GitHub
parent 99b79ab20d
commit 1a1bb0ca3d
557 changed files with 6448 additions and 86 deletions

View File

@@ -1,6 +1,6 @@
{ {
"$schema": "https://mintlify.com/docs.json", "$schema": "https://mintlify.com/docs.json",
"theme": "mint", "theme": "aspen",
"name": "CrewAI", "name": "CrewAI",
"colors": { "colors": {
"primary": "#EB6658", "primary": "#EB6658",
@@ -28,20 +28,21 @@
"icon": "discourse" "icon": "discourse"
}, },
{ {
"anchor": "Crew GPT", "anchor": "Blog",
"href": "https://chatgpt.com/g/g-qqTuUWsBY-crewai-assistant", "href": "https://blog.crewai.com",
"icon": "robot" "icon": "newspaper"
}, },
{ {
"anchor": "Releases", "anchor": "CrewGPT",
"href": "https://github.com/crewAIInc/crewAI/releases", "href": "https://chatgpt.com/g/g-qqTuUWsBY-crewai-assistant",
"icon": "tag" "icon": "robot"
} }
] ]
}, },
"tabs": [ "tabs": [
{ {
"tab": "Documentation", "tab": "Documentation",
"icon": "book-open",
"groups": [ "groups": [
{ {
"group": "Get Started", "group": "Get Started",
@@ -52,18 +53,22 @@
"pages": [ "pages": [
{ {
"group": "Strategy", "group": "Strategy",
"icon": "compass",
"pages": ["en/guides/concepts/evaluating-use-cases"] "pages": ["en/guides/concepts/evaluating-use-cases"]
}, },
{ {
"group": "Agents", "group": "Agents",
"icon": "user",
"pages": ["en/guides/agents/crafting-effective-agents"] "pages": ["en/guides/agents/crafting-effective-agents"]
}, },
{ {
"group": "Crews", "group": "Crews",
"icon": "users",
"pages": ["en/guides/crews/first-crew"] "pages": ["en/guides/crews/first-crew"]
}, },
{ {
"group": "Flows", "group": "Flows",
"icon": "code-branch",
"pages": [ "pages": [
"en/guides/flows/first-flow", "en/guides/flows/first-flow",
"en/guides/flows/mastering-flow-state" "en/guides/flows/mastering-flow-state"
@@ -71,6 +76,7 @@
}, },
{ {
"group": "Advanced", "group": "Advanced",
"icon": "gear",
"pages": [ "pages": [
"en/guides/advanced/customizing-prompts", "en/guides/advanced/customizing-prompts",
"en/guides/advanced/fingerprinting" "en/guides/advanced/fingerprinting"
@@ -116,6 +122,7 @@
"en/tools/overview", "en/tools/overview",
{ {
"group": "File & Document", "group": "File & Document",
"icon": "folder-open",
"pages": [ "pages": [
"en/tools/file-document/overview", "en/tools/file-document/overview",
"en/tools/file-document/filereadtool", "en/tools/file-document/filereadtool",
@@ -135,6 +142,7 @@
}, },
{ {
"group": "Web Scraping & Browsing", "group": "Web Scraping & Browsing",
"icon": "globe",
"pages": [ "pages": [
"en/tools/web-scraping/overview", "en/tools/web-scraping/overview",
"en/tools/web-scraping/scrapewebsitetool", "en/tools/web-scraping/scrapewebsitetool",
@@ -154,6 +162,7 @@
}, },
{ {
"group": "Search & Research", "group": "Search & Research",
"icon": "magnifying-glass",
"pages": [ "pages": [
"en/tools/search-research/overview", "en/tools/search-research/overview",
"en/tools/search-research/serperdevtool", "en/tools/search-research/serperdevtool",
@@ -175,6 +184,7 @@
}, },
{ {
"group": "Database & Data", "group": "Database & Data",
"icon": "database",
"pages": [ "pages": [
"en/tools/database-data/overview", "en/tools/database-data/overview",
"en/tools/database-data/mysqltool", "en/tools/database-data/mysqltool",
@@ -189,6 +199,7 @@
}, },
{ {
"group": "AI & Machine Learning", "group": "AI & Machine Learning",
"icon": "brain",
"pages": [ "pages": [
"en/tools/ai-ml/overview", "en/tools/ai-ml/overview",
"en/tools/ai-ml/dalletool", "en/tools/ai-ml/dalletool",
@@ -202,16 +213,26 @@
}, },
{ {
"group": "Cloud & Storage", "group": "Cloud & Storage",
"icon": "cloud",
"pages": [ "pages": [
"en/tools/cloud-storage/overview", "en/tools/cloud-storage/overview",
"en/tools/cloud-storage/s3readertool", "en/tools/cloud-storage/s3readertool",
"en/tools/cloud-storage/s3writertool", "en/tools/cloud-storage/s3writertool",
"en/tools/cloud-storage/bedrockinvokeagenttool",
"en/tools/cloud-storage/bedrockkbretriever" "en/tools/cloud-storage/bedrockkbretriever"
] ]
}, },
{ {
"group": "Automation & Integration", "group": "Integrations",
"icon": "plug",
"pages": [
"en/tools/tool-integrations/overview",
"en/tools/tool-integrations/bedrockinvokeagenttool",
"en/tools/tool-integrations/crewaiautomationtool"
]
},
{
"group": "Automation",
"icon": "bolt",
"pages": [ "pages": [
"en/tools/automation/overview", "en/tools/automation/overview",
"en/tools/automation/apifyactorstool", "en/tools/automation/apifyactorstool",
@@ -273,6 +294,7 @@
}, },
{ {
"tab": "Enterprise", "tab": "Enterprise",
"icon": "briefcase",
"groups": [ "groups": [
{ {
"group": "Getting Started", "group": "Getting Started",
@@ -339,6 +361,7 @@
}, },
{ {
"tab": "API Reference", "tab": "API Reference",
"icon": "magnifying-glass",
"groups": [ "groups": [
{ {
"group": "Getting Started", "group": "Getting Started",
@@ -353,12 +376,23 @@
}, },
{ {
"tab": "Examples", "tab": "Examples",
"icon": "code",
"groups": [ "groups": [
{ {
"group": "Examples", "group": "Examples",
"pages": ["en/examples/example", "en/examples/cookbooks"] "pages": ["en/examples/example", "en/examples/cookbooks"]
} }
] ]
},
{
"tab": "Changelog",
"icon": "clock",
"groups": [
{
"group": "Release Notes",
"pages": ["en/changelog"]
}
]
} }
] ]
}, },
@@ -377,20 +411,21 @@
"icon": "discourse" "icon": "discourse"
}, },
{ {
"anchor": "Crew GPT", "anchor": "Blog",
"href": "https://chatgpt.com/g/g-qqTuUWsBY-crewai-assistant", "href": "https://blog.crewai.com",
"icon": "robot" "icon": "newspaper"
}, },
{ {
"anchor": "Lançamentos", "anchor": "CrewGPT",
"href": "https://github.com/crewAIInc/crewAI/releases", "href": "https://chatgpt.com/g/g-qqTuUWsBY-crewai-assistant",
"icon": "tag" "icon": "robot"
} }
] ]
}, },
"tabs": [ "tabs": [
{ {
"tab": "Documentação", "tab": "Documentação",
"icon": "book-open",
"groups": [ "groups": [
{ {
"group": "Começando", "group": "Começando",
@@ -405,18 +440,22 @@
"pages": [ "pages": [
{ {
"group": "Estratégia", "group": "Estratégia",
"icon": "compass",
"pages": ["pt-BR/guides/concepts/evaluating-use-cases"] "pages": ["pt-BR/guides/concepts/evaluating-use-cases"]
}, },
{ {
"group": "Agentes", "group": "Agentes",
"icon": "user",
"pages": ["pt-BR/guides/agents/crafting-effective-agents"] "pages": ["pt-BR/guides/agents/crafting-effective-agents"]
}, },
{ {
"group": "Crews", "group": "Crews",
"icon": "users",
"pages": ["pt-BR/guides/crews/first-crew"] "pages": ["pt-BR/guides/crews/first-crew"]
}, },
{ {
"group": "Flows", "group": "Flows",
"icon": "code-branch",
"pages": [ "pages": [
"pt-BR/guides/flows/first-flow", "pt-BR/guides/flows/first-flow",
"pt-BR/guides/flows/mastering-flow-state" "pt-BR/guides/flows/mastering-flow-state"
@@ -424,6 +463,7 @@
}, },
{ {
"group": "Avançado", "group": "Avançado",
"icon": "gear",
"pages": [ "pages": [
"pt-BR/guides/advanced/customizing-prompts", "pt-BR/guides/advanced/customizing-prompts",
"pt-BR/guides/advanced/fingerprinting" "pt-BR/guides/advanced/fingerprinting"
@@ -469,6 +509,7 @@
"pt-BR/tools/overview", "pt-BR/tools/overview",
{ {
"group": "Arquivo & Documento", "group": "Arquivo & Documento",
"icon": "folder-open",
"pages": [ "pages": [
"pt-BR/tools/file-document/overview", "pt-BR/tools/file-document/overview",
"pt-BR/tools/file-document/filereadtool", "pt-BR/tools/file-document/filereadtool",
@@ -486,6 +527,7 @@
}, },
{ {
"group": "Web Scraping & Navegação", "group": "Web Scraping & Navegação",
"icon": "globe",
"pages": [ "pages": [
"pt-BR/tools/web-scraping/overview", "pt-BR/tools/web-scraping/overview",
"pt-BR/tools/web-scraping/scrapewebsitetool", "pt-BR/tools/web-scraping/scrapewebsitetool",
@@ -504,6 +546,7 @@
}, },
{ {
"group": "Pesquisa", "group": "Pesquisa",
"icon": "magnifying-glass",
"pages": [ "pages": [
"pt-BR/tools/search-research/overview", "pt-BR/tools/search-research/overview",
"pt-BR/tools/search-research/serperdevtool", "pt-BR/tools/search-research/serperdevtool",
@@ -519,6 +562,7 @@
}, },
{ {
"group": "Dados", "group": "Dados",
"icon": "database",
"pages": [ "pages": [
"pt-BR/tools/database-data/overview", "pt-BR/tools/database-data/overview",
"pt-BR/tools/database-data/mysqltool", "pt-BR/tools/database-data/mysqltool",
@@ -531,6 +575,7 @@
}, },
{ {
"group": "IA & Machine Learning", "group": "IA & Machine Learning",
"icon": "brain",
"pages": [ "pages": [
"pt-BR/tools/ai-ml/overview", "pt-BR/tools/ai-ml/overview",
"pt-BR/tools/ai-ml/dalletool", "pt-BR/tools/ai-ml/dalletool",
@@ -544,16 +589,26 @@
}, },
{ {
"group": "Cloud & Armazenamento", "group": "Cloud & Armazenamento",
"icon": "cloud",
"pages": [ "pages": [
"pt-BR/tools/cloud-storage/overview", "pt-BR/tools/cloud-storage/overview",
"pt-BR/tools/cloud-storage/s3readertool", "pt-BR/tools/cloud-storage/s3readertool",
"pt-BR/tools/cloud-storage/s3writertool", "pt-BR/tools/cloud-storage/s3writertool",
"pt-BR/tools/cloud-storage/bedrockinvokeagenttool",
"pt-BR/tools/cloud-storage/bedrockkbretriever" "pt-BR/tools/cloud-storage/bedrockkbretriever"
] ]
}, },
{ {
"group": "Automação & Integração", "group": "Integrações",
"icon": "plug",
"pages": [
"pt-BR/tools/tool-integrations/overview",
"pt-BR/tools/tool-integrations/bedrockinvokeagenttool",
"pt-BR/tools/tool-integrations/crewaiautomationtool"
]
},
{
"group": "Automação",
"icon": "bolt",
"pages": [ "pages": [
"pt-BR/tools/automation/overview", "pt-BR/tools/automation/overview",
"pt-BR/tools/automation/apifyactorstool", "pt-BR/tools/automation/apifyactorstool",
@@ -613,6 +668,7 @@
}, },
{ {
"tab": "Enterprise", "tab": "Enterprise",
"icon": "briefcase",
"groups": [ "groups": [
{ {
"group": "Começando", "group": "Começando",
@@ -680,6 +736,7 @@
}, },
{ {
"tab": "Referência da API", "tab": "Referência da API",
"icon": "magnifying-glass",
"groups": [ "groups": [
{ {
"group": "Começando", "group": "Começando",
@@ -694,12 +751,23 @@
}, },
{ {
"tab": "Exemplos", "tab": "Exemplos",
"icon": "code",
"groups": [ "groups": [
{ {
"group": "Exemplos", "group": "Exemplos",
"pages": ["pt-BR/examples/example", "pt-BR/examples/cookbooks"] "pages": ["pt-BR/examples/example", "pt-BR/examples/cookbooks"]
} }
] ]
},
{
"tab": "Notas de Versão",
"icon": "clock",
"groups": [
{
"group": "Notas de Versão",
"pages": ["pt-BR/changelog"]
}
]
} }
] ]
}, },
@@ -718,20 +786,21 @@
"icon": "discourse" "icon": "discourse"
}, },
{ {
"anchor": "Crew GPT", "anchor": "블로그",
"href": "https://chatgpt.com/g/g-qqTuUWsBY-crewai-assistant", "href": "https://blog.crewai.com",
"icon": "robot" "icon": "newspaper"
}, },
{ {
"anchor": "릴리스", "anchor": "CrewGPT",
"href": "https://github.com/crewAIInc/crewAI/releases", "href": "https://chatgpt.com/g/g-qqTuUWsBY-crewai-assistant",
"icon": "tag" "icon": "robot"
} }
] ]
}, },
"tabs": [ "tabs": [
{ {
"tab": "기술 문서", "tab": "기술 문서",
"icon": "book-open",
"groups": [ "groups": [
{ {
"group": "시작 안내", "group": "시작 안내",
@@ -742,18 +811,22 @@
"pages": [ "pages": [
{ {
"group": "전략", "group": "전략",
"icon": "compass",
"pages": ["ko/guides/concepts/evaluating-use-cases"] "pages": ["ko/guides/concepts/evaluating-use-cases"]
}, },
{ {
"group": "에이전트 (Agents)", "group": "에이전트 (Agents)",
"icon": "user",
"pages": ["ko/guides/agents/crafting-effective-agents"] "pages": ["ko/guides/agents/crafting-effective-agents"]
}, },
{ {
"group": "크루 (Crews)", "group": "크루 (Crews)",
"icon": "users",
"pages": ["ko/guides/crews/first-crew"] "pages": ["ko/guides/crews/first-crew"]
}, },
{ {
"group": "플로우 (Flows)", "group": "플로우 (Flows)",
"icon": "code-branch",
"pages": [ "pages": [
"ko/guides/flows/first-flow", "ko/guides/flows/first-flow",
"ko/guides/flows/mastering-flow-state" "ko/guides/flows/mastering-flow-state"
@@ -761,6 +834,7 @@
}, },
{ {
"group": "고급", "group": "고급",
"icon": "gear",
"pages": [ "pages": [
"ko/guides/advanced/customizing-prompts", "ko/guides/advanced/customizing-prompts",
"ko/guides/advanced/fingerprinting" "ko/guides/advanced/fingerprinting"
@@ -806,6 +880,7 @@
"ko/tools/overview", "ko/tools/overview",
{ {
"group": "파일 & 문서", "group": "파일 & 문서",
"icon": "folder-open",
"pages": [ "pages": [
"ko/tools/file-document/overview", "ko/tools/file-document/overview",
"ko/tools/file-document/filereadtool", "ko/tools/file-document/filereadtool",
@@ -825,6 +900,7 @@
}, },
{ {
"group": "웹 스크래핑 & 브라우징", "group": "웹 스크래핑 & 브라우징",
"icon": "globe",
"pages": [ "pages": [
"ko/tools/web-scraping/overview", "ko/tools/web-scraping/overview",
"ko/tools/web-scraping/scrapewebsitetool", "ko/tools/web-scraping/scrapewebsitetool",
@@ -844,6 +920,7 @@
}, },
{ {
"group": "검색 및 연구", "group": "검색 및 연구",
"icon": "magnifying-glass",
"pages": [ "pages": [
"ko/tools/search-research/overview", "ko/tools/search-research/overview",
"ko/tools/search-research/serperdevtool", "ko/tools/search-research/serperdevtool",
@@ -865,6 +942,7 @@
}, },
{ {
"group": "데이터베이스 & 데이터", "group": "데이터베이스 & 데이터",
"icon": "database",
"pages": [ "pages": [
"ko/tools/database-data/overview", "ko/tools/database-data/overview",
"ko/tools/database-data/mysqltool", "ko/tools/database-data/mysqltool",
@@ -879,6 +957,7 @@
}, },
{ {
"group": "인공지능 & 머신러닝", "group": "인공지능 & 머신러닝",
"icon": "brain",
"pages": [ "pages": [
"ko/tools/ai-ml/overview", "ko/tools/ai-ml/overview",
"ko/tools/ai-ml/dalletool", "ko/tools/ai-ml/dalletool",
@@ -892,6 +971,7 @@
}, },
{ {
"group": "클라우드 & 스토리지", "group": "클라우드 & 스토리지",
"icon": "cloud",
"pages": [ "pages": [
"ko/tools/cloud-storage/overview", "ko/tools/cloud-storage/overview",
"ko/tools/cloud-storage/s3readertool", "ko/tools/cloud-storage/s3readertool",
@@ -901,7 +981,17 @@
] ]
}, },
{ {
"group": "자동화 & 통합", "group": "통합",
"icon": "plug",
"pages": [
"ko/tools/tool-integrations/overview",
"ko/tools/tool-integrations/bedrockinvokeagenttool",
"ko/tools/tool-integrations/crewaiautomationtool"
]
},
{
"group": "자동화",
"icon": "bolt",
"pages": [ "pages": [
"ko/tools/automation/overview", "ko/tools/automation/overview",
"ko/tools/automation/apifyactorstool", "ko/tools/automation/apifyactorstool",
@@ -962,6 +1052,7 @@
}, },
{ {
"tab": "엔터프라이즈", "tab": "엔터프라이즈",
"icon": "briefcase",
"groups": [ "groups": [
{ {
"group": "시작 안내", "group": "시작 안내",
@@ -1028,6 +1119,7 @@
}, },
{ {
"tab": "API 레퍼런스", "tab": "API 레퍼런스",
"icon": "magnifying-glass",
"groups": [ "groups": [
{ {
"group": "시작 안내", "group": "시작 안내",
@@ -1042,12 +1134,23 @@
}, },
{ {
"tab": "예시", "tab": "예시",
"icon": "code",
"groups": [ "groups": [
{ {
"group": "예시", "group": "예시",
"pages": ["ko/examples/example", "ko/examples/cookbooks"] "pages": ["ko/examples/example", "ko/examples/cookbooks"]
} }
] ]
},
{
"tab": "변경 로그",
"icon": "clock",
"groups": [
{
"group": "릴리스 노트",
"pages": ["ko/changelog"]
}
]
} }
] ]
} }
@@ -1057,15 +1160,23 @@
"light": "/images/crew_only_logo.png", "light": "/images/crew_only_logo.png",
"dark": "/images/crew_only_logo.png" "dark": "/images/crew_only_logo.png"
}, },
"fonts": {
"family": "Inter"
},
"appearance": { "appearance": {
"default": "dark", "default": "system",
"strict": false "strict": false,
"layout": "sidenav"
},
"background": {
"decoration": "grid"
}, },
"navbar": { "navbar": {
"links": [ "links": [
{ {
"label": "Start Cloud Trial", "label": "Start Cloud Trial",
"href": "https://app.crewai.com" "href": "https://app.crewai.com",
"icon": "arrow-up-right-from-square"
} }
], ],
"primary": { "primary": {
@@ -1084,7 +1195,20 @@
} }
}, },
"seo": { "seo": {
"indexing": "all" "indexing": "all",
"metatags": {
"og:type": "website",
"og:site_name": "CrewAI Documentation",
"og:image": "https://docs.crewai.com/images/crew_only_logo.png",
"twitter:card": "summary_large_image",
"twitter:site": "@crewAIInc",
"keywords": "AI agents, multi-agent systems, CrewAI, artificial intelligence, automation, Python framework, agent collaboration, AI workflows"
}
},
"feedback": {
"enabled": true,
"thumbsRating": true,
"suggestEdit": true
}, },
"redirects": [ "redirects": [
{ {
@@ -1105,7 +1229,7 @@
}, },
{ {
"source": "/changelog", "source": "/changelog",
"destination": "https://github.com/crewAIInc/crewAI/releases" "destination": "/en/changelog"
}, },
{ {
"source": "/telemetry", "source": "/telemetry",

View File

@@ -2,6 +2,7 @@
title: "GET /inputs" title: "GET /inputs"
description: "Get required inputs for your crew" description: "Get required inputs for your crew"
openapi: "/enterprise-api.en.yaml GET /inputs" openapi: "/enterprise-api.en.yaml GET /inputs"
mode: "wide"
--- ---

View File

@@ -2,6 +2,7 @@
title: "Introduction" title: "Introduction"
description: "Complete reference for the CrewAI Enterprise REST API" description: "Complete reference for the CrewAI Enterprise REST API"
icon: "code" icon: "code"
mode: "wide"
--- ---
# CrewAI Enterprise API # CrewAI Enterprise API

View File

@@ -2,6 +2,7 @@
title: "POST /kickoff" title: "POST /kickoff"
description: "Start a crew execution" description: "Start a crew execution"
openapi: "/enterprise-api.en.yaml POST /kickoff" openapi: "/enterprise-api.en.yaml POST /kickoff"
mode: "wide"
--- ---

View File

@@ -2,6 +2,7 @@
title: "GET /status/{kickoff_id}" title: "GET /status/{kickoff_id}"
description: "Get execution status" description: "Get execution status"
openapi: "/enterprise-api.en.yaml GET /status/{kickoff_id}" openapi: "/enterprise-api.en.yaml GET /status/{kickoff_id}"
mode: "wide"
--- ---

1763
docs/en/changelog.mdx Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -2,6 +2,7 @@
title: Agents title: Agents
description: Detailed guide on creating and managing agents within the CrewAI framework. description: Detailed guide on creating and managing agents within the CrewAI framework.
icon: robot icon: robot
mode: "wide"
--- ---
## Overview of an Agent ## Overview of an Agent

View File

@@ -2,6 +2,7 @@
title: CLI title: CLI
description: Learn how to use the CrewAI CLI to interact with CrewAI. description: Learn how to use the CrewAI CLI to interact with CrewAI.
icon: terminal icon: terminal
mode: "wide"
--- ---
<Warning>Since release 0.140.0, CrewAI Enterprise started a process of migrating their login provider. As such, the authentication flow via CLI was updated. Users that use Google to login, or that created their account after July 3rd, 2025 will be unable to log in with older versions of the `crewai` library.</Warning> <Warning>Since release 0.140.0, CrewAI Enterprise started a process of migrating their login provider. As such, the authentication flow via CLI was updated. Users that use Google to login, or that created their account after July 3rd, 2025 will be unable to log in with older versions of the `crewai` library.</Warning>
@@ -282,7 +283,7 @@ Watch this video tutorial for a step-by-step demonstration of deploying your cre
allowfullscreen allowfullscreen
></iframe> ></iframe>
### 12. Login ### 11. Login
Authenticate with CrewAI Enterprise using a secure device code flow (no email entry required). Authenticate with CrewAI Enterprise using a secure device code flow (no email entry required).
@@ -300,7 +301,7 @@ Notes:
- After successful login, the CLI also attempts to authenticate to the Tool Repository automatically - After successful login, the CLI also attempts to authenticate to the Tool Repository automatically
- If you reset your configuration, run `crewai login` again to re-authenticate - If you reset your configuration, run `crewai login` again to re-authenticate
### 13. API Keys ### 12. API Keys
When running ```crewai create crew``` command, the CLI will show you a list of available LLM providers to choose from, followed by model selection for your chosen provider. When running ```crewai create crew``` command, the CLI will show you a list of available LLM providers to choose from, followed by model selection for your chosen provider.
@@ -328,7 +329,7 @@ See the following link for each provider's key name:
* [LiteLLM Providers](https://docs.litellm.ai/docs/providers) * [LiteLLM Providers](https://docs.litellm.ai/docs/providers)
### 14. Configuration Management ### 13. Configuration Management
Manage CLI configuration settings for CrewAI. Manage CLI configuration settings for CrewAI.
@@ -369,19 +370,15 @@ crewai config list
``` ```
Example output: Example output:
``` | Setting | Value | Description |
CrewAI CLI Configuration | :------------------ | :----------------------- | :---------------------------------------------------------- |
┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ | enterprise_base_url | https://app.crewai.com | Base URL of the CrewAI Enterprise instance |
┃ Setting ┃ Value ┃ Description ┃ | org_name | Not set | Name of the currently active organization |
┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ | org_uuid | Not set | UUID of the currently active organization |
│ enterprise_base_url│ https://app.crewai.com │ Base URL of the CrewAI Enterprise instance | oauth2_provider | workos | OAuth2 provider (e.g., workos, okta, auth0) |
org_name │ Not set │ Name of the currently active organization │ | oauth2_audience | client_01YYY | Audience identifying the target API/resource |
org_uuid │ Not set │ UUID of the currently active organization | oauth2_client_id | client_01XXX | OAuth2 client ID issued by the provider |
oauth2_provider │ workos │ OAuth2 provider used for authentication (e.g., workos, okta, auth0). | oauth2_domain | login.crewai.com | Provider domain (e.g., your-org.auth0.com) |
│ oauth2_audience │ client_01YYY │ OAuth2 audience value, typically used to identify the target API or resource. │
│ oauth2_client_id │ client_01XXX │ OAuth2 client ID issued by the provider, used during authentication requests. │
│ oauth2_domain │ login.crewai.com │ OAuth2 provider's domain (e.g., your-org.auth0.com) used for issuing tokens. │
```
Set the enterprise base URL: Set the enterprise base URL:
```shell Terminal ```shell Terminal

View File

@@ -2,6 +2,7 @@
title: Collaboration title: Collaboration
description: How to enable agents to work together, delegate tasks, and communicate effectively within CrewAI teams. description: How to enable agents to work together, delegate tasks, and communicate effectively within CrewAI teams.
icon: screen-users icon: screen-users
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Crews title: Crews
description: Understanding and utilizing crews in the crewAI framework with comprehensive attributes and functionalities. description: Understanding and utilizing crews in the crewAI framework with comprehensive attributes and functionalities.
icon: people-group icon: people-group
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: 'Event Listeners' title: 'Event Listeners'
description: 'Tap into CrewAI events to build custom integrations and monitoring' description: 'Tap into CrewAI events to build custom integrations and monitoring'
icon: spinner icon: spinner
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Flows title: Flows
description: Learn how to create and manage AI workflows using CrewAI Flows. description: Learn how to create and manage AI workflows using CrewAI Flows.
icon: arrow-progress icon: arrow-progress
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Knowledge title: Knowledge
description: What is knowledge in CrewAI and how to use it. description: What is knowledge in CrewAI and how to use it.
icon: book icon: book
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: 'LLMs' title: 'LLMs'
description: 'A comprehensive guide to configuring and using Large Language Models (LLMs) in your CrewAI projects' description: 'A comprehensive guide to configuring and using Large Language Models (LLMs) in your CrewAI projects'
icon: 'microchip-ai' icon: 'microchip-ai'
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Memory title: Memory
description: Leveraging memory systems in the CrewAI framework to enhance agent capabilities. description: Leveraging memory systems in the CrewAI framework to enhance agent capabilities.
icon: database icon: database
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Planning title: Planning
description: Learn how to add planning to your CrewAI Crew and improve their performance. description: Learn how to add planning to your CrewAI Crew and improve their performance.
icon: ruler-combined icon: ruler-combined
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Processes title: Processes
description: Detailed guide on workflow management through processes in CrewAI, with updated implementation details. description: Detailed guide on workflow management through processes in CrewAI, with updated implementation details.
icon: bars-staggered icon: bars-staggered
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Reasoning title: Reasoning
description: "Learn how to enable and use agent reasoning to improve task execution." description: "Learn how to enable and use agent reasoning to improve task execution."
icon: brain icon: brain
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Tasks title: Tasks
description: Detailed guide on managing and creating tasks within the CrewAI framework. description: Detailed guide on managing and creating tasks within the CrewAI framework.
icon: list-check icon: list-check
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Testing title: Testing
description: Learn how to test your CrewAI Crew and evaluate their performance. description: Learn how to test your CrewAI Crew and evaluate their performance.
icon: vial icon: vial
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Tools title: Tools
description: Understanding and leveraging tools within the CrewAI framework for agent collaboration and task execution. description: Understanding and leveraging tools within the CrewAI framework for agent collaboration and task execution.
icon: screwdriver-wrench icon: screwdriver-wrench
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Training title: Training
description: Learn how to train your CrewAI agents by giving them feedback early on and get consistent results. description: Learn how to train your CrewAI agents by giving them feedback early on and get consistent results.
icon: dumbbell icon: dumbbell
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: 'Agent Repositories' title: 'Agent Repositories'
description: 'Learn how to use Agent Repositories to share and reuse your agents across teams and projects' description: 'Learn how to use Agent Repositories to share and reuse your agents across teams and projects'
icon: 'database' icon: 'database'
mode: "wide"
--- ---
Agent Repositories allow enterprise users to store, share, and reuse agent definitions across teams and projects. This feature enables organizations to maintain a centralized library of standardized agents, promoting consistency and reducing duplication of effort. Agent Repositories allow enterprise users to store, share, and reuse agent definitions across teams and projects. This feature enables organizations to maintain a centralized library of standardized agents, promoting consistency and reducing duplication of effort.

View File

@@ -2,6 +2,7 @@
title: Hallucination Guardrail title: Hallucination Guardrail
description: "Prevent and detect AI hallucinations in your CrewAI tasks" description: "Prevent and detect AI hallucinations in your CrewAI tasks"
icon: "shield-check" icon: "shield-check"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Integrations title: Integrations
description: "Connected applications for your agents to take actions." description: "Connected applications for your agents to take actions."
icon: "plug" icon: "plug"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: "Role-Based Access Control (RBAC)" title: "Role-Based Access Control (RBAC)"
description: "Control access to crews, tools, and data with roles, scopes, and granular permissions." description: "Control access to crews, tools, and data with roles, scopes, and granular permissions."
icon: "shield" icon: "shield"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Tool Repository title: Tool Repository
description: "Using the Tool Repository to manage your tools" description: "Using the Tool Repository to manage your tools"
icon: "toolbox" icon: "toolbox"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Traces title: Traces
description: "Using Traces to monitor your Crews" description: "Using Traces to monitor your Crews"
icon: "timeline" icon: "timeline"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Webhook Streaming title: Webhook Streaming
description: "Using Webhook Streaming to stream events to your webhook" description: "Using Webhook Streaming to stream events to your webhook"
icon: "webhook" icon: "webhook"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: "Automation Triggers" title: "Automation Triggers"
description: "Automatically execute your CrewAI workflows when specific events occur in connected integrations" description: "Automatically execute your CrewAI workflows when specific events occur in connected integrations"
icon: "bolt" icon: "bolt"
mode: "wide"
--- ---
Automation triggers enable you to automatically run your CrewAI deployments when specific events occur in your connected integrations, creating powerful event-driven workflows that respond to real-time changes in your business systems. Automation triggers enable you to automatically run your CrewAI deployments when specific events occur in your connected integrations, creating powerful event-driven workflows that respond to real-time changes in your business systems.

View File

@@ -2,6 +2,7 @@
title: "Azure OpenAI Setup" title: "Azure OpenAI Setup"
description: "Configure Azure OpenAI with Crew Studio for enterprise LLM connections" description: "Configure Azure OpenAI with Crew Studio for enterprise LLM connections"
icon: "microsoft" icon: "microsoft"
mode: "wide"
--- ---
This guide walks you through connecting Azure OpenAI with Crew Studio for seamless enterprise AI operations. This guide walks you through connecting Azure OpenAI with Crew Studio for seamless enterprise AI operations.

View File

@@ -2,6 +2,7 @@
title: "Build Crew" title: "Build Crew"
description: "A Crew is a group of agents that work together to complete a task." description: "A Crew is a group of agents that work together to complete a task."
icon: "people-arrows" icon: "people-arrows"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: "Deploy Crew" title: "Deploy Crew"
description: "Deploying a Crew on CrewAI Enterprise" description: "Deploying a Crew on CrewAI Enterprise"
icon: "rocket" icon: "rocket"
mode: "wide"
--- ---
<Note> <Note>

View File

@@ -2,6 +2,7 @@
title: "Enable Crew Studio" title: "Enable Crew Studio"
description: "Enabling Crew Studio on CrewAI Enterprise" description: "Enabling Crew Studio on CrewAI Enterprise"
icon: "comments" icon: "comments"
mode: "wide"
--- ---
<Tip> <Tip>

View File

@@ -2,6 +2,7 @@
title: "HubSpot Trigger" title: "HubSpot Trigger"
description: "Trigger CrewAI crews directly from HubSpot Workflows" description: "Trigger CrewAI crews directly from HubSpot Workflows"
icon: "hubspot" icon: "hubspot"
mode: "wide"
--- ---
This guide provides a step-by-step process to set up HubSpot triggers for CrewAI Enterprise, enabling you to initiate crews directly from HubSpot Workflows. This guide provides a step-by-step process to set up HubSpot triggers for CrewAI Enterprise, enabling you to initiate crews directly from HubSpot Workflows.

View File

@@ -2,6 +2,7 @@
title: "HITL Workflows" title: "HITL Workflows"
description: "Learn how to implement Human-In-The-Loop workflows in CrewAI for enhanced decision-making" description: "Learn how to implement Human-In-The-Loop workflows in CrewAI for enhanced decision-making"
icon: "user-check" icon: "user-check"
mode: "wide"
--- ---
Human-In-The-Loop (HITL) is a powerful approach that combines artificial intelligence with human expertise to enhance decision-making and improve task outcomes. This guide shows you how to implement HITL within CrewAI. Human-In-The-Loop (HITL) is a powerful approach that combines artificial intelligence with human expertise to enhance decision-making and improve task outcomes. This guide shows you how to implement HITL within CrewAI.

View File

@@ -2,6 +2,7 @@
title: "Kickoff Crew" title: "Kickoff Crew"
description: "Kickoff a Crew on CrewAI Enterprise" description: "Kickoff a Crew on CrewAI Enterprise"
icon: "flag-checkered" icon: "flag-checkered"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: "React Component Export" title: "React Component Export"
description: "Learn how to export and integrate CrewAI Enterprise React components into your applications" description: "Learn how to export and integrate CrewAI Enterprise React components into your applications"
icon: "react" icon: "react"
mode: "wide"
--- ---
This guide explains how to export CrewAI Enterprise crews as React components and integrate them into your own applications. This guide explains how to export CrewAI Enterprise crews as React components and integrate them into your own applications.

View File

@@ -2,6 +2,7 @@
title: "Salesforce Trigger" title: "Salesforce Trigger"
description: "Trigger CrewAI crews from Salesforce workflows for CRM automation" description: "Trigger CrewAI crews from Salesforce workflows for CRM automation"
icon: "salesforce" icon: "salesforce"
mode: "wide"
--- ---
CrewAI Enterprise can be triggered from Salesforce to automate customer relationship management workflows and enhance your sales operations. CrewAI Enterprise can be triggered from Salesforce to automate customer relationship management workflows and enhance your sales operations.

View File

@@ -2,6 +2,7 @@
title: "Slack Trigger" title: "Slack Trigger"
description: "Trigger CrewAI crews directly from Slack using slash commands" description: "Trigger CrewAI crews directly from Slack using slash commands"
icon: "slack" icon: "slack"
mode: "wide"
--- ---
This guide explains how to start a crew directly from Slack using CrewAI triggers. This guide explains how to start a crew directly from Slack using CrewAI triggers.

View File

@@ -2,6 +2,7 @@
title: "Team Management" title: "Team Management"
description: "Learn how to invite and manage team members in your CrewAI Enterprise organization" description: "Learn how to invite and manage team members in your CrewAI Enterprise organization"
icon: "users" icon: "users"
mode: "wide"
--- ---
As an administrator of a CrewAI Enterprise 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 Enterprise account, you can easily invite new team members to join your organization. This guide will walk you through the process step-by-step.

View File

@@ -2,6 +2,7 @@
title: "Update Crew" title: "Update Crew"
description: "Updating a Crew on CrewAI Enterprise" description: "Updating a Crew on CrewAI Enterprise"
icon: "pencil" icon: "pencil"
mode: "wide"
--- ---
<Note> <Note>

View File

@@ -2,6 +2,7 @@
title: "Webhook Automation" title: "Webhook Automation"
description: "Automate CrewAI Enterprise workflows using webhooks with platforms like ActivePieces, Zapier, and Make.com" description: "Automate CrewAI Enterprise workflows using webhooks with platforms like ActivePieces, Zapier, and Make.com"
icon: "webhook" icon: "webhook"
mode: "wide"
--- ---
CrewAI Enterprise 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 Enterprise 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.
@@ -79,14 +80,24 @@ CrewAI Enterprise allows you to automate your workflow using webhooks. This arti
## Webhook Output Examples ## Webhook Output Examples
**Note:** Any `meta` object provided in your kickoff request will be included in all webhook payloads, allowing you to track requests and maintain context across the entire crew execution lifecycle.
<Tabs> <Tabs>
<Tab title="Step Webhook"> <Tab title="Step Webhook">
`stepWebhookUrl` - Callback that will be executed upon each agent inner thought `stepWebhookUrl` - Callback that will be executed upon each agent inner thought
```json ```json
{ {
"action": "**Preliminary Research Report on the Financial Industry for crewai Enterprise Solution**\n1. Industry Overview and Trends\nThe financial industry in ....\nConclusion:\nThe financial industry presents a fertile ground for implementing AI solutions like crewai, particularly in areas such as digital customer engagement, risk management, and regulatory compliance. Further engagement with the lead is recommended to better tailor the crewai solution to their specific needs and scale.", "prompt": "Research the financial industry for potential AI solutions",
"task_id": "97eba64f-958c-40a0-b61c-625fe635a3c0" "thought": "I need to conduct preliminary research on the financial industry",
"tool": "research_tool",
"tool_input": "financial industry AI solutions",
"result": "**Preliminary Research Report on the Financial Industry for crewai Enterprise Solution**\n1. Industry Overview and Trends\nThe financial industry in ....\nConclusion:\nThe financial industry presents a fertile ground for implementing AI solutions like crewai, particularly in areas such as digital customer engagement, risk management, and regulatory compliance. Further engagement with the lead is recommended to better tailor the crewai solution to their specific needs and scale.",
"kickoff_id": "97eba64f-958c-40a0-b61c-625fe635a3c0",
"meta": {
"requestId": "travel-req-123",
"source": "web-app"
}
} }
``` ```
</Tab> </Tab>
@@ -95,8 +106,21 @@ CrewAI Enterprise allows you to automate your workflow using webhooks. This arti
```json ```json
{ {
"description": "Using the information gathered from the lead's data, conduct preliminary research on the lead's industry, company background, and potential use cases for crewai. Focus on finding relevant data that can aid in scoring the lead and planning a strategy to pitch them crewai.The financial industry presents a fertile ground for implementing AI solutions like crewai, particularly in areas such as digital customer engagement, risk management, and regulatory compliance. Further engagement with the lead is recommended to better tailor the crewai solution to their specific needs and scale.", "description": "Using the information gathered from the lead's data, conduct preliminary research on the lead's industry, company background, and potential use cases for crewai. Focus on finding relevant data that can aid in scoring the lead and planning a strategy to pitch them crewai.",
"task_id": "97eba64f-958c-40a0-b61c-625fe635a3c0" "name": "Industry Research Task",
"expected_output": "Detailed research report on the financial industry",
"summary": "The financial industry presents a fertile ground for implementing AI solutions like crewai, particularly in areas such as digital customer engagement, risk management, and regulatory compliance. Further engagement with the lead is recommended to better tailor the crewai solution to their specific needs and scale.",
"agent": "Research Agent",
"output": "**Preliminary Research Report on the Financial Industry for crewai Enterprise Solution**\n1. Industry Overview and Trends\nThe financial industry in ....\nConclusion:\nThe financial industry presents a fertile ground for implementing AI solutions like crewai, particularly in areas such as digital customer engagement, risk management, and regulatory compliance.",
"output_json": {
"industry": "financial",
"key_opportunities": ["digital customer engagement", "risk management", "regulatory compliance"]
},
"kickoff_id": "97eba64f-958c-40a0-b61c-625fe635a3c0",
"meta": {
"requestId": "travel-req-123",
"source": "web-app"
}
} }
``` ```
</Tab> </Tab>
@@ -105,8 +129,9 @@ CrewAI Enterprise allows you to automate your workflow using webhooks. This arti
```json ```json
{ {
"task_id": "97eba64f-958c-40a0-b61c-625fe635a3c0", "kickoff_id": "97eba64f-958c-40a0-b61c-625fe635a3c0",
"result": { "result": "**Final Analysis Report**\n\nLead Score: Customer service enhancement and compliance are particularly relevant.\n\nTalking Points:\n- Highlight how crewai's AI solutions can transform customer service\n- Discuss crewai's potential for sustainability goals\n- Emphasize compliance capabilities\n- Stress adaptability for various operation scales",
"result_json": {
"lead_score": "Customer service enhancement, and compliance are particularly relevant.", "lead_score": "Customer service enhancement, and compliance are particularly relevant.",
"talking_points": [ "talking_points": [
"Highlight how crewai's AI solutions can transform customer service with automated, personalized experiences and 24/7 support, improving both customer satisfaction and operational efficiency.", "Highlight how crewai's AI solutions can transform customer service with automated, personalized experiences and 24/7 support, improving both customer satisfaction and operational efficiency.",
@@ -114,6 +139,15 @@ CrewAI Enterprise allows you to automate your workflow using webhooks. This arti
"Emphasize crewai's ability to enhance compliance with evolving regulations through efficient data processing and reporting, reducing the risk of non-compliance penalties.", "Emphasize crewai's ability to enhance compliance with evolving regulations through efficient data processing and reporting, reducing the risk of non-compliance penalties.",
"Stress the adaptability of crewai to support both extensive multinational operations and smaller, targeted projects, ensuring the solution grows with the institution's needs." "Stress the adaptability of crewai to support both extensive multinational operations and smaller, targeted projects, ensuring the solution grows with the institution's needs."
] ]
},
"token_usage": {
"total_tokens": 1250,
"prompt_tokens": 800,
"completion_tokens": 450
},
"meta": {
"requestId": "travel-req-123",
"source": "web-app"
} }
} }
``` ```

View File

@@ -2,6 +2,7 @@
title: "Zapier Trigger" title: "Zapier Trigger"
description: "Trigger CrewAI crews from Zapier workflows to automate cross-app workflows" description: "Trigger CrewAI crews from Zapier workflows to automate cross-app workflows"
icon: "bolt" icon: "bolt"
mode: "wide"
--- ---
This guide will walk you through the process of setting up Zapier triggers for CrewAI Enterprise, allowing you to automate workflows between CrewAI Enterprise and other applications. This guide will walk you through the process of setting up Zapier triggers for CrewAI Enterprise, allowing you to automate workflows between CrewAI Enterprise and other applications.

View File

@@ -2,6 +2,7 @@
title: Asana Integration title: Asana Integration
description: "Team task and project coordination with Asana integration for CrewAI." description: "Team task and project coordination with Asana integration for CrewAI."
icon: "circle" icon: "circle"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Box Integration title: Box Integration
description: "File storage and document management with Box integration for CrewAI." description: "File storage and document management with Box integration for CrewAI."
icon: "box" icon: "box"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: ClickUp Integration title: ClickUp Integration
description: "Task and productivity management with ClickUp integration for CrewAI." description: "Task and productivity management with ClickUp integration for CrewAI."
icon: "list-check" icon: "list-check"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: GitHub Integration title: GitHub Integration
description: "Repository and issue management with GitHub integration for CrewAI." description: "Repository and issue management with GitHub integration for CrewAI."
icon: "github" icon: "github"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Gmail Integration title: Gmail Integration
description: "Email and contact management with Gmail integration for CrewAI." description: "Email and contact management with Gmail integration for CrewAI."
icon: "envelope" icon: "envelope"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Google Calendar Integration title: Google Calendar Integration
description: "Event and schedule management with Google Calendar integration for CrewAI." description: "Event and schedule management with Google Calendar integration for CrewAI."
icon: "calendar" icon: "calendar"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Google Sheets Integration title: Google Sheets Integration
description: "Spreadsheet data synchronization with Google Sheets integration for CrewAI." description: "Spreadsheet data synchronization with Google Sheets integration for CrewAI."
icon: "google" icon: "google"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: "HubSpot Integration" title: "HubSpot Integration"
description: "Manage companies and contacts in HubSpot with CrewAI." description: "Manage companies and contacts in HubSpot with CrewAI."
icon: "briefcase" icon: "briefcase"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Jira Integration title: Jira Integration
description: "Issue tracking and project management with Jira integration for CrewAI." description: "Issue tracking and project management with Jira integration for CrewAI."
icon: "bug" icon: "bug"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Linear Integration title: Linear Integration
description: "Software project and bug tracking with Linear integration for CrewAI." description: "Software project and bug tracking with Linear integration for CrewAI."
icon: "list-check" icon: "list-check"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Notion Integration title: Notion Integration
description: "Page and database management with Notion integration for CrewAI." description: "Page and database management with Notion integration for CrewAI."
icon: "book" icon: "book"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Salesforce Integration title: Salesforce Integration
description: "CRM and sales automation with Salesforce integration for CrewAI." description: "CRM and sales automation with Salesforce integration for CrewAI."
icon: "salesforce" icon: "salesforce"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Shopify Integration title: Shopify Integration
description: "E-commerce and online store management with Shopify integration for CrewAI." description: "E-commerce and online store management with Shopify integration for CrewAI."
icon: "shopify" icon: "shopify"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Slack Integration title: Slack Integration
description: "Team communication and collaboration with Slack integration for CrewAI." description: "Team communication and collaboration with Slack integration for CrewAI."
icon: "slack" icon: "slack"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Stripe Integration title: Stripe Integration
description: "Payment processing and subscription management with Stripe integration for CrewAI." description: "Payment processing and subscription management with Stripe integration for CrewAI."
icon: "stripe" icon: "stripe"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Zendesk Integration title: Zendesk Integration
description: "Customer support and helpdesk management with Zendesk integration for CrewAI." description: "Customer support and helpdesk management with Zendesk integration for CrewAI."
icon: "headset" icon: "headset"
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: "CrewAI Enterprise" title: "CrewAI Enterprise"
description: "Deploy, monitor, and scale your AI agent workflows" description: "Deploy, monitor, and scale your AI agent workflows"
icon: "globe" icon: "globe"
mode: "wide"
--- ---
## Introduction ## Introduction

View File

@@ -2,6 +2,7 @@
title: FAQs title: FAQs
description: "Frequently asked questions about CrewAI Enterprise" description: "Frequently asked questions about CrewAI Enterprise"
icon: "circle-question" icon: "circle-question"
mode: "wide"
--- ---
<AccordionGroup> <AccordionGroup>

View File

@@ -2,6 +2,7 @@
title: CrewAI Cookbooks title: CrewAI Cookbooks
description: Feature-focused quickstarts and notebooks for learning patterns fast. description: Feature-focused quickstarts and notebooks for learning patterns fast.
icon: book icon: book
mode: "wide"
--- ---
## Quickstarts & Demos ## Quickstarts & Demos

View File

@@ -2,6 +2,7 @@
title: CrewAI Examples title: CrewAI Examples
description: Explore curated examples organized by Crews, Flows, Integrations, and Notebooks. description: Explore curated examples organized by Crews, Flows, Integrations, and Notebooks.
icon: rocket-launch icon: rocket-launch
mode: "wide"
--- ---
## Crews ## Crews

View File

@@ -2,6 +2,7 @@
title: Customizing Prompts title: Customizing Prompts
description: Dive deeper into low-level prompt customization for CrewAI, enabling super custom and complex use cases for different models and languages. description: Dive deeper into low-level prompt customization for CrewAI, enabling super custom and complex use cases for different models and languages.
icon: message-pen icon: message-pen
mode: "wide"
--- ---
## Why Customize Prompts? ## Why Customize Prompts?

View File

@@ -2,6 +2,7 @@
title: Fingerprinting title: Fingerprinting
description: Learn how to use CrewAI's fingerprinting system to uniquely identify and track components throughout their lifecycle. description: Learn how to use CrewAI's fingerprinting system to uniquely identify and track components throughout their lifecycle.
icon: fingerprint icon: fingerprint
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Crafting Effective Agents title: Crafting Effective Agents
description: Learn best practices for designing powerful, specialized AI agents that collaborate effectively to solve complex problems. description: Learn best practices for designing powerful, specialized AI agents that collaborate effectively to solve complex problems.
icon: robot icon: robot
mode: "wide"
--- ---
## The Art and Science of Agent Design ## The Art and Science of Agent Design

View File

@@ -2,6 +2,7 @@
title: Evaluating Use Cases for CrewAI title: Evaluating Use Cases for CrewAI
description: Learn how to assess your AI application needs and choose the right approach between Crews and Flows based on complexity and precision requirements. description: Learn how to assess your AI application needs and choose the right approach between Crews and Flows based on complexity and precision requirements.
icon: scale-balanced icon: scale-balanced
mode: "wide"
--- ---
## Understanding the Decision Framework ## Understanding the Decision Framework

View File

@@ -2,6 +2,7 @@
title: Build Your First Crew title: Build Your First Crew
description: Step-by-step tutorial to create a collaborative AI team that works together to solve complex problems. description: Step-by-step tutorial to create a collaborative AI team that works together to solve complex problems.
icon: users-gear icon: users-gear
mode: "wide"
--- ---
## Unleashing the Power of Collaborative AI ## Unleashing the Power of Collaborative AI

View File

@@ -2,6 +2,7 @@
title: Build Your First Flow title: Build Your First Flow
description: Learn how to create structured, event-driven workflows with precise control over execution. description: Learn how to create structured, event-driven workflows with precise control over execution.
icon: diagram-project icon: diagram-project
mode: "wide"
--- ---
## Taking Control of AI Workflows with Flows ## Taking Control of AI Workflows with Flows

View File

@@ -2,6 +2,7 @@
title: Mastering Flow State Management title: Mastering Flow State Management
description: A comprehensive guide to managing, persisting, and leveraging state in CrewAI Flows for building robust AI applications. description: A comprehensive guide to managing, persisting, and leveraging state in CrewAI Flows for building robust AI applications.
icon: diagram-project icon: diagram-project
mode: "wide"
--- ---
## Understanding the Power of State in Flows ## Understanding the Power of State in Flows

View File

@@ -2,6 +2,7 @@
title: Installation title: Installation
description: Get started with CrewAI - Install, configure, and build your first AI crew description: Get started with CrewAI - Install, configure, and build your first AI crew
icon: wrench icon: wrench
mode: "wide"
--- ---
## Video Tutorial ## Video Tutorial

View File

@@ -2,6 +2,7 @@
title: Introduction title: Introduction
description: Build AI agent teams that work together to tackle complex tasks description: Build AI agent teams that work together to tackle complex tasks
icon: handshake icon: handshake
mode: "wide"
--- ---
# What is CrewAI? # What is CrewAI?

View File

@@ -1,6 +1,7 @@
--- ---
title: Before and After Kickoff Hooks title: Before and After Kickoff Hooks
description: Learn how to use before and after kickoff hooks in CrewAI description: Learn how to use before and after kickoff hooks in CrewAI
mode: "wide"
--- ---
CrewAI provides hooks that allow you to execute code before and after a crew's kickoff. These hooks are useful for preprocessing inputs or post-processing results. CrewAI provides hooks that allow you to execute code before and after a crew's kickoff. These hooks are useful for preprocessing inputs or post-processing results.

View File

@@ -2,6 +2,7 @@
title: Bring your own agent title: Bring your own agent
description: Learn how to bring your own agents that work within a Crew. description: Learn how to bring your own agents that work within a Crew.
icon: robots icon: robots
mode: "wide"
--- ---
Interoperability is a core concept in CrewAI. This guide will show you how to bring your own agents that work within a Crew. Interoperability is a core concept in CrewAI. This guide will show you how to bring your own agents that work within a Crew.

View File

@@ -2,6 +2,7 @@
title: Coding Agents title: Coding Agents
description: Learn how to enable your CrewAI Agents to write and execute code, and explore advanced features for enhanced functionality. description: Learn how to enable your CrewAI Agents to write and execute code, and explore advanced features for enhanced functionality.
icon: rectangle-code icon: rectangle-code
mode: "wide"
--- ---
## Introduction ## Introduction

View File

@@ -2,6 +2,7 @@
title: Conditional Tasks title: Conditional Tasks
description: Learn how to use conditional tasks in a crewAI kickoff description: Learn how to use conditional tasks in a crewAI kickoff
icon: diagram-subtask icon: diagram-subtask
mode: "wide"
--- ---
## Introduction ## Introduction

View File

@@ -2,6 +2,7 @@
title: Create Custom Tools title: Create Custom Tools
description: Comprehensive guide on crafting, using, and managing custom tools within the CrewAI framework, including new functionalities and error handling. description: Comprehensive guide on crafting, using, and managing custom tools within the CrewAI framework, including new functionalities and error handling.
icon: hammer icon: hammer
mode: "wide"
--- ---
## Creating and Utilizing Tools in CrewAI ## Creating and Utilizing Tools in CrewAI

View File

@@ -2,6 +2,7 @@
title: Custom LLM Implementation title: Custom LLM Implementation
description: Learn how to create custom LLM implementations in CrewAI. description: Learn how to create custom LLM implementations in CrewAI.
icon: code icon: code
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Custom Manager Agent title: Custom Manager Agent
description: Learn how to set a custom agent as the manager in CrewAI, providing more control over task management and coordination. description: Learn how to set a custom agent as the manager in CrewAI, providing more control over task management and coordination.
icon: user-shield icon: user-shield
mode: "wide"
--- ---
# Setting a Specific Agent as Manager in CrewAI # Setting a Specific Agent as Manager in CrewAI

View File

@@ -2,6 +2,7 @@
title: Customize Agents title: Customize Agents
description: A comprehensive guide to tailoring agents for specific roles, tasks, and advanced customizations within the CrewAI framework. description: A comprehensive guide to tailoring agents for specific roles, tasks, and advanced customizations within the CrewAI framework.
icon: user-pen icon: user-pen
mode: "wide"
--- ---
## Customizable Attributes ## Customizable Attributes

View File

@@ -2,6 +2,7 @@
title: "Image Generation with DALL-E" title: "Image Generation with DALL-E"
description: "Learn how to use DALL-E for AI-powered image generation in your CrewAI projects" description: "Learn how to use DALL-E for AI-powered image generation in your CrewAI projects"
icon: "image" icon: "image"
mode: "wide"
--- ---
CrewAI supports integration with OpenAI's DALL-E, allowing your AI agents to generate images as part of their tasks. This guide will walk you through how to set up and use the DALL-E tool in your CrewAI projects. CrewAI supports integration with OpenAI's DALL-E, allowing your AI agents to generate images as part of their tasks. This guide will walk you through how to set up and use the DALL-E tool in your CrewAI projects.

View File

@@ -2,6 +2,7 @@
title: Force Tool Output as Result title: Force Tool Output as Result
description: Learn how to force tool output as the result in an Agent's task in CrewAI. description: Learn how to force tool output as the result in an Agent's task in CrewAI.
icon: wrench-simple icon: wrench-simple
mode: "wide"
--- ---
## Introduction ## Introduction

View File

@@ -2,6 +2,7 @@
title: Hierarchical Process title: Hierarchical Process
description: A comprehensive guide to understanding and applying the hierarchical process within your CrewAI projects, updated to reflect the latest coding practices and functionalities. description: A comprehensive guide to understanding and applying the hierarchical process within your CrewAI projects, updated to reflect the latest coding practices and functionalities.
icon: sitemap icon: sitemap
mode: "wide"
--- ---
## Introduction ## Introduction

View File

@@ -2,6 +2,7 @@
title: "Human-in-the-Loop (HITL) Workflows" title: "Human-in-the-Loop (HITL) Workflows"
description: "Learn how to implement Human-in-the-Loop workflows in CrewAI for enhanced decision-making" description: "Learn how to implement Human-in-the-Loop workflows in CrewAI for enhanced decision-making"
icon: "user-check" icon: "user-check"
mode: "wide"
--- ---
Human-in-the-Loop (HITL) is a powerful approach that combines artificial intelligence with human expertise to enhance decision-making and improve task outcomes. This guide shows you how to implement HITL within CrewAI. Human-in-the-Loop (HITL) is a powerful approach that combines artificial intelligence with human expertise to enhance decision-making and improve task outcomes. This guide shows you how to implement HITL within CrewAI.

View File

@@ -2,6 +2,7 @@
title: Human Input on Execution title: Human Input on Execution
description: Integrating CrewAI with human input during execution in complex decision-making processes and leveraging the full capabilities of the agent's attributes and tools. description: Integrating CrewAI with human input during execution in complex decision-making processes and leveraging the full capabilities of the agent's attributes and tools.
icon: user-check icon: user-check
mode: "wide"
--- ---
## Human input in agent execution ## Human input in agent execution

View File

@@ -2,6 +2,7 @@
title: Kickoff Crew Asynchronously title: Kickoff Crew Asynchronously
description: Kickoff a Crew Asynchronously description: Kickoff a Crew Asynchronously
icon: rocket-launch icon: rocket-launch
mode: "wide"
--- ---
## Introduction ## Introduction

View File

@@ -2,6 +2,7 @@
title: Kickoff Crew for Each title: Kickoff Crew for Each
description: Kickoff Crew for Each Item in a List description: Kickoff Crew for Each Item in a List
icon: at icon: at
mode: "wide"
--- ---
## Introduction ## Introduction

View File

@@ -2,6 +2,7 @@
title: Connect to any LLM title: Connect to any LLM
description: Comprehensive guide on integrating CrewAI with various Large Language Models (LLMs) using LiteLLM, including supported providers and configuration options. description: Comprehensive guide on integrating CrewAI with various Large Language Models (LLMs) using LiteLLM, including supported providers and configuration options.
icon: brain-circuit icon: brain-circuit
mode: "wide"
--- ---
## Connect CrewAI to LLMs ## Connect CrewAI to LLMs

View File

@@ -2,6 +2,7 @@
title: 'Strategic LLM Selection Guide' title: 'Strategic LLM Selection Guide'
description: 'Strategic framework for choosing the right LLM for your CrewAI AI agents and writing effective task and agent definitions' description: 'Strategic framework for choosing the right LLM for your CrewAI AI agents and writing effective task and agent definitions'
icon: 'brain-circuit' icon: 'brain-circuit'
mode: "wide"
--- ---
## The CrewAI Approach to LLM Selection ## The CrewAI Approach to LLM Selection

View File

@@ -2,6 +2,7 @@
title: Using Multimodal Agents title: Using Multimodal Agents
description: Learn how to enable and use multimodal capabilities in your agents for processing images and other non-text content within the CrewAI framework. description: Learn how to enable and use multimodal capabilities in your agents for processing images and other non-text content within the CrewAI framework.
icon: video icon: video
mode: "wide"
--- ---
## Using Multimodal Agents ## Using Multimodal Agents

View File

@@ -2,6 +2,7 @@
title: "Overview" title: "Overview"
description: "Learn how to build, customize, and optimize your CrewAI applications with comprehensive guides and tutorials" description: "Learn how to build, customize, and optimize your CrewAI applications with comprehensive guides and tutorials"
icon: "face-smile" icon: "face-smile"
mode: "wide"
--- ---
## Learn CrewAI ## Learn CrewAI

View File

@@ -2,6 +2,7 @@
title: Replay Tasks from Latest Crew Kickoff title: Replay Tasks from Latest Crew Kickoff
description: Replay tasks from the latest crew.kickoff(...) description: Replay tasks from the latest crew.kickoff(...)
icon: arrow-right icon: arrow-right
mode: "wide"
--- ---
## Introduction ## Introduction

View File

@@ -2,6 +2,7 @@
title: Sequential Processes title: Sequential Processes
description: A comprehensive guide to utilizing the sequential processes for task execution in CrewAI projects. description: A comprehensive guide to utilizing the sequential processes for task execution in CrewAI projects.
icon: forward icon: forward
mode: "wide"
--- ---
## Introduction ## Introduction

View File

@@ -2,6 +2,7 @@
title: "Using Annotations in crew.py" title: "Using Annotations in crew.py"
description: "Learn how to use annotations to properly structure agents, tasks, and components in CrewAI" description: "Learn how to use annotations to properly structure agents, tasks, and components in CrewAI"
icon: "at" icon: "at"
mode: "wide"
--- ---
This guide explains how to use annotations to properly reference **agents**, **tasks**, and other components in the `crew.py` file. This guide explains how to use annotations to properly reference **agents**, **tasks**, and other components in the `crew.py` file.

View File

@@ -2,6 +2,7 @@
title: Connecting to Multiple MCP Servers title: Connecting to Multiple MCP Servers
description: Learn how to use MCPServerAdapter in CrewAI to connect to multiple MCP servers simultaneously and aggregate their tools. description: Learn how to use MCPServerAdapter in CrewAI to connect to multiple MCP servers simultaneously and aggregate their tools.
icon: layer-group icon: layer-group
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: 'MCP Servers as Tools in CrewAI' title: 'MCP Servers as Tools in CrewAI'
description: 'Learn how to integrate MCP servers as tools in your CrewAI agents using the `crewai-tools` library.' description: 'Learn how to integrate MCP servers as tools in your CrewAI agents using the `crewai-tools` library.'
icon: plug icon: plug
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: MCP Security Considerations title: MCP Security Considerations
description: Learn about important security best practices when integrating MCP servers with your CrewAI agents. description: Learn about important security best practices when integrating MCP servers with your CrewAI agents.
icon: lock icon: lock
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: SSE Transport title: SSE Transport
description: Learn how to connect CrewAI to remote MCP servers using Server-Sent Events (SSE) for real-time communication. description: Learn how to connect CrewAI to remote MCP servers using Server-Sent Events (SSE) for real-time communication.
icon: wifi icon: wifi
mode: "wide"
--- ---
## Overview ## Overview

View File

@@ -2,6 +2,7 @@
title: Stdio Transport title: Stdio Transport
description: Learn how to connect CrewAI to local MCP servers using the Stdio (Standard Input/Output) transport mechanism. description: Learn how to connect CrewAI to local MCP servers using the Stdio (Standard Input/Output) transport mechanism.
icon: server icon: server
mode: "wide"
--- ---
## Overview ## Overview

Some files were not shown because too many files have changed in this diff Show More