composiohq__composio/fern/docs.yml

instances:
- url: v3composio.docs.buildwithfern.com
  custom-domain: docs.composio.dev
title: Composio Docs
default-language: python
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: Inter
    paths:
    - path: assets/Inter-Medium.woff2
      weight: '500'
  headingsFont:
    name: Inter
    paths:
    - path: assets/Inter-Medium.woff2
      weight: '500'
  codeFont:
    name: IBM Plex Mono
    paths:
    - path: assets/IBMPlexMono-Light.ttf
      weight: '400'
navbar-links:
- type: minimal
  text: Status
  url: https://status.composio.dev/
- type: outlined
  text: Dashboard
  rightIcon: fa-light fa-arrow-up-right
  url: https://platform.composio.dev/auth
layout:
  page-width: full
  content-width: 60rem
  tabs-placement: header
  searchbar-placement: header
  header-height: 64px
  sidebar-width: 298px
ai-search:
  location:
  - docs
  - slack
  system-prompt: |
    You are Composio's Ask AI assistant for the Composio documentation.
    Task: deliver precise, developer-ready answers grounded only in the indexed Composio documentation, uploaded documents, or approved website captures or github sources.
    Response style:
    - Lead with the direct answer. Use short paragraphs or bullet steps for procedures.
    - Highlight any required commands or code with fenced blocks when needed.
    Citation rules:
    - Always include markdown citations to every source you rely on.
    - If no indexed source supports the question, state that the information is unavailable and suggest where the user might look (e.g., support, roadmap).
    Safety:
    - Never fabricate features, integrations, pricing, or timelines.
    - Decline questions outside the available sources.
settings:
  hide-404-page: true
  http-snippets: true
colors:
  accent-primary:
    light: '#FF782F'
    dark: '#FF9233'
  background:
    light: '#F7F4F0'
    dark: '#0F0602'
  sidebar-background:
    light: '#F7F4F0'
    dark: '#0F0602'
  header-background:
    light: '#F7F4F0'
    dark: '#0F0602'
analytics:
  posthog:
    api-key: ${POSTHOG_API_KEY}
redirects:
- source: /tools/:path
  destination: /toolkits/:path
tabs:
  docs:
    display-name: Guides
    icon: fa-light fa-book
    slug: docs
  sdk-reference:
    display-name: SDK Reference
    icon: fa-light fa-code
  api-reference:
    display-name: API Reference
    icon: fa-light fa-server
    skip-slug: true
  toolkits:
    display-name: Toolkits
    icon: fa-light fa-tools
    skip-slug: true
  providers:
    display-name: Providers
    icon: fa-light fa-code
    skip-slug: true
  examples:
    display-name: Examples
    icon: fa-light fa-running
    skip-slug: true
  changelog:
    display-name: Changelog
    icon: fa-light fa-history
    changelog: ./pages/src/changelog
