TypeScript SDK

The Echo TypeScript SDK is the foundational SDK that provides direct API access to the Echo platform. It serves as the base for the React and Next.js SDKs, offering maximum flexibility for server-side applications, CLI tools, and custom integrations.

Use Cases

Server-side applications - API routes, backends, microservices
CLI tools - Command-line applications with AI billing
Custom integrations - When you need direct platform control
Foundation for other SDKs - React and Next.js SDKs are built on this

Installation

npm install @merit-systems/echo-typescript-sdk

pnpm add @merit-systems/echo-typescript-sdk

yarn add @merit-systems/echo-typescript-sdk

bun add @merit-systems/echo-typescript-sdk

Quick Start

Platform Operations

import { EchoClient } from '@merit-systems/echo-typescript-sdk';

const echo = new EchoClient({
  apiKey: 'your-api-key'
});

// Check balance and create payment links
const balance = await echo.balance.getBalance();
const paymentLink = await echo.payments.createPaymentLink({
  amount: 10,
  description: 'Credits'
});

AI Integration

import { createEchoOpenAI } from '@merit-systems/echo-typescript-sdk';
import { generateText } from 'ai';

// Create AI provider with Echo billing
const openai = createEchoOpenAI(
  { appId: 'your-echo-app-id' },
  async () => 'your-api-key'
);

// Generate text with automatic billing
const { text } = await generateText({
  model: openai('gpt-4'),
  prompt: 'Hello world'
});

Documentation Sections

Client - EchoClient setup, configuration, and environment management
Authentication - API keys, token providers, and OAuth integration patterns
Resources - Platform operations: apps, balance, payments, users, models

Architecture

The TypeScript SDK consists of two main components:

Platform Client - EchoClient for account, billing, and app management
AI Providers - Factory functions that create Vercel AI SDK compatible providers with Echo billing

This separation allows you to use platform operations independently or combine them with AI functionality as needed.

Overview