Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
docs: show auth config for multiple schemes, remove alias from updating section
Dhawal Upadhyaye72f8b7911c7
diff --git a/docs/content/docs/importing-existing-connections.mdx b/docs/content/docs/importing-existing-connections.mdxindex f6d54f26a..cdc1e9e2d 100644--- a/docs/content/docs/importing-existing-connections.mdx+++ b/docs/content/docs/importing-existing-connections.mdx@@ -28,11 +28,7 @@ graph LR## Creating an auth config-Before importing credentials, you need an auth config for the toolkit. This is a one-time setup.--<Callout type="info">-Bearer token auth configs work with **any toolkit that supports OAuth2 or S2S auth** — including Gmail, GitHub, Slack, Google Docs, and more. This lets you import your own access tokens without setting up an OAuth app.-</Callout>+Before importing credentials, you need an auth config for the toolkit. This tells Composio which auth scheme to use. This is a one-time setup per toolkit.<Tabs groupId="language" items={['Python', 'TypeScript', 'curl']} persist><Tab value="Python">@@ -41,6 +37,14 @@ from composio import Composiocomposio = Composio(api_key="your-api-key")+# For API key toolkits (e.g., SendGrid, Tavily)+auth_config = composio.auth_configs.create("sendgrid", {+ "type": "use_custom_auth",+ "authScheme": "API_KEY",+ "credentials": {},+})++# For bearer token — works with any OAuth toolkit (Gmail, GitHub, Slack, etc.)auth_config = composio.auth_configs.create("gmail", {"type": "use_custom_auth","authScheme": "BEARER_TOKEN",@@ -56,6 +60,14 @@ import { Composio } from '@composio/core';const composio = new Composio({ apiKey: 'your-api-key' });+// For API key toolkits (e.g., SendGrid, Tavily)+const authConfig = await composio.authConfigs.create('sendgrid', {+ type: 'use_custom_auth',+ authScheme: 'API_KEY',+ credentials: {},+});++// For bearer token — works with any OAuth toolkit (Gmail, GitHub, Slack, etc.)const authConfig = await composio.authConfigs.create('gmail', {type: 'use_custom_auth',authScheme: 'BEARER_TOKEN',@@ -82,6 +94,10 @@ curl -X POST https://backend.composio.dev/api/v3/auth_configs \</Tab></Tabs>+<Callout type="info">+Bearer token auth configs work with **any toolkit that supports OAuth2 or S2S auth** — including Gmail, GitHub, Slack, Google Docs, and more. This lets you import your own access tokens without setting up an OAuth app.+</Callout>+## API keysFor services that use API key authentication (e.g., SendGrid, Tavily, PostHog):@@ -267,18 +283,6 @@ curl -X PATCH https://backend.composio.dev/api/v3/connected_accounts/ca_xxx \</Tab></Tabs>-You can also update the alias or both at once:--```bash-# Update alias-curl -X PATCH .../api/v3/connected_accounts/ca_xxx \- -d '{"alias": "work-gmail"}'--# Remove a field (set to null)-curl -X PATCH .../api/v3/connected_accounts/ca_xxx \- -d '{"connection":{"state":{"authScheme":"API_KEY","val":{"subdomain":null}}}}'-```-Fields you omit are preserved. Fields set to `null` are removed.## Using with Tool Router