Files
composiohq__composio/fern/docs.yml
T
2025-06-18 00:18:54 -07:00

913 lines
23 KiB
YAML

# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json
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 # TODO: change to 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
# css: dist/output.css
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/FlechTestSRegular.woff2
# weight: "400"
- 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'
# - path: assets/IBMPlexMono-Medium.woff2
# weight: "500 525"
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'
# sidebar-background:
# light: "#FAFAFA"
# dark: "#1C1C1C"
# header-background:
# light: "#FAFAFA"
# dark: "#1C1C1C"
# card-background:
# light: "#E8E6DE"
# dark: "#1A1A1A"
# border:
# light: "#E0E0E0"
# dark: "#292929"
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
# landing-page:
# page: Composio Documentation
# path: pages/index.mdx
navigation:
- tab: docs
layout:
- section: Get Started
icon: rocket
skip-slug: true
contents:
- page: Welcome
path: pages/welcome.mdx
slug: welcome
- page: Quickstart
path: pages/quickstart.mdx
slug: quickstart
- page: IDE and Agent Setup
path: pages/dev-setup.mdx
slug: dev-setup
- page: Providers
path: pages/providers.mdx
slug: providers
- section: Tools
icon: tools
skip-slug: true
contents:
- page: Executing Tools
path: pages/executing-tools.mdx
slug: executing-tools
- page: Authenticating Tools
path: pages/authenticating-tools.mdx
slug: authenticating-tools
- page: Fetch and Filter Tools
path: pages/fetching-tools.mdx
slug: fetching-tools
- section: Modifiers
slug: modifiers
contents:
- page: Schema Modifiers
path: pages/schema-modifiers.mdx
slug: schema-modifiers
- page: Before Tool Execution
path: pages/before-execution-modifiers.mdx
slug: before-execution
- page: After Tool Execution
path: pages/after-execution-modifiers.mdx
slug: after-execution
- page: Custom tools
path: pages/custom-tools.mdx
slug: custom-tools
- section: Authentication
icon: lock
skip-slug: true
contents:
- page: Custom Auth Configs
path: pages/custom-auth-configs.mdx
slug: custom-auth-configs
- page: Programmatic Auth Configs
path: pages/programmatic-auth-configs.mdx
slug: programmatic-auth-configs
- page: Custom Auth Parameters
path: pages/custom-auth-params.mdx
slug: custom-auth-params
- section: Triggers
icon: bolt
skip-slug: true
contents:
- page: Using Triggers
path: pages/using-triggers.mdx
slug: using-triggers
- section: MCP
icon: server
skip-slug: true
contents:
- page: Introduction
path: pages/introduction.mdx
slug: mcp-introduction
- section: Resources
icon: book
skip-slug: true
contents:
- page: Migration Guide
path: pages/migration-guide.mdx
slug: migration
- tab: examples
layout:
- section: Getting Started
icon: rocket
skip-slug: true
contents:
- page: Hello World
path: pages/hello-world.mdx
slug: examples/hello-world
- page: Sample Script
path: pages/sample-script.mdx
slug: examples/sample-script
- page: Basic Hono Server
path: pages/sample-webserver.mdx
slug: examples/sample-webserver
- section: Full Stack Applications
icon: globe
skip-slug: true
contents:
- page: Full Stack Chat App
path: pages/vercel-composio.mdx
slug: examples/chat-app
- section: Productivity & Automation
icon: zap
skip-slug: true
contents:
- page: Gmail Reaper
path: pages/gmail-filterer.mdx
slug: examples/gmail-reaper
- tab: providers
layout:
- section: Providers
icon: code
contents:
- page: OpenAI Provider
path: pages/openai.mdx
- page: Anthropic Provider
path: pages/anthropic.mdx
- page: LangChain Provider
path: pages/langchain.mdx
- page: CrewAI Provider
path: pages/crewai.mdx
- page: Vercel AI SDK Provider
path: pages/vercel.mdx
- page: Google ADK Provider
path: pages/google-adk.mdx
- page: OpenAI Agents Provider
path: pages/openai-agents.mdx
- page: Mastra Provider
path: pages/mastra.mdx
- page: Custom Provider
path: pages/custom.mdx
- tab: tools
layout:
- section: Tools
contents:
- page: Introduction
path: tools/introduction.mdx
- page: Ably
path: tools/ably.mdx
- page: Accelo
path: tools/accelo.mdx
- page: Acculynx
path: tools/acculynx.mdx
- page: Active Campaign
path: tools/active_campaign.mdx
- page: Adobe
path: tools/adobe.mdx
- page: Aero Workflow
path: tools/aero_workflow.mdx
- page: Affinity
path: tools/affinity.mdx
- page: Agencyzoom
path: tools/agencyzoom.mdx
- page: Ahrefs
path: tools/ahrefs.mdx
- page: Airtable
path: tools/airtable.mdx
- page: Alchemy
path: tools/alchemy.mdx
- page: Altoviz
path: tools/altoviz.mdx
- page: Amazon
path: tools/amazon.mdx
- page: Amcards
path: tools/amcards.mdx
- page: Amplitude
path: tools/amplitude.mdx
- page: Apaleo
path: tools/apaleo.mdx
- page: Apollo
path: tools/apollo.mdx
- page: Appdrag
path: tools/appdrag.mdx
- page: Appsflyer
path: tools/appsflyer.mdx
- page: Asana
path: tools/asana.mdx
- page: Ashby
path: tools/ashby.mdx
- page: Atlassian
path: tools/atlassian.mdx
- page: Attio
path: tools/attio.mdx
- page: Auth0
path: tools/auth0.mdx
- page: Axonaut
path: tools/axonaut.mdx
- page: Bamboohr
path: tools/bamboohr.mdx
- page: Bannerbear
path: tools/bannerbear.mdx
- page: Baserow
path: tools/baserow.mdx
- page: Battlenet
path: tools/battlenet.mdx
- page: Beeminder
path: tools/beeminder.mdx
- page: Bigmailer
path: tools/bigmailer.mdx
- page: Bitbucket
path: tools/bitbucket.mdx
- page: Bitwarden
path: tools/bitwarden.mdx
- page: Blackbaud
path: tools/blackbaud.mdx
- page: Blackboard
path: tools/blackboard.mdx
- page: Boldsign
path: tools/boldsign.mdx
- page: Bolna
path: tools/bolna.mdx
- page: Borneo
path: tools/borneo.mdx
- page: Botbaba
path: tools/botbaba.mdx
- page: Box
path: tools/box.mdx
- page: Braintree
path: tools/braintree.mdx
- page: Brandfetch
path: tools/brandfetch.mdx
- page: Breezy Hr
path: tools/breezy_hr.mdx
- page: Brevo
path: tools/brevo.mdx
- page: Brex
path: tools/brex.mdx
- page: Brex Staging
path: tools/brex_staging.mdx
- page: Brightpearl
path: tools/brightpearl.mdx
- page: Brilliant Directories
path: tools/brilliant_directories.mdx
- page: Browseai
path: tools/browseai.mdx
- page: Browserbase Tool
path: tools/browserbase_tool.mdx
- page: Browserhub
path: tools/browserhub.mdx
- page: Browserless
path: tools/browserless.mdx
- page: Bubble
path: tools/bubble.mdx
- page: Bugbug
path: tools/bugbug.mdx
- page: Cal
path: tools/cal.mdx
- page: Calendly
path: tools/calendly.mdx
- page: Canva
path: tools/canva.mdx
- page: Canvas
path: tools/canvas.mdx
- page: Chatwork
path: tools/chatwork.mdx
- page: Chmeetings
path: tools/chmeetings.mdx
- page: Clickup
path: tools/clickup.mdx
- page: Clockify
path: tools/clockify.mdx
- page: Close
path: tools/close.mdx
- page: Cloudflare
path: tools/cloudflare.mdx
- page: Coda
path: tools/coda.mdx
- page: Codeinterpreter
path: tools/codeinterpreter.mdx
- page: Coinbase
path: tools/coinbase.mdx
- page: Coinmarketcal
path: tools/coinmarketcal.mdx
- page: Composio
path: tools/composio.mdx
- page: Composio Search
path: tools/composio_search.mdx
- page: Confluence
path: tools/confluence.mdx
- page: Contentful
path: tools/contentful.mdx
- page: Crustdata
path: tools/crustdata.mdx
- page: Customer Io
path: tools/customer_io.mdx
- page: Cutt Ly
path: tools/cutt_ly.mdx
- page: D2Lbrightspace
path: tools/d2lbrightspace.mdx
- page: Dailybot
path: tools/dailybot.mdx
- page: Datadog
path: tools/datadog.mdx
- page: Datagma
path: tools/datagma.mdx
- page: Datarobot
path: tools/datarobot.mdx
- page: Deel
path: tools/deel.mdx
- page: Demio
path: tools/demio.mdx
- page: Dialpad
path: tools/dialpad.mdx
- page: Digicert
path: tools/digicert.mdx
- page: Discord
path: tools/discord.mdx
- page: Discordbot
path: tools/discordbot.mdx
- page: Docmosis
path: tools/docmosis.mdx
- page: Docusign
path: tools/docusign.mdx
- page: Dropbox
path: tools/dropbox.mdx
- page: Dropbox Sign
path: tools/dropbox_sign.mdx
- page: Dynamics365
path: tools/dynamics365.mdx
- page: Echtpost
path: tools/echtpost.mdx
- page: Elevenlabs
path: tools/elevenlabs.mdx
- page: Emailoctopus
path: tools/emailoctopus.mdx
- page: Enigma
path: tools/enigma.mdx
- page: Entelligence
path: tools/entelligence.mdx
- page: Epic Games
path: tools/epic_games.mdx
- page: Eventbrite
path: tools/eventbrite.mdx
- page: Exa
path: tools/exa.mdx
- page: Excel
path: tools/excel.mdx
- page: Exist
path: tools/exist.mdx
- page: Facebook
path: tools/facebook.mdx
- page: Factorial
path: tools/factorial.mdx
- page: Figma
path: tools/figma.mdx
- page: Finage
path: tools/finage.mdx
- page: Firecrawl
path: tools/firecrawl.mdx
- page: Fireflies
path: tools/fireflies.mdx
- page: Fitbit
path: tools/fitbit.mdx
- page: Flutterwave
path: tools/flutterwave.mdx
- page: Fomo
path: tools/fomo.mdx
- page: Formcarry
path: tools/formcarry.mdx
- page: Formsite
path: tools/formsite.mdx
- page: Foursquare
path: tools/foursquare.mdx
- page: Freshbooks
path: tools/freshbooks.mdx
- page: Freshdesk
path: tools/freshdesk.mdx
- page: Front
path: tools/front.mdx
- page: Github
path: tools/github.mdx
- page: Gmail
path: tools/gmail.mdx
- page: Go To Webinar
path: tools/go_to_webinar.mdx
- page: Gong
path: tools/gong.mdx
- page: Google Analytics
path: tools/google_analytics.mdx
- page: Google Maps
path: tools/google_maps.mdx
- page: Googleads
path: tools/googleads.mdx
- page: Googlebigquery
path: tools/googlebigquery.mdx
- page: Googlecalendar
path: tools/googlecalendar.mdx
- page: Googledocs
path: tools/googledocs.mdx
- page: Googledrive
path: tools/googledrive.mdx
- page: Googlemeet
path: tools/googlemeet.mdx
- page: Googlephotos
path: tools/googlephotos.mdx
- page: Googlesheets
path: tools/googlesheets.mdx
- page: Googleslides
path: tools/googleslides.mdx
- page: Googlesuper
path: tools/googlesuper.mdx
- page: Googletasks
path: tools/googletasks.mdx
- page: Gorgias
path: tools/gorgias.mdx
- page: Gumroad
path: tools/gumroad.mdx
- page: Guru
path: tools/guru.mdx
- page: Hackernews
path: tools/hackernews.mdx
- page: Hackerrank Work
path: tools/hackerrank_work.mdx
- page: Harvest
path: tools/harvest.mdx
- page: Helcim
path: tools/helcim.mdx
- page: Heygen
path: tools/heygen.mdx
- page: Highlevel
path: tools/highlevel.mdx
- page: Hubspot
path: tools/hubspot.mdx
- page: Humanloop
path: tools/humanloop.mdx
- page: Icims Talent Cloud
path: tools/icims_talent_cloud.mdx
- page: Idea Scale
path: tools/idea_scale.mdx
- page: Intercom
path: tools/intercom.mdx
- page: Interzoid
path: tools/interzoid.mdx
- page: Jira
path: tools/jira.mdx
- page: Junglescout
path: tools/junglescout.mdx
- page: Keap
path: tools/keap.mdx
- page: Klaviyo
path: tools/klaviyo.mdx
- page: Klipfolio
path: tools/klipfolio.mdx
- page: Kommo
path: tools/kommo.mdx
- page: Lastpass
path: tools/lastpass.mdx
- page: Launch Darkly
path: tools/launch_darkly.mdx
- page: Leadfeeder
path: tools/leadfeeder.mdx
- page: Leadoku
path: tools/leadoku.mdx
- page: Lever
path: tools/lever.mdx
- page: Lever Sandbox
path: tools/lever_sandbox.mdx
- page: Lexoffice
path: tools/lexoffice.mdx
- page: Linear
path: tools/linear.mdx
- page: Linkedin
path: tools/linkedin.mdx
- page: Linkhut
path: tools/linkhut.mdx
- page: Linkup
path: tools/linkup.mdx
- page: Listennotes
path: tools/listennotes.mdx
- page: Lmnt
path: tools/lmnt.mdx
- page: Lodgify
path: tools/lodgify.mdx
- page: Mailchimp
path: tools/mailchimp.mdx
- page: Mailerlite
path: tools/mailerlite.mdx
- page: Maintainx
path: tools/maintainx.mdx
- page: Mboum
path: tools/mboum.mdx
- page: Mem0
path: tools/mem0.mdx
- page: Metaads
path: tools/metaads.mdx
- page: Metatextai
path: tools/metatextai.mdx
- page: Microsoft Clarity
path: tools/microsoft_clarity.mdx
- page: Microsoft Teams
path: tools/microsoft_teams.mdx
- page: Microsoft Tenant
path: tools/microsoft_tenant.mdx
- page: Miro
path: tools/miro.mdx
- page: Mixpanel
path: tools/mixpanel.mdx
- page: Mocean
path: tools/mocean.mdx
- page: Monday
path: tools/monday.mdx
- page: Mopinion
path: tools/mopinion.mdx
- page: More Trees
path: tools/more_trees.mdx
- page: Moxie
path: tools/moxie.mdx
- page: Moz
path: tools/moz.mdx
- page: Mural
path: tools/mural.mdx
- page: Ncscale
path: tools/ncscale.mdx
- page: Neon
path: tools/neon.mdx
- page: Netsuite
path: tools/netsuite.mdx
- page: Nextdns
path: tools/nextdns.mdx
- page: Ngrok
path: tools/ngrok.mdx
- page: Notion
path: tools/notion.mdx
- page: Oncehub
path: tools/oncehub.mdx
- page: One Drive
path: tools/one_drive.mdx
- page: Onepage
path: tools/onepage.mdx
- page: Open Sea
path: tools/open_sea.mdx
- page: Outlook
path: tools/outlook.mdx
- page: Pagerduty
path: tools/pagerduty.mdx
- page: Pandadoc
path: tools/pandadoc.mdx
- page: Peopledatalabs
path: tools/peopledatalabs.mdx
- page: Perplexityai
path: tools/perplexityai.mdx
- page: Piggy
path: tools/piggy.mdx
- page: Pipedrive
path: tools/pipedrive.mdx
- page: Placekey
path: tools/placekey.mdx
- page: Posthog
path: tools/posthog.mdx
- page: Precoro
path: tools/precoro.mdx
- page: Printnode
path: tools/printnode.mdx
- page: Process Street
path: tools/process_street.mdx
- page: Productboard
path: tools/productboard.mdx
- page: Qualaroo
path: tools/qualaroo.mdx
- page: Quickbooks
path: tools/quickbooks.mdx
- page: Rafflys
path: tools/rafflys.mdx
- page: Ragic
path: tools/ragic.mdx
- page: Ramp
path: tools/ramp.mdx
- page: Ravenseotools
path: tools/ravenseotools.mdx
- page: Recallai
path: tools/recallai.mdx
- page: Reddit
path: tools/reddit.mdx
- page: Resend
path: tools/resend.mdx
- page: Retellai
path: tools/retellai.mdx
- page: Ring Central
path: tools/ring_central.mdx
- page: Rippling
path: tools/rippling.mdx
- page: Rocket Reach
path: tools/rocket_reach.mdx
- page: Rocketlane
path: tools/rocketlane.mdx
- page: Rootly
path: tools/rootly.mdx
- page: Rosette Text Analytics
path: tools/rosette_text_analytics.mdx
- page: Sage
path: tools/sage.mdx
- page: Salesforce
path: tools/salesforce.mdx
- page: Scrape Do
path: tools/scrape_do.mdx
- page: Scrapingant
path: tools/scrapingant.mdx
- page: Screenshotone
path: tools/screenshotone.mdx
- page: Seismic
path: tools/seismic.mdx
- page: Semanticscholar
path: tools/semanticscholar.mdx
- page: Semrush
path: tools/semrush.mdx
- page: Sendgrid
path: tools/sendgrid.mdx
- page: Sentry
path: tools/sentry.mdx
- page: Serpapi
path: tools/serpapi.mdx
- page: Servicem8
path: tools/servicem8.mdx
- page: Servicenow
path: tools/servicenow.mdx
- page: Share Point
path: tools/share_point.mdx
- page: Shopify
path: tools/shopify.mdx
- page: Shortcut
path: tools/shortcut.mdx
- page: Simplesat
path: tools/simplesat.mdx
- page: Slack
path: tools/slack.mdx
- page: Slackbot
path: tools/slackbot.mdx
- page: Smartrecruiters
path: tools/smartrecruiters.mdx
- page: Smugmug
path: tools/smugmug.mdx
- page: Snowflake
path: tools/snowflake.mdx
- page: Square
path: tools/square.mdx
- page: Stack Exchange
path: tools/stack_exchange.mdx
- page: Starton
path: tools/starton.mdx
- page: Stripe
path: tools/stripe.mdx
- page: Supabase
path: tools/supabase.mdx
- page: Survey Monkey
path: tools/survey_monkey.mdx
- page: Tapform
path: tools/tapform.mdx
- page: Tavily
path: tools/tavily.mdx
- page: Terminus
path: tools/terminus.mdx
- page: Text To Pdf
path: tools/text_to_pdf.mdx
- page: Textrazor
path: tools/textrazor.mdx
- page: Timecamp
path: tools/timecamp.mdx
- page: Timekit
path: tools/timekit.mdx
- page: Timely
path: tools/timely.mdx
- page: Tinypng
path: tools/tinypng.mdx
- page: Tinyurl
path: tools/tinyurl.mdx
- page: Tisane
path: tools/tisane.mdx
- page: Todoist
path: tools/todoist.mdx
- page: Toneden
path: tools/toneden.mdx
- page: Tpscheck
path: tools/tpscheck.mdx
- page: Trello
path: tools/trello.mdx
- page: Twitch
path: tools/twitch.mdx
- page: Twitter
path: tools/twitter.mdx
- page: Twitter Media
path: tools/twitter_media.mdx
- page: Typefully
path: tools/typefully.mdx
- page: Venly
path: tools/venly.mdx
- page: Vero
path: tools/vero.mdx
- page: Visme
path: tools/visme.mdx
- page: Waboxapp
path: tools/waboxapp.mdx
- page: Wakatime
path: tools/wakatime.mdx
- page: Wave Accounting
path: tools/wave_accounting.mdx
- page: Weathermap
path: tools/weathermap.mdx
- page: Webex
path: tools/webex.mdx
- page: Webflow
path: tools/webflow.mdx
- page: Whatsapp
path: tools/whatsapp.mdx
- page: Wiz
path: tools/wiz.mdx
- page: Workiom
path: tools/workiom.mdx
- page: Wrike
path: tools/wrike.mdx
- page: Xero
path: tools/xero.mdx
- page: Yandex
path: tools/yandex.mdx
- page: Ynab
path: tools/ynab.mdx
- page: Yousearch
path: tools/yousearch.mdx
- page: Youtube
path: tools/youtube.mdx
- page: Zendesk
path: tools/zendesk.mdx
- page: Zenrows
path: tools/zenrows.mdx
- page: Zenserp
path: tools/zenserp.mdx
- page: Zoho
path: tools/zoho.mdx
- page: Zoho Bigin
path: tools/zoho_bigin.mdx
- page: Zoho Books
path: tools/zoho_books.mdx
- page: Zoho Desk
path: tools/zoho_desk.mdx
- page: Zoho Inventory
path: tools/zoho_inventory.mdx
- page: Zoho Invoice
path: tools/zoho_invoice.mdx
- page: Zoho Mail
path: tools/zoho_mail.mdx
- page: Zoom
path: tools/zoom.mdx
- page: Zoominfo
path: tools/zoominfo.mdx
- tab: sdk-reference
layout:
- section: Python
icon: python
contents:
- page: Python SDK Reference
path: pages/sdk/python/sdk-reference.md
- section: TypeScript
icon: typescript
contents:
- section: Core Classes
slug: core-classes
contents:
- page: Composio
path: pages/sdk/typescript/composio/classes/Composio.mdx
- page: ComposioProvider
path: pages/sdk/typescript/provider/ComposioProvider/classes/ComposioProvider.mdx
- page: OpenAIProvider
path: pages/sdk/typescript/provider/OpenAIProvider/classes/OpenAIProvider.mdx
- page: BaseAgenticProvider
path: pages/sdk/typescript/provider/BaseProvider/classes/BaseAgenticProvider.mdx
- page: BaseNonAgenticProvider
path: pages/sdk/typescript/provider/BaseProvider/classes/BaseNonAgenticProvider.mdx
- section: Models
slug: models
contents:
- page: Tools
path: pages/sdk/typescript/models/Tools/classes/Tools.mdx
- page: Toolkits
path: pages/sdk/typescript/models/Toolkits/classes/Toolkits.mdx
- page: Triggers
path: pages/sdk/typescript/models/Triggers/classes/Triggers.mdx
- page: AuthConfigs
path: pages/sdk/typescript/AuthConfigs/classes/AuthConfigs.mdx
- page: ConnectedAccounts
path: pages/sdk/typescript/ConnectedAccounts/classes/ConnectedAccounts.mdx
- page: ConnectionRequest
path: pages/sdk/typescript/ConnectionRequest/classes/ConnectionRequest.mdx
- page: CustomTools
path: pages/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