Environment Variables

Overview

Composio SDK can be configured using environment variables, allowing you to manage settings across different environments (development, staging, production) without changing code.

Core Environment Variables

COMPOSIO_API_KEY

Your Composio API key for authentication.

COMPOSIO_API_KEY=your_api_key_here

Usage:

import { Composio } from 'composio-core';

// Automatically reads from process.env.COMPOSIO_API_KEY
const composio = new Composio();

// Or explicitly provide it
const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY
});

Never commit your API key to version control. Use a .env file and add it to .gitignore.

COMPOSIO_BASE_URL

Custom API base URL for self-hosted or regional deployments.

COMPOSIO_BASE_URL=https://api.composio.dev

Default: https://backend.composio.dev Usage:

import { Composio } from 'composio-core';

const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY,
  baseUrl: process.env.COMPOSIO_BASE_URL
});

COMPOSIO_LOG_LEVEL

Control the verbosity of SDK logs.

COMPOSIO_LOG_LEVEL=debug

Options: silent, error, warn, info, debug Default: info Usage:

// Logs will automatically use the configured level
const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY
});

// Override programmatically
const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY,
  logLevel: 'debug'
});

Log Level Comparison:

Level	Errors	Warnings	Info	Debug
silent	✗	✗	✗	✗
error	✓	✗	✗	✗
warn	✓	✓	✗	✗
info	✓	✓	✓	✗
debug	✓	✓	✓	✓

COMPOSIO_DISABLE_TELEMETRY

Disable anonymous usage telemetry.

COMPOSIO_DISABLE_TELEMETRY=true

Options: true, false Default: false Usage:

const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY,
  disableTelemetry: process.env.COMPOSIO_DISABLE_TELEMETRY === 'true'
});

Toolkit Version Variables

Set specific versions for toolkits to ensure consistent behavior across deployments.

Format

COMPOSIO_TOOLKIT_VERSION_<TOOLKIT_SLUG>=<version>

Examples

# Pin GitHub toolkit to specific version
COMPOSIO_TOOLKIT_VERSION_GITHUB=20250909_00

# Pin Slack toolkit
COMPOSIO_TOOLKIT_VERSION_SLACK=20250801_00

# Pin Gmail toolkit
COMPOSIO_TOOLKIT_VERSION_GMAIL=20250715_00

Usage

import { Composio } from 'composio-core';

// Toolkit versions are automatically read from environment
const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY
  // toolkitVersions are automatically loaded from COMPOSIO_TOOLKIT_VERSION_* vars
});

// Execute tools with automatic version from environment
const result = await composio.tools.execute('GITHUB_GET_REPOS', {
  userId: 'user_123',
  // Version automatically uses COMPOSIO_TOOLKIT_VERSION_GITHUB
  arguments: { owner: 'composio' }
});

Override in Code

// Override environment variables with explicit config
const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY,
  toolkitVersions: {
    github: '20250909_00',  // Overrides COMPOSIO_TOOLKIT_VERSION_GITHUB
    slack: '20250801_00'     // Overrides COMPOSIO_TOOLKIT_VERSION_SLACK
  }
});

Development vs Production

Development Environment

# .env.development
COMPOSIO_API_KEY=your_dev_api_key
COMPOSIO_BASE_URL=https://backend.composio.dev
COMPOSIO_LOG_LEVEL=debug
COMPOSIO_DISABLE_TELEMETRY=true
COMPOSIO_TOOLKIT_VERSION_GITHUB=latest

Production Environment

# .env.production
COMPOSIO_API_KEY=your_prod_api_key
COMPOSIO_BASE_URL=https://backend.composio.dev
COMPOSIO_LOG_LEVEL=error
COMPOSIO_DISABLE_TELEMETRY=false
COMPOSIO_TOOLKIT_VERSION_GITHUB=20250909_00
COMPOSIO_TOOLKIT_VERSION_SLACK=20250801_00

Loading Environment Variables

Using dotenv (Node.js)

npm install dotenv

// Load as early as possible in your app
import 'dotenv/config';
import { Composio } from 'composio-core';

const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY
});

Multiple Environment Files

import { config } from 'dotenv';
import path from 'path';

// Load environment-specific file
const env = process.env.NODE_ENV || 'development';
config({ path: path.resolve(process.cwd(), `.env.${env}`) });

import { Composio } from 'composio-core';

const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY
});

Vercel/Next.js

