JS/TS SDK Overview - Mynth - Documentation | mynth.io

The official SDK package is @mynthio/sdk. It is the easiest way to integrate Mynth from JavaScript or TypeScript applications.

What the SDK gives you

a typed Mynth client
sync and async generation, rating, and alt text flows
ImageGenerationResult, ImageRateResult, ImageAltResult, and TaskAsync abstractions
built-in polling for async tasks
exported runtime model metadata through AVAILABLE_MODELS
webhook helpers for Convex, Next.js, and TanStack Start

Installation

bun add @mynthio/sdk

pnpm add @mynthio/sdk

npm install @mynthio/sdk

Typical server-side use

generate() runs synchronously and resolves once the task is complete, returning an ImageGenerationResult:

import Mynth from "@mynthio/sdk";

const mynth = new Mynth();

const result = await mynth.image.generate({
  prompt: "A premium e-commerce hero image for a leather backpack",
  model: "google/gemini-3.1-flash-image",
});

console.log(result.urls);

Typical async use

generateAsync() starts generation and returns a TaskAsync immediately, so your server can respond fast and poll or wait later:

const task = await mynth.image.generateAsync({
  prompt: "A premium e-commerce hero image for a leather backpack",
  model: "google/gemini-3.1-flash-image",
});

return {
  id: task.id,
  access: task.access,
};

When to use the SDK

Prefer the SDK when you want:

strong TypeScript support
less boilerplate for polling
consistent task handling
first-class helpers for mynth.image.generate, mynth.image.rate, and mynth.image.alt

Use the raw API when you need another language or total transport-level control.