Type-safe SDK for 150+ API endpoints

Install

Add the SDK to your project with npm, pnpm, or yarn. Requires Node.js 20+.

npm install @botoi/sdk

Quick start

Import the SDK, pass your API key, and make your first call. Three lines to a working screenshot.

import Botoi from '@botoi/sdk';

const botoi = new Botoi({ apiKey: process.env.BOTOI_API_KEY });

const result = await botoi.screenshot.capture({
  url: 'https://example.com',
  width: 1280,
  height: 720,
});
// Returns a Response object for binary data
const buffer = await result.arrayBuffer();

Examples

Five real-world patterns covering binary responses, compliance checks, schema generation, and more.

const screenshot = await botoi.screenshot.capture({
  url: 'https://github.com',
  width: 1280,
  height: 720,
});

const buffer = await screenshot.arrayBuffer();
fs.writeFileSync('screenshot.png', Buffer.from(buffer));

const pii = await botoi.pii.detect({
  text: 'Contact John at john@example.com or 555-0123',
});

console.log(pii.entities);
// [{ type: 'EMAIL', value: 'john@example.com', start: 16, end: 32 },
//  { type: 'PHONE', value: '555-0123', start: 36, end: 44 }]

const zod = await botoi.schema.jsonToZod({
  json: { name: 'Ada', age: 36, admin: true },
});

console.log(zod.schema);
// z.object({ name: z.string(), age: z.number(), admin: z.boolean() })

const tech = await botoi.techDetect.detect({
  url: 'https://stripe.com',
});

console.log(tech.technologies);
// [{ name: 'React', category: 'JavaScript frameworks' },
//  { name: 'Next.js', category: 'Web frameworks' },
//  { name: 'Vercel', category: 'PaaS' }]

const qr = await botoi.qr.generate({
  text: 'https://botoi.com',
  size: 400,
});

const svg = await qr.text();
fs.writeFileSync('qr.svg', svg);

Error handling

The SDK exports typed error classes so you can handle rate limits, auth failures, and API errors with precision.

import Botoi, { BotoiError, BotoiRateLimitError } from '@botoi/sdk';

const botoi = new Botoi({ apiKey: process.env.BOTOI_API_KEY });

try {
  const result = await botoi.email.validate({ email: 'test@example.com' });
} catch (err) {
  if (err instanceof BotoiRateLimitError) {
    console.log(`Rate limited. Retry after ${err.retryAfter}s`);
  } else if (err instanceof BotoiError) {
    console.log(`API error: ${err.message} (code: ${err.code})`);
  }
}

Configuration

Customize the SDK behavior with these constructor options. All fields are optional if the BOTOI_API_KEY environment variable is set.

const botoi = new Botoi({
  apiKey: process.env.BOTOI_API_KEY,
  baseUrl: 'https://api.botoi.com',  // default
  maxRetries: 3,                      // default
  timeout: 30000,                     // 30s default
});

// Or use environment variable (auto-detected)
// BOTOI_API_KEY=your_key node app.js
const botoi = new Botoi();

Built for production

Everything you need from an API client, nothing you don't.

Related resources

Other ways to use the Botoi API.

Frequently asked questions