// next.config.js
module.exports = {
  env: {
    COMPOSIO_API_KEY: process.env.COMPOSIO_API_KEY,
    COMPOSIO_BASE_URL: process.env.COMPOSIO_BASE_URL,
  }
};

// In your Next.js app
import { Composio } from 'composio-core';

const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY
});

Docker

# Dockerfile
FROM node:18

# Environment variables
ENV COMPOSIO_LOG_LEVEL=info
ENV COMPOSIO_DISABLE_TELEMETRY=false

WORKDIR /app
COPY . .
RUN npm install

CMD ["npm", "start"]

# docker-compose.yml
version: '3.8'
services:
  app:
    build: .
    environment:
      - COMPOSIO_API_KEY=${COMPOSIO_API_KEY}
      - COMPOSIO_BASE_URL=${COMPOSIO_BASE_URL}
      - COMPOSIO_LOG_LEVEL=debug
      - COMPOSIO_TOOLKIT_VERSION_GITHUB=20250909_00
    env_file:
      - .env.production

Kubernetes

# deployment.yaml
apiVersion: v1
kind: Secret
metadata:
  name: composio-secrets
type: Opaque
stringData:
  api-key: your_api_key_here
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app
spec:
  template:
    spec:
      containers:
      - name: app
        image: my-app:latest
        env:
        - name: COMPOSIO_API_KEY
          valueFrom:
            secretKeyRef:
              name: composio-secrets
              key: api-key
        - name: COMPOSIO_LOG_LEVEL
          value: "info"
        - name: COMPOSIO_TOOLKIT_VERSION_GITHUB
          value: "20250909_00"

Environment Variable Validation

Validate required environment variables at startup:

function validateEnvironment() {
  const required = ['COMPOSIO_API_KEY'];
  const missing = required.filter(key => !process.env[key]);
  
  if (missing.length > 0) {
    throw new Error(
      `Missing required environment variables: ${missing.join(', ')}`
    );
  }
  
  // Validate log level
  const validLogLevels = ['silent', 'error', 'warn', 'info', 'debug'];
  const logLevel = process.env.COMPOSIO_LOG_LEVEL;
  if (logLevel && !validLogLevels.includes(logLevel)) {
    throw new Error(
      `Invalid COMPOSIO_LOG_LEVEL: ${logLevel}. Must be one of: ${validLogLevels.join(', ')}`
    );
  }
}

// Call before initializing SDK
validateEnvironment();

const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY!
});

Type-Safe Environment Variables

Use TypeScript for type safety:

// env.d.ts
declare global {
  namespace NodeJS {
    interface ProcessEnv {
      COMPOSIO_API_KEY: string;
      COMPOSIO_BASE_URL?: string;
      COMPOSIO_LOG_LEVEL?: 'silent' | 'error' | 'warn' | 'info' | 'debug';
      COMPOSIO_DISABLE_TELEMETRY?: 'true' | 'false';
      COMPOSIO_TOOLKIT_VERSION_GITHUB?: string;
      COMPOSIO_TOOLKIT_VERSION_SLACK?: string;
      NODE_ENV: 'development' | 'production' | 'test';
    }
  }
}

export {};

// Now TypeScript will enforce types
const composio = new Composio({
  apiKey: process.env.COMPOSIO_API_KEY, // Type: string
  logLevel: process.env.COMPOSIO_LOG_LEVEL // Type: 'silent' | 'error' | 'warn' | 'info' | 'debug'
});

Environment Configuration Helper

// config.ts
import { z } from 'zod';

const envSchema = z.object({
  COMPOSIO_API_KEY: z.string().min(1, 'COMPOSIO_API_KEY is required'),
  COMPOSIO_BASE_URL: z.string().url().optional(),
  COMPOSIO_LOG_LEVEL: z.enum(['silent', 'error', 'warn', 'info', 'debug']).optional(),
  COMPOSIO_DISABLE_TELEMETRY: z.enum(['true', 'false']).optional(),
  NODE_ENV: z.enum(['development', 'production', 'test']).default('development')
});

export const env = envSchema.parse(process.env);

export function getComposioConfig() {
  return {
    apiKey: env.COMPOSIO_API_KEY,
    baseUrl: env.COMPOSIO_BASE_URL,
    logLevel: env.COMPOSIO_LOG_LEVEL,
    disableTelemetry: env.COMPOSIO_DISABLE_TELEMETRY === 'true'
  };
}

// app.ts
import { Composio } from 'composio-core';
import { getComposioConfig } from './config';

const composio = new Composio(getComposioConfig());

