mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
Rahul Tarak
287 lines
7.9 KiB
YAML
287 lines
7.9 KiB
YAML
instances:
|
|
- url: v3composio.docs.buildwithfern.com
|
|
custom-domain: v3.docs.composio.dev
|
|
edit-this-page:
|
|
github:
|
|
owner: ComposioHQ
|
|
repo: composio
|
|
branch: master
|
|
title: Composio Docs
|
|
default-language: typescript
|
|
logo:
|
|
light: assets/logo.svg
|
|
dark: assets/logo-dark.svg
|
|
height: 16
|
|
href: /
|
|
favicon: assets/favicon.png
|
|
js:
|
|
- path: js/search.js
|
|
strategy: afterInteractive
|
|
typography:
|
|
bodyFont:
|
|
name: Roobert
|
|
paths:
|
|
- path: assets/Roobert-Medium.woff2
|
|
weight: '500'
|
|
- path: assets/Roobert-Regular.woff2
|
|
weight: '400'
|
|
headingsFont:
|
|
name: Roobert
|
|
paths:
|
|
- path: assets/Roobert-Medium.woff2
|
|
weight: '500'
|
|
- path: assets/Roobert-Regular.woff2
|
|
weight: '400'
|
|
codeFont:
|
|
name: IBM Plex Mono
|
|
paths:
|
|
- path: assets/IBMPlexMono-Light.ttf
|
|
weight: '400'
|
|
navbar-links:
|
|
- type: primary
|
|
text: V1 Docs
|
|
url: https://docs.composio.dev
|
|
- type: filled
|
|
text: LOG IN
|
|
url: https://app.composio.dev/login
|
|
layout:
|
|
page-width: full
|
|
tabs-placement: header
|
|
searchbar-placement: header-tabs
|
|
header-height: 50px
|
|
sidebar-width: 298px
|
|
colors:
|
|
accent-primary:
|
|
light: '#4762DA'
|
|
dark: '#9EB6FF'
|
|
background:
|
|
light: '#F7F4F0'
|
|
dark: '#0A0C12'
|
|
analytics:
|
|
posthog:
|
|
api-key: ${POSTHOG_API_KEY}
|
|
tabs:
|
|
docs:
|
|
display-name: Guides
|
|
icon: book
|
|
slug: docs
|
|
sdk-reference:
|
|
display-name: SDK Reference
|
|
icon: code
|
|
api-reference:
|
|
display-name: API Reference
|
|
icon: server
|
|
skip-slug: true
|
|
tools:
|
|
display-name: Tools
|
|
icon: tools
|
|
skip-slug: true
|
|
providers:
|
|
display-name: Providers
|
|
icon: code
|
|
skip-slug: true
|
|
examples:
|
|
display-name: Examples
|
|
icon: running
|
|
skip-slug: true
|
|
changelog:
|
|
display-name: Changelog
|
|
icon: history
|
|
changelog: ./pages/changelog
|
|
navigation:
|
|
- tab: docs
|
|
layout:
|
|
- section: Get Started
|
|
icon: rocket
|
|
skip-slug: true
|
|
contents:
|
|
- page: Welcome
|
|
path: pages/dist/get-started/welcome.mdx
|
|
slug: welcome
|
|
- page: Quickstart
|
|
path: pages/dist/get-started/quickstart.mdx
|
|
slug: quickstart
|
|
- page: IDE and Agent Setup
|
|
path: pages/dist/get-started/dev-setup.mdx
|
|
slug: dev-setup
|
|
- page: Providers
|
|
path: pages/dist/get-started/providers.mdx
|
|
slug: providers
|
|
- section: Tools
|
|
icon: tools
|
|
skip-slug: true
|
|
contents:
|
|
- page: Executing Tools
|
|
path: pages/dist/tool-calling/executing-tools.mdx
|
|
slug: executing-tools
|
|
- page: Authenticating Tools
|
|
path: pages/dist/tool-calling/authenticating-tools.mdx
|
|
slug: authenticating-tools
|
|
- page: Fetch and Filter Tools
|
|
path: pages/dist/tool-calling/fetching-tools.mdx
|
|
slug: fetching-tools
|
|
- section: Modifiers
|
|
slug: modifiers
|
|
contents:
|
|
- page: Schema Modifiers
|
|
path: pages/dist/tool-calling/schema-modifiers.mdx
|
|
slug: schema-modifiers
|
|
- page: Before Tool Execution
|
|
path: pages/dist/tool-calling/before-execution-modifiers.mdx
|
|
slug: before-execution
|
|
- page: After Tool Execution
|
|
path: pages/dist/tool-calling/after-execution-modifiers.mdx
|
|
slug: after-execution
|
|
- page: Custom tools
|
|
path: pages/dist/tool-calling/custom-tools.mdx
|
|
slug: custom-tools
|
|
- section: Authentication
|
|
icon: lock
|
|
skip-slug: true
|
|
contents:
|
|
- page: Custom Auth Configs
|
|
path: pages/dist/authentication/custom-auth-configs.mdx
|
|
slug: custom-auth-configs
|
|
- page: Programmatic Auth Configs
|
|
path: pages/dist/authentication/programmatic-auth-configs.mdx
|
|
slug: programmatic-auth-configs
|
|
- page: Custom Auth Parameters
|
|
path: pages/dist/authentication/custom-auth-params.mdx
|
|
slug: custom-auth-params
|
|
- section: Triggers
|
|
icon: bolt
|
|
skip-slug: true
|
|
contents:
|
|
- page: Using Triggers
|
|
path: pages/dist/triggers/using-triggers.mdx
|
|
slug: using-triggers
|
|
- section: MCP
|
|
icon: server
|
|
skip-slug: true
|
|
contents:
|
|
- page: Introduction
|
|
path: pages/dist/mcp/introduction.mdx
|
|
slug: mcp-introduction
|
|
- section: Resources
|
|
icon: book
|
|
skip-slug: true
|
|
contents:
|
|
- page: Migration Guide
|
|
path: pages/dist/migration-guide.mdx
|
|
slug: migration
|
|
- tab: examples
|
|
layout:
|
|
- section: Getting Started
|
|
icon: rocket
|
|
skip-slug: true
|
|
contents:
|
|
- page: Hello World
|
|
path: pages/dist/examples/hello-world.mdx
|
|
slug: examples/hello-world
|
|
- page: Sample Script
|
|
path: pages/dist/examples/sample-script.mdx
|
|
slug: examples/sample-script
|
|
- page: Basic Hono Server
|
|
path: pages/dist/examples/sample-webserver/sample-webserver.mdx
|
|
slug: examples/sample-webserver
|
|
- section: Full Stack Applications
|
|
icon: globe
|
|
skip-slug: true
|
|
contents:
|
|
- page: Full Stack Chat App
|
|
path: pages/dist/examples/vercel-composio.mdx
|
|
slug: examples/chat-app
|
|
- section: Productivity & Automation
|
|
icon: zap
|
|
skip-slug: true
|
|
contents:
|
|
- page: Gmail Reaper
|
|
path: pages/dist/examples/gmail-filterer.mdx
|
|
slug: examples/gmail-reaper
|
|
- section: Behind the curtain
|
|
icon: person-booth
|
|
skip-slug: true
|
|
contents:
|
|
- page: Tool Generator
|
|
path: pages/dist/examples/tool-generator/tool-generator.mdx
|
|
slug: examples/tool-generator
|
|
- tab: providers
|
|
layout:
|
|
- section: Providers
|
|
icon: code
|
|
contents:
|
|
- page: OpenAI Provider
|
|
path: pages/dist/providers/openai.mdx
|
|
- page: Anthropic Provider
|
|
path: pages/dist/providers/anthropic.mdx
|
|
- page: LangChain Provider
|
|
path: pages/dist/providers/langchain.mdx
|
|
- page: CrewAI Provider
|
|
path: pages/dist/providers/crewai.mdx
|
|
- page: Vercel AI SDK Provider
|
|
path: pages/dist/providers/vercel.mdx
|
|
- page: Google ADK Provider
|
|
path: pages/dist/providers/google-adk.mdx
|
|
- page: OpenAI Agents Provider
|
|
path: pages/dist/providers/openai-agents.mdx
|
|
- page: Mastra Provider
|
|
path: pages/dist/providers/mastra.mdx
|
|
- page: Custom Provider
|
|
path: pages/dist/providers/custom.mdx
|
|
- tab: tools
|
|
layout:
|
|
- section: Tool
|
|
contents:
|
|
- page: Introduction
|
|
path: tools/introduction.mdx
|
|
- tab: sdk-reference
|
|
layout:
|
|
- section: Python
|
|
icon: python
|
|
contents:
|
|
- page: Python SDK Reference
|
|
path: pages/dist/sdk/python/sdk-reference.md
|
|
- section: TypeScript
|
|
icon: typescript
|
|
contents:
|
|
- section: Core Classes
|
|
slug: core-classes
|
|
contents:
|
|
- page: Composio
|
|
path: pages/dist/sdk/typescript/composio/classes/Composio.mdx
|
|
- page: ComposioProvider
|
|
path: pages/dist/sdk/typescript/provider/ComposioProvider/classes/ComposioProvider.mdx
|
|
- page: OpenAIProvider
|
|
path: pages/dist/sdk/typescript/provider/OpenAIProvider/classes/OpenAIProvider.mdx
|
|
- page: BaseAgenticProvider
|
|
path: pages/dist/sdk/typescript/provider/BaseProvider/classes/BaseAgenticProvider.mdx
|
|
- page: BaseNonAgenticProvider
|
|
path: pages/dist/sdk/typescript/provider/BaseProvider/classes/BaseNonAgenticProvider.mdx
|
|
- section: Models
|
|
slug: models
|
|
contents:
|
|
- page: Tools
|
|
path: pages/dist/sdk/typescript/models/Tools/classes/Tools.mdx
|
|
- page: Toolkits
|
|
path: pages/dist/sdk/typescript/models/Toolkits/classes/Toolkits.mdx
|
|
- page: Triggers
|
|
path: pages/dist/sdk/typescript/models/Triggers/classes/Triggers.mdx
|
|
- page: AuthConfigs
|
|
path: pages/dist/sdk/typescript/AuthConfigs/classes/AuthConfigs.mdx
|
|
- page: ConnectedAccounts
|
|
path: pages/dist/sdk/typescript/ConnectedAccounts/classes/ConnectedAccounts.mdx
|
|
- page: ConnectionRequest
|
|
path: pages/dist/sdk/typescript/ConnectionRequest/classes/ConnectionRequest.mdx
|
|
- page: CustomTools
|
|
path: pages/dist/sdk/typescript/CustomTools/classes/CustomTools.mdx
|
|
- tab: api-reference
|
|
layout:
|
|
- section: API Reference
|
|
contents:
|
|
- api: v3
|
|
api-name: v3
|
|
skip-slug: true
|
|
paginated: false
|
|
flattened: true
|
|
- tab: changelog
|