Quickstart

This quickstart gets you from zero to a completed image task using the official JavaScript and TypeScript SDK.

Create an API key

Create a key in the Mynth dashboard.If you work with multiple environments, create separate keys and set a spending limit for each one.

Install the SDK

bun add @mynthio/sdk

pnpm add @mynthio/sdk

npm install @mynthio/sdk

Set your environment variable

bash export MYNTH_API_KEY=mak_your_key_here

Generate an image

import Mynth from "@mynthio/sdk";

const mynth = new Mynth();

const task = await mynth.image.generate({
  prompt: "Editorial product photo of a ceramic mug on a linen tablecloth",
  model: "google/gemini-3.1-flash-image",
});

console.log(task.urls);

By default, generate() waits for completion. The returned task is already a completed task object, so task.urls contains the successful image URLs immediately.

Return immediately with generateAsync

const task = await mynth.image.generateAsync({
  prompt: "A floating garden at sunrise",
  model: "google/gemini-3.1-flash-image",
});

console.log(task.id);
console.log(task.access.publicAccessToken);

generateAsync() returns a TaskAsync. Use it when your server should start work now and your app will poll or wait later.

Set model explicitly in production. model: "auto" is an early preview feature intended for experimentation.

Async and Polling

Learn when to use sync, async, polling, and browser-safe access tokens.

Use Webhooks

Send results to your backend automatically.

Request Reference

See every request field that Mynth accepts.

SDK Tasks

Understand Task, TaskAsync, and polling behavior in detail.

Getting started

Generation

Control and delivery

Image analysis

Integrations

What to read next

Async and Polling

Use Webhooks

Request Reference

SDK Tasks

​What to read next

Async and Polling

Use Webhooks

Request Reference

SDK Tasks

What to read next