navigation:
- tab: docs
  layout:
  - section: Get Started
    icon: fa-light fa-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: fa-light fa-wrench
    skip-slug: true
    contents:
    - 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
    - page: Executing Tools
      path: pages/dist/tool-calling/executing-tools.mdx
      slug: executing-tools
    - section: Modify tool behavior
      slug: tools/modify
      contents:
      - page: Modifying tool schemas
        path: pages/dist/tool-calling/schema-modifiers.mdx
        slug: modifying-tool-schemas
      - page: Modifying tool inputs
        path: pages/dist/tool-calling/before-execution-modifiers.mdx
        slug: modifying-tool-inputs
      - page: Modifying tool outputs
        path: pages/dist/tool-calling/after-execution-modifiers.mdx
        slug: modifying-tool-outputs
    - page: Custom tools
      path: pages/dist/tool-calling/custom-tools.mdx
      slug: custom-tools
    - page: Toolkit Versioning
      path: pages/dist/tool-calling/toolkit-versioning.mdx
      slug: toolkit-versioning
  - section: Authentication
    icon: fa-light fa-key
    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
    - page: User Management
      path: pages/dist/authentication/user-management.mdx
      slug: user-management
  - section: Triggers
    icon: fa-light fa-bolt
    skip-slug: true
    contents:
    - page: Using Triggers
      path: pages/dist/triggers/using-triggers.mdx
      slug: using-triggers
  - section: MCP
    icon: fa-light fa-database
    skip-slug: true
    contents:
    - page: Quickstart
      path: pages/dist/mcp/quickstart.mdx
      slug: mcp-quickstart
    - page: Server management
      path: pages/dist/mcp/server-management.mdx
      slug: mcp-server-management
    - page: Providers
      path: pages/dist/mcp/providers.mdx
      slug: mcp-providers
    - page: Partner Program
      path: pages/dist/mcp/partner-api.mdx
      slug: mcp-partner-api
  - section: Tool Router (Beta)
    icon: fa-light fa-flask
    skip-slug: true
    contents:
    - page: Quick Start
      path: pages/dist/tool-router/quick-start.mdx
      slug: tool-router/quick-start
  - section: Resources
    icon: fa-light fa-book
    skip-slug: true
    contents:
    - page: CLI
      path: pages/dist/resources/cli.mdx
      slug: cli
    - page: Debugging Info
      path: pages/dist/resources/debugging-info.mdx
      slug: resources/debugging-info
    - section: Migration Guides
      slug: migration-guide
      contents:
        - page: Overview
          path: pages/dist/migration-guide/index.mdx
          slug: overview
        - page: New SDK Migration
          path: pages/dist/migration-guide/new-sdk.mdx
          slug: new-sdk
        - page: Toolkit Versioning Migration
          path: pages/dist/migration-guide/toolkit-versioning.mdx
          slug: toolkit-versioning
    - section: Troubleshooting
      slug: troubleshooting
      contents:
      - page: Overview
        path: pages/dist/resources/troubleshooting/overview.mdx
        slug: overview
      - page: API
        path: pages/dist/resources/troubleshooting/api.mdx
        slug: api
      - page: Authentication
        path: pages/dist/resources/troubleshooting/authentication.mdx
        slug: authentication
      - page: CLI
        path: pages/dist/resources/troubleshooting/cli.mdx
        slug: cli
      - page: Dashboard
        path: pages/dist/resources/troubleshooting/dashboard.mdx
        slug: dashboard
      - page: MCP
        path: pages/dist/resources/troubleshooting/mcp.mdx
        slug: mcp
      - page: SDKs
        path: pages/dist/resources/troubleshooting/sdks.mdx
        slug: sdks
      - page: Tools & Toolkits
        path: pages/dist/resources/troubleshooting/tools.mdx
        slug: tools
      - page: Triggers
        path: pages/dist/resources/troubleshooting/triggers.mdx
        slug: triggers
- tab: examples
  layout:
  - section: Getting Started
    icon: fa-light fa-rocket
    skip-slug: true
    contents:
    - page: Basic FastAPI Server
      path: pages/dist/examples/fast-api.mdx
      slug: examples/fast-api
    - page: Basic Hono Server
      path: pages/dist/examples/hono.mdx
      slug: examples/hono
  - section: Productivity & Automation
    icon: fa-light fa-bolt
    skip-slug: true
    contents:
    - page: Gmail Labeller
      path: pages/dist/examples/utility_agents/gmail_labeler.mdx
      slug: examples/gmail-labeler
    - page: Slack summariser
      path: pages/dist/examples/utility_agents/slack_summariser.mdx
      slug: examples/slack-summariser
    - page: Supabase SQL Agent
      path: pages/dist/examples/utility_agents/supabase_sql_agent.mdx
      slug: examples/supabase-sql-agent
  - section: Full Stack Applications
    icon: fa-light fa-globe
    skip-slug: true
    contents:
    - page: Full Stack Chat App
      path: pages/dist/examples/chat_applications/vercel_chat.mdx
      slug: examples/vercel-chat
  - section: Behind the curtain
    icon: fa-light fa-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: Supported Providers
    icon: fa-light fa-code
    contents:
    - page: OpenAI Provider
      path: pages/dist/providers/openai.mdx
    - page: Anthropic Provider
      path: pages/dist/providers/anthropic.mdx
    - page: Google Provider
      path: pages/dist/providers/google.mdx
    - page: LangChain Provider
      path: pages/dist/providers/langchain.mdx
    - page: LlamaIndex Provider
      path: pages/dist/providers/llamaindex.mdx
    - page: CrewAI Provider
      path: pages/dist/providers/crewai.mdx
    - page: Vercel AI SDK Provider
      path: pages/dist/providers/vercel.mdx
    - page: OpenAI Agents Provider
      path: pages/dist/providers/openai-agents.mdx
    - page: Mastra Provider
      path: pages/dist/providers/mastra.mdx
  - section: Writing your own provider
    skip-slug: true
    icon: fa-light fa-code
    contents:
    - page: TypeScript
      path: pages/dist/providers/ts-custom.mdx
      slug: providers/custom/typescript
    - page: Python
      path: pages/dist/providers/py-custom.mdx
      slug: providers/custom/python
