Installation

Install the Platform SDK with npm or yarn and configure TypeScript for type-safe API access.

The Platform SDK is a TypeScript-first package distributed via npm. It ships ESM and CJS builds with full type declarations and requires Node.js 20 or higher.

Requirements

• Node.js 20 or higher
• npm, yarn, or pnpm
• TypeScript 5+ (recommended)

Install from npm

npm install @amigo-ai/platform-sdk

Or with yarn or pnpm:

yarn add @amigo-ai/platform-sdk
pnpm add @amigo-ai/platform-sdk

TypeScript Configuration

If you are using TypeScript, ensure your tsconfig.json targets ES2022 or later:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}

The SDK ships both ESM and CJS bundles with full .d.ts declaration files, so no additional type packages are required.

Verify Installation

import { AmigoClient } from '@amigo-ai/platform-sdk'
console.log('Platform SDK installed successfully!')

Environment Variables

Create a .env file in your project root with your credentials:

AMIGO_API_KEY=your-api-key
AMIGO_WORKSPACE_ID=your-workspace-id

Install dotenv to load them automatically:

npm install dotenv

Then in your application:

import 'dotenv/config'
import { AmigoClient } from '@amigo-ai/platform-sdk'

const client = new AmigoClient({
  apiKey: process.env.AMIGO_API_KEY!,
  workspaceId: process.env.AMIGO_WORKSPACE_ID!,
})

Next Steps

• Configuration. Full configuration reference and credential setup.
• Quickstart. Make your first API call.