Best Practices

Never Commit Secrets

Add .env files to .gitignore and use secret management for production.

Use Specific Versions

Pin toolkit versions in production to prevent breaking changes.

Validate Early

Validate environment variables at application startup to fail fast.

Document Variables

Maintain a .env.example file documenting all environment variables.

Example .env.example

# .env.example - Copy to .env and fill in your values

# Required: Your Composio API key
COMPOSIO_API_KEY=

# Optional: Custom API base URL (defaults to https://backend.composio.dev)
# COMPOSIO_BASE_URL=https://backend.composio.dev

# Optional: Log level (silent, error, warn, info, debug)
# COMPOSIO_LOG_LEVEL=info

# Optional: Disable telemetry (true or false)
# COMPOSIO_DISABLE_TELEMETRY=false

# Optional: Toolkit versions (format: COMPOSIO_TOOLKIT_VERSION_<TOOLKIT_SLUG>=<version>)
# COMPOSIO_TOOLKIT_VERSION_GITHUB=20250909_00
# COMPOSIO_TOOLKIT_VERSION_SLACK=20250801_00
# COMPOSIO_TOOLKIT_VERSION_GMAIL=20250715_00

# Application environment
# NODE_ENV=development

Troubleshooting

Variables Not Loading

// Debug environment variables
console.log('Environment variables:', {
  COMPOSIO_API_KEY: process.env.COMPOSIO_API_KEY ? '[SET]' : '[NOT SET]',
  COMPOSIO_BASE_URL: process.env.COMPOSIO_BASE_URL || '[DEFAULT]',
  COMPOSIO_LOG_LEVEL: process.env.COMPOSIO_LOG_LEVEL || '[DEFAULT]',
  NODE_ENV: process.env.NODE_ENV
});

// Ensure dotenv is loaded before importing Composio
import 'dotenv/config';
import { Composio } from 'composio-core';

Version Not Applied

# Ensure environment variable name matches toolkit slug in uppercase
COMPOSIO_TOOLKIT_VERSION_GITHUB=20250909_00  # Correct
COMPOSIO_TOOLKIT_VERSION_github=20250909_00  # Wrong - won't work

Precedence Order

Configuration precedence (highest to lowest):

Explicitly passed to SDK constructor
Environment variables
SDK defaults

// Explicit config overrides environment
const composio = new Composio({
  apiKey: 'explicit_key', // Overrides COMPOSIO_API_KEY env var
  toolkitVersions: {
    github: '20250909_00' // Overrides COMPOSIO_TOOLKIT_VERSION_GITHUB
  }
});

Next Steps

Tool Execution

Use configured toolkit versions in tool execution

Error Handling

Configure error logging levels

Authentication Flows

Set up authentication with environment-based configuration

Custom Tools

Create custom tools with environment-aware settings

Get Started

Core Concepts

Installation

Guides

MCP & Rube

​Overview

​Core Environment Variables

​COMPOSIO_API_KEY

​COMPOSIO_BASE_URL

​COMPOSIO_LOG_LEVEL

​COMPOSIO_DISABLE_TELEMETRY

​Toolkit Version Variables

​Format

​Examples

​Usage

​Override in Code

​Development vs Production

​Development Environment

​Production Environment

​Loading Environment Variables

​Using dotenv (Node.js)

​Multiple Environment Files

​Vercel/Next.js

​Docker

​Kubernetes

​Environment Variable Validation

​Type-Safe Environment Variables

​Environment Configuration Helper

​Best Practices

Never Commit Secrets

Use Specific Versions

Validate Early

Document Variables

​Example .env.example

​Troubleshooting

​Variables Not Loading

​Version Not Applied

​Precedence Order

​Next Steps

Tool Execution

Error Handling

Authentication Flows

Custom Tools

Build docs developers (and LLMs) love

Overview

Core Environment Variables

COMPOSIO_API_KEY

COMPOSIO_BASE_URL

COMPOSIO_LOG_LEVEL

COMPOSIO_DISABLE_TELEMETRY

Toolkit Version Variables

Format

Examples

Usage

Override in Code

Development vs Production

Development Environment

Production Environment

Loading Environment Variables

Using dotenv (Node.js)

Multiple Environment Files

Vercel/Next.js

Docker

Kubernetes

Environment Variable Validation

Type-Safe Environment Variables

Environment Configuration Helper

Best Practices

Example .env.example

Troubleshooting

Variables Not Loading

Version Not Applied

Precedence Order

Next Steps