- tab: toolkits
  layout:
  - section: Toolkits
    skip-slug: true
    contents:
    - page: Introduction
      path: toolkits/src/introduction.mdx
      slug: toolkits/introduction
    - page: Premium Tools
      path: toolkits/src/premium-tools.mdx
      slug: toolkits/premium-tools
  - section: Important
    skip-slug: true
    contents:
    - page: Github
      slug: toolkits/github
      path: toolkits/github.mdx
    - page: Gmail
      slug: toolkits/gmail
      path: toolkits/gmail.mdx
    - page: Notion
      slug: toolkits/notion
      path: toolkits/notion.mdx
  - section: Scheduling & Booking
    skip-slug: true
    contents:
    - page: Google Calendar
      slug: toolkits/googlecalendar
      path: toolkits/googlecalendar.mdx
  - section: No Auth
    skip-slug: true
    contents:
    - page: Composio
      slug: toolkits/composio
      path: toolkits/composio.mdx
- tab: sdk-reference
  layout:
  - section: Python
    slug: python
    icon: fa-brands fa-python
    contents:
    - page: Python SDK Reference
      slug: python-sdk-reference
      path: pages/dist/sdk/python/sdk-reference.md
  - section: TypeScript
    slug: type-script
    icon: fa-brands fa-js
    contents:
    - section: Core Classes
      slug: core-classes
      contents:
      - page: Composio
        slug: composio
        path: pages/dist/sdk/typescript/composio/classes/Composio.mdx
      - page: ComposioProvider
        slug: composio-provider
        path: pages/dist/sdk/typescript/provider/ComposioProvider/classes/ComposioProvider.mdx
      - page: OpenAIProvider
        slug: open-ai-provider
        path: pages/dist/sdk/typescript/provider/OpenAIProvider/classes/OpenAIProvider.mdx
      - page: BaseAgenticProvider
        slug: base-agentic-provider
        path: pages/dist/sdk/typescript/provider/BaseProvider/classes/BaseAgenticProvider.mdx
      - page: BaseNonAgenticProvider
        slug: base-non-agentic-provider
        path: pages/dist/sdk/typescript/provider/BaseProvider/classes/BaseNonAgenticProvider.mdx
    - section: Models
      slug: models
      contents:
      - page: Tools
        slug: tools
        path: pages/dist/sdk/typescript/models/Tools/classes/Tools.mdx
      - page: Toolkits
        slug: toolkits
        path: pages/dist/sdk/typescript/models/Toolkits/classes/Toolkits.mdx
      - page: Triggers
        slug: triggers
        path: pages/dist/sdk/typescript/models/Triggers/classes/Triggers.mdx
      - page: AuthConfigs
        slug: auth-configs
        path: pages/dist/sdk/typescript/AuthConfigs/classes/AuthConfigs.mdx
      - page: ConnectedAccounts
        slug: connected-accounts
        path: pages/dist/sdk/typescript/ConnectedAccounts/classes/ConnectedAccounts.mdx
      - page: CustomTools
        slug: custom-tools
        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