View as Markdown

Installation

Install the Integrate SDK in your project

Install the Integrate SDK using your preferred package manager.

bun (Recommended)
bun add integrate-sdk
npm
npm install integrate-sdk
pnpm
pnpm add integrate-sdk
yarn
yarn add integrate-sdk

TypeScript Support

The SDK is built with TypeScript and includes type definitions out of the box. No additional @types packages are needed.

Requirements

  • Node.js 20.9+ or newer
  • TypeScript 5.6+ (for TypeScript projects)
  • integrate-sdk 0.10.0+ (Google integrations use google_* ids; see migration note below)

Google integration ids (v0.10.0+)

In 0.10.0, short Google integration ids were renamed to google_* for consistency with blob assets and docs URLs. gmail is unchanged.

Before (≤0.9.x)Now (0.10.0+)
gcalgoogle_calendar
gchatgoogle_chat
gcontactsgoogle_contacts
gdocsgoogle_docs
gdrivegoogle_drive
gkeepgoogle_keep
gmeetgoogle_meet
gsheetsgoogle_sheets
gslidesgoogle_slides
gtasksgoogle_tasks
ga4google_analytics

Update integration factories (googleCalendarIntegration()), client namespaces (client.google_calendar), env vars (GOOGLE_CALENDAR_CLIENT_ID), and tool names (google_calendar_list_events) when upgrading.

Examples

Browse runnable projects for frameworks, database adapters, and AI SDKs in the Integrate examples repository. Frontend and database examples use Next.js by default; backend examples cover Express, Hono, Fastify, and more.

Next Steps

Now that you have the SDK installed, check out the Basic Usage guide to create your first integration.