Mage TypeScript SDK

Главное

Mage TypeScript SDK — официальный клиент с открытым исходным кодом для Mage API, опубликованный как @mage-space/sdk. Установите его командой "npm install @mage-space/sdk", задайте MAGE_API_KEY и вызовите mage.run с id модели и конфигурацией, чтобы получить готовые изображения, видео или аудио от любой из 28 моделей. SDK работает на Node.js 20.19 и новее или в любой серверной среде с fetch, а каждая генерация оплачивается в Gems.

• 20.19+

  Node.js

• 0

  Зависимости времени выполнения

• 28

  Типизированные модели

• MIT

  Открытый код

Настройка

Установите TypeScript SDK и запустите модель

1. 01

   Установите пакет

   Добавьте @mage-space/sdk в свой проект.

   npm install @mage-space/sdk

2. 02

   Задайте API-ключ

   Создайте ключ в разделе API → API Keys на mage.space и экспортируйте его. Клиент читает переменную MAGE_API_KEY.

   export MAGE_API_KEY="mage_sk_..."

3. 03

   Сгенерируйте

   Вызовите run с id модели и её конфигурацией. Метод дождётся результата и вернёт его; файл доступен по адресу result.url.

   import Mage from '@mage-space/sdk';
   
   const mage = new Mage(); // reads MAGE_API_KEY
   
   const request = await mage.run('mango', {
     prompt: 'Editorial portrait in soft daylight, 35mm film look',
     aspect_ratio: '4:5',
     model_id: 'mango-v3',
   });
   
   console.log(request.result.url);

Примеры

TypeScript SDK на практике

Каждый пример начинается с клиента, который читает MAGE_API_KEY.

import Mage from '@mage-space/sdk';

const mage = new Mage(); // reads MAGE_API_KEY

const submitted = await mage.generate('cherry', {
  prompt: 'Waves rolling onto a black sand beach at sunset',
  resolution: '720p',
  duration: '5',
});

const final = await mage.requests.wait(submitted.request_id, {
  timeout: 15 * 60_000,
  onUpdate: (request) => console.log(request.status),
});

import { readFile } from 'node:fs/promises';
import Mage from '@mage-space/sdk';

const mage = new Mage(); // reads MAGE_API_KEY

const clip = await mage.uploads.upload(await readFile('clip.mp4'), {
  contentType: 'video/mp4',
});

await mage.run('cherry', {
  prompt: 'Restyle this clip as a watercolor painting',
  videos: [clip.url],
});

import Mage from '@mage-space/sdk';

const mage = new Mage(); // reads MAGE_API_KEY

await mage.characters.create({
  name: 'Ana',
  handle: 'ana',
  image: 'https://example.com/ana.png',
});

await mage.run('mango', { prompt: '@ana walking through a night market' });

import Mage, { MageAPIError, MageGenerationError } from '@mage-space/sdk';

const mage = new Mage(); // reads MAGE_API_KEY

try {
  await mage.run('mango', { prompt: 'A lighthouse at night' });
} catch (error) {
  if (error instanceof MageAPIError && error.code === 'insufficient_gems') {
    // Top up Gems, then try again.
  } else if (error instanceof MageGenerationError) {
    console.log('No output:', error.code);
  } else {
    throw error;
  }
}

Зачем нужен SDK

Что SDK делает за вас

Справочник

TypeScript SDK кратко

Одни и те же методы работают для всех моделей; модель передаётся первым аргументом.

Модели

Начните с этих моделей

FAQ

Частые вопросы

Начните создавать с Mage

Один аккаунт, один баланс Gems, все модели. Платите только за то, что генерируете.

Похожие материалы

• SDK Mage
• Mage Python SDK
• Mage для ComfyUI
• @mage-space/sdk на npm
• Все модели API
• Документация API