npm install @optimocms/sdk

yarn add @optimocms/sdk
pnpm add @optimocms/sdk

// ESM (recommended)
import { OptimoCMS } from '@optimocms/sdk';

// CommonJS
const { OptimoCMS } = require('@optimocms/sdk');

import { OptimoCMS } from '@optimocms/sdk';

const cms = new OptimoCMS({
  apiKey: process.env.OPTIMOCMS_API_KEY!,
});

const cms = new OptimoCMS({
  apiKey: process.env.OPTIMOCMS_API_KEY!,

  // Base URL (default: https://api.optimocms.com)
  baseUrl: 'https://api.optimocms.com',

  // Request timeout in ms (default: 30000)
  timeout: 30_000,

  // Automatic retry on 429/5xx (default: 3)
  maxRetries: 3,
});

// Backend (Node.js) — /api/sites.ts
import { OptimoCMS } from '@optimocms/sdk';

const cms = new OptimoCMS({ apiKey: process.env.OPTIMOCMS_API_KEY! });

export async function GET() {
  const sites = await cms.sites.list();
  return Response.json(sites);
}

// Frontend (browser)
const response = await fetch('/api/sites');
const sites = await response.json();

cms.sites       // Manage sites
cms.pages       // Page CRUD
cms.media       // Upload and manage media
cms.analytics   // Retrieve analytics
cms.ai          // AI generation and translation
cms.booking     // Bookings
cms.reservation // Reservations
cms.shop        // Products, orders, coupons
cms.loyalty     // Loyalty points
cms.webhooks    // Webhook configuration
cms.forms       // Form submissions
cms.push        // Push notifications
cms.reviews     // Reviews
cms.recruitment // Job listings
cms.batch       // Bulk operations
cms.jobs        // Async job polling
cms.domains     // Domain registration and management
cms.mail        // Mailboxes and DNS records
cms.seo         // SEO configuration and design tokens
cms.chatbot     // Chatbot configuration

import type {
  Site,
  SiteSummary,
  Page,
  PageDetail,
  PageSummary,
  CreatePageInput,
  UpdatePageInput,
  MediaItem,
  AnalyticsSummary,
  Product,
  Booking,
  OptimoCMSError,
  PaginatedResponse,
} from '@optimocms/sdk';

# The SDK hides these details, but this is what happens under the hood
curl https://api.optimocms.com/v1/sites \
  -H "X-Api-Key: optimo_live_abc123def456"

Use the list_sites tool.

const result = await cms.ai.generatePage('site_abc123', {
  prompt: 'Landing page for a bakery in Amsterdam',
  language: 'en',
  style: 'minimalist',
  useHeroVideo: true,
  videoModelId: 'seedance-fast', // optional: seedance-fast | seedance-standard | kling-standard
});

console.log(result.jobId);
console.log(result.heroVideoGenerated); // true if video was successfully generated

const result = await cms.ai.generateSite({
  name: 'The Golden Oven Bakery',
  prompt: 'A modern website for an artisan bakery',
  language: 'en',
  useHeroVideo: true,
  videoModelId: 'seedance-standard', // 2 credits, maximum quality
});

console.log(result.siteId);
console.log(result.heroVideoGenerated); // true if video was successfully generated
console.log(result.videoModel);         // 'seedance-standard'
console.log(result.videoCreditsUsed);   // 2

const result = await cms.domains.checkAvailability('bakery-amsterdam.nl');

console.log(result.available);    // true
console.log(result.priceCents);   // 999 (€9.99)
console.log(result.freeWithPlan); // true if free with current plan

const domain = await cms.domains.register({
  domain: 'bakery-amsterdam.nl',
  siteId: 'site_abc123',
  registrant: {
    firstName: 'John',
    lastName: 'Smith',
    email: 'john@example.com',
    phone: '+31612345678',
    address: 'Keizersgracht 1',
    city: 'Amsterdam',
    postalCode: '1015AA',
    country: 'NL',
  },
});

console.log(domain.status);      // 'registered'
console.log(domain.nameservers); // ['ns1.cloudflare.com', ...]

const domains = await cms.domains.list();

for await (const domain of domains) {
  console.log(domain.domain, domain.status, domain.expiresAt);
}

const mailbox = await cms.mail.createMailbox('site_abc123', {
  localPart: 'info',
  displayName: 'Info Bakery',
});

console.log(mailbox.email);    // 'info@bakery-amsterdam.nl'
console.log(mailbox.password); // one-time password — store it securely!
console.log(mailbox.imapHost); // IMAP server
console.log(mailbox.smtpHost); // SMTP server

const mailboxes = await cms.mail.list('site_abc123');

for await (const mb of mailboxes) {
  console.log(mb.email, mb.active, mb.storageMb);
}

const records = await cms.mail.getDnsRecords('site_abc123');

for (const record of records) {
  console.log(record.type, record.name, record.value, record.status);
}

await cms.seo.updateSiteSeo('site_abc123', {
  siteTitle: 'Amsterdam Bakery — Fresh pastries every day',
  siteDescription: 'The best bakery in Amsterdam. Order online or visit us.',
  ogImage: 'https://cdn.example.com/og-bakery.jpg',
  robotsDirective: 'index,follow',
});

await cms.seo.updatePageSeo('site_abc123', 'page_xyz789', {
  title: 'Sandwiches — Amsterdam Bakery',
  description: 'Discover our selection of fresh sandwiches.',
  canonicalUrl: 'https://bakery-amsterdam.nl/sandwiches',
});

await cms.seo.updateDesignTokens('site_abc123', {
  colorPrimary: '#ff6600',
  fontHeading: 'Inter',
  radiusCard: '16px',
});

await cms.push.sendCampaign('site_abc123', {
  title: 'Summer Sale 20%!',
  body: 'Order today and get 20% off everything.',
  url: 'https://bakery-amsterdam.nl/deals',
});

const webhook = await cms.webhooks.create('site_abc123', {
  url: 'https://my-crm.com/hook',
  events: ['order.created', 'booking.created'],
  secret: 'my-secret-token',
});

console.log(webhook.id);     // webhook ID
console.log(webhook.events); // ['order.created', 'booking.created']

const webhooks = await cms.webhooks.list('site_abc123');

for await (const wh of webhooks) {
  console.log(wh.id, wh.url, wh.events);
}

await cms.chatbot.configure('site_abc123', {
  enabled: true,
  greeting: 'Hello! How can I help you?',
  primaryColor: '#2563eb',
  language: 'en',
});

const config = await cms.chatbot.getConfig('site_abc123');

console.log(config.enabled);      // true
console.log(config.greeting);     // 'Hello! How can I help you?'
console.log(config.primaryColor); // '#2563eb'
console.log(config.language);     // 'en'