mirror of
https://github.com/crewAIInc/crewAI.git
synced 2025-12-16 04:18:35 +00:00
c96d4a6823
* Add Oxylabs tools * Review updates * Review updates --------- Co-authored-by: Tony Kipkemboi <iamtonykipkemboi@gmail.com>
432 lines
13 KiB
JSON
432 lines
13 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"theme": "mint",
|
|
"name": "CrewAI",
|
|
"colors": {
|
|
"primary": "#EB6658",
|
|
"light": "#F3A78B",
|
|
"dark": "#C94C3C"
|
|
},
|
|
"favicon": "images/favicon.svg",
|
|
"contextual": {
|
|
"options": [
|
|
"copy",
|
|
"view",
|
|
"chatgpt",
|
|
"claude"
|
|
]
|
|
},
|
|
"navigation": {
|
|
"tabs": [
|
|
{
|
|
"tab": "Documentation",
|
|
"groups": [
|
|
{
|
|
"group": "Get Started",
|
|
"pages": [
|
|
"introduction",
|
|
"installation",
|
|
"quickstart"
|
|
]
|
|
},
|
|
{
|
|
"group": "Guides",
|
|
"pages": [
|
|
{
|
|
"group": "Strategy",
|
|
"pages": [
|
|
"guides/concepts/evaluating-use-cases"
|
|
]
|
|
},
|
|
{
|
|
"group": "Agents",
|
|
"pages": [
|
|
"guides/agents/crafting-effective-agents"
|
|
]
|
|
},
|
|
{
|
|
"group": "Crews",
|
|
"pages": [
|
|
"guides/crews/first-crew"
|
|
]
|
|
},
|
|
{
|
|
"group": "Flows",
|
|
"pages": [
|
|
"guides/flows/first-flow",
|
|
"guides/flows/mastering-flow-state"
|
|
]
|
|
},
|
|
{
|
|
"group": "Advanced",
|
|
"pages": [
|
|
"guides/advanced/customizing-prompts",
|
|
"guides/advanced/fingerprinting"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Core Concepts",
|
|
"pages": [
|
|
"concepts/agents",
|
|
"concepts/tasks",
|
|
"concepts/crews",
|
|
"concepts/flows",
|
|
"concepts/knowledge",
|
|
"concepts/llms",
|
|
"concepts/processes",
|
|
"concepts/collaboration",
|
|
"concepts/training",
|
|
"concepts/memory",
|
|
"concepts/reasoning",
|
|
"concepts/planning",
|
|
"concepts/testing",
|
|
"concepts/cli",
|
|
"concepts/tools",
|
|
"concepts/event-listener"
|
|
]
|
|
},
|
|
{
|
|
"group": "MCP Integration",
|
|
"pages": [
|
|
"mcp/overview",
|
|
"mcp/stdio",
|
|
"mcp/sse",
|
|
"mcp/streamable-http",
|
|
"mcp/multiple-servers",
|
|
"mcp/security"
|
|
]
|
|
},
|
|
{
|
|
"group": "Tools",
|
|
"pages": [
|
|
"tools/overview",
|
|
{
|
|
"group": "File & Document",
|
|
"pages": [
|
|
"tools/file-document/overview",
|
|
"tools/file-document/filereadtool",
|
|
"tools/file-document/filewritetool",
|
|
"tools/file-document/pdfsearchtool",
|
|
"tools/file-document/docxsearchtool",
|
|
"tools/file-document/mdxsearchtool",
|
|
"tools/file-document/xmlsearchtool",
|
|
"tools/file-document/txtsearchtool",
|
|
"tools/file-document/jsonsearchtool",
|
|
"tools/file-document/csvsearchtool",
|
|
"tools/file-document/directorysearchtool",
|
|
"tools/file-document/directoryreadtool"
|
|
]
|
|
},
|
|
{
|
|
"group": "Web Scraping & Browsing",
|
|
"pages": [
|
|
"tools/web-scraping/overview",
|
|
"tools/web-scraping/scrapewebsitetool",
|
|
"tools/web-scraping/scrapeelementfromwebsitetool",
|
|
"tools/web-scraping/scrapflyscrapetool",
|
|
"tools/web-scraping/seleniumscrapingtool",
|
|
"tools/web-scraping/scrapegraphscrapetool",
|
|
"tools/web-scraping/spidertool",
|
|
"tools/web-scraping/browserbaseloadtool",
|
|
"tools/web-scraping/hyperbrowserloadtool",
|
|
"tools/web-scraping/stagehandtool",
|
|
"tools/web-scraping/firecrawlcrawlwebsitetool",
|
|
"tools/web-scraping/firecrawlscrapewebsitetool",
|
|
"tools/web-scraping/oxylabsscraperstool"
|
|
]
|
|
},
|
|
{
|
|
"group": "Search & Research",
|
|
"pages": [
|
|
"tools/search-research/overview",
|
|
"tools/search-research/serperdevtool",
|
|
"tools/search-research/bravesearchtool",
|
|
"tools/search-research/exasearchtool",
|
|
"tools/search-research/linkupsearchtool",
|
|
"tools/search-research/githubsearchtool",
|
|
"tools/search-research/websitesearchtool",
|
|
"tools/search-research/codedocssearchtool",
|
|
"tools/search-research/youtubechannelsearchtool",
|
|
"tools/search-research/youtubevideosearchtool"
|
|
]
|
|
},
|
|
{
|
|
"group": "Database & Data",
|
|
"pages": [
|
|
"tools/database-data/overview",
|
|
"tools/database-data/mysqltool",
|
|
"tools/database-data/pgsearchtool",
|
|
"tools/database-data/snowflakesearchtool",
|
|
"tools/database-data/nl2sqltool",
|
|
"tools/database-data/qdrantvectorsearchtool",
|
|
"tools/database-data/weaviatevectorsearchtool"
|
|
]
|
|
},
|
|
{
|
|
"group": "AI & Machine Learning",
|
|
"pages": [
|
|
"tools/ai-ml/overview",
|
|
"tools/ai-ml/dalletool",
|
|
"tools/ai-ml/visiontool",
|
|
"tools/ai-ml/aimindtool",
|
|
"tools/ai-ml/llamaindextool",
|
|
"tools/ai-ml/langchaintool",
|
|
"tools/ai-ml/ragtool",
|
|
"tools/ai-ml/codeinterpretertool"
|
|
]
|
|
},
|
|
{
|
|
"group": "Cloud & Storage",
|
|
"pages": [
|
|
"tools/cloud-storage/overview",
|
|
"tools/cloud-storage/s3readertool",
|
|
"tools/cloud-storage/s3writertool",
|
|
"tools/cloud-storage/bedrockinvokeagenttool",
|
|
"tools/cloud-storage/bedrockkbretriever"
|
|
]
|
|
},
|
|
{
|
|
"group": "Automation & Integration",
|
|
"pages": [
|
|
"tools/automation/overview",
|
|
"tools/automation/apifyactorstool",
|
|
"tools/automation/composiotool",
|
|
"tools/automation/multiontool"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Observability",
|
|
"pages": [
|
|
"observability/overview",
|
|
"observability/agentops",
|
|
"observability/arize-phoenix",
|
|
"observability/langfuse",
|
|
"observability/langtrace",
|
|
"observability/maxim",
|
|
"observability/mlflow",
|
|
"observability/openlit",
|
|
"observability/opik",
|
|
"observability/patronus-evaluation",
|
|
"observability/portkey",
|
|
"observability/weave"
|
|
]
|
|
},
|
|
{
|
|
"group": "Learn",
|
|
"pages": [
|
|
"learn/overview",
|
|
"learn/llm-selection-guide",
|
|
"learn/conditional-tasks",
|
|
"learn/coding-agents",
|
|
"learn/create-custom-tools",
|
|
"learn/custom-llm",
|
|
"learn/custom-manager-agent",
|
|
"learn/customizing-agents",
|
|
"learn/dalle-image-generation",
|
|
"learn/force-tool-output-as-result",
|
|
"learn/hierarchical-process",
|
|
"learn/human-input-on-execution",
|
|
"learn/kickoff-async",
|
|
"learn/kickoff-for-each",
|
|
"learn/llm-connections",
|
|
"learn/multimodal-agents",
|
|
"learn/replay-tasks-from-latest-crew-kickoff",
|
|
"learn/sequential-process",
|
|
"learn/using-annotations"
|
|
]
|
|
},
|
|
{
|
|
"group": "Telemetry",
|
|
"pages": [
|
|
"telemetry"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Enterprise",
|
|
"groups": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"enterprise/introduction"
|
|
]
|
|
},
|
|
{
|
|
"group": "Features",
|
|
"pages": [
|
|
"enterprise/features/tool-repository",
|
|
"enterprise/features/webhook-streaming",
|
|
"enterprise/features/traces",
|
|
"enterprise/features/hallucination-guardrail",
|
|
"enterprise/features/integrations"
|
|
]
|
|
},
|
|
{
|
|
"group": "Integration Docs",
|
|
"pages": [
|
|
"enterprise/integrations/asana",
|
|
"enterprise/integrations/box",
|
|
"enterprise/integrations/clickup",
|
|
"enterprise/integrations/github",
|
|
"enterprise/integrations/gmail",
|
|
"enterprise/integrations/google_calendar",
|
|
"enterprise/integrations/google_sheets",
|
|
"enterprise/integrations/hubspot",
|
|
"enterprise/integrations/jira",
|
|
"enterprise/integrations/linear",
|
|
"enterprise/integrations/notion",
|
|
"enterprise/integrations/salesforce",
|
|
"enterprise/integrations/shopify",
|
|
"enterprise/integrations/slack",
|
|
"enterprise/integrations/stripe",
|
|
"enterprise/integrations/zendesk"
|
|
]
|
|
},
|
|
{
|
|
"group": "How-To Guides",
|
|
"pages": [
|
|
"enterprise/guides/build-crew",
|
|
"enterprise/guides/deploy-crew",
|
|
"enterprise/guides/kickoff-crew",
|
|
"enterprise/guides/update-crew",
|
|
"enterprise/guides/enable-crew-studio",
|
|
"enterprise/guides/azure-openai-setup",
|
|
"enterprise/guides/hubspot-trigger",
|
|
"enterprise/guides/react-component-export",
|
|
"enterprise/guides/salesforce-trigger",
|
|
"enterprise/guides/slack-trigger",
|
|
"enterprise/guides/team-management",
|
|
"enterprise/guides/webhook-automation",
|
|
"enterprise/guides/human-in-the-loop",
|
|
"enterprise/guides/zapier-trigger"
|
|
]
|
|
},
|
|
{
|
|
"group": "Resources",
|
|
"pages": [
|
|
"enterprise/resources/frequently-asked-questions"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "API Reference",
|
|
"groups": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"api-reference/introduction"
|
|
]
|
|
},
|
|
{
|
|
"group": "Endpoints",
|
|
"openapi": "enterprise-api.yaml"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Examples",
|
|
"groups": [
|
|
{
|
|
"group": "Examples",
|
|
"pages": [
|
|
"examples/example"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Releases",
|
|
"groups": [
|
|
{
|
|
"group": "Releases",
|
|
"pages": [
|
|
"changelog"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"global": {
|
|
"anchors": [
|
|
{
|
|
"anchor": "Website",
|
|
"href": "https://crewai.com",
|
|
"icon": "globe"
|
|
},
|
|
{
|
|
"anchor": "Forum",
|
|
"href": "https://community.crewai.com",
|
|
"icon": "discourse"
|
|
},
|
|
{
|
|
"anchor": "Crew GPT",
|
|
"href": "https://chatgpt.com/g/g-qqTuUWsBY-crewai-assistant",
|
|
"icon": "robot"
|
|
},
|
|
{
|
|
"anchor": "Get Help",
|
|
"href": "mailto:support@crewai.com",
|
|
"icon": "headset"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"logo": {
|
|
"light": "images/crew_only_logo.png",
|
|
"dark": "images/crew_only_logo.png"
|
|
},
|
|
"appearance": {
|
|
"default": "dark",
|
|
"strict": false
|
|
},
|
|
"navbar": {
|
|
"links": [
|
|
{
|
|
"label": "Start Cloud Trial",
|
|
"href": "https://app.crewai.com"
|
|
}
|
|
],
|
|
"primary": {
|
|
"type": "github",
|
|
"href": "https://github.com/crewAIInc/crewAI"
|
|
}
|
|
},
|
|
"search": {
|
|
"prompt": "Search CrewAI docs"
|
|
},
|
|
"api": {
|
|
"baseUrl": "https://your-actual-crew-name.crewai.com",
|
|
"auth": {
|
|
"method": "bearer",
|
|
"name": "Authorization"
|
|
},
|
|
"playground": {
|
|
"mode": "simple"
|
|
}
|
|
},
|
|
"seo": {
|
|
"indexing": "all"
|
|
},
|
|
"errors": {
|
|
"404": {
|
|
"redirect": true
|
|
}
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"website": "https://crewai.com",
|
|
"x": "https://x.com/crewAIInc",
|
|
"github": "https://github.com/crewAIInc/crewAI",
|
|
"linkedin": "https://www.linkedin.com/company/crewai-inc",
|
|
"youtube": "https://youtube.com/@crewAIInc",
|
|
"reddit": "https://www.reddit.com/r/crewAIInc/"
|
|
}
|
|
}
|
|
}
|