SDK TypeScript Mage

Sekilas info

SDK TypeScript Mage adalah klien resmi open source untuk Mage API, dipublikasikan sebagai @mage-space/sdk. Pasang dengan "npm install @mage-space/sdk", atur MAGE_API_KEY, lalu panggil mage.run dengan id model dan konfigurasi untuk mendapatkan gambar, video, atau audio jadi dari salah satu dari 28 model. SDK ini berjalan di Node.js 20.19 atau lebih baru, atau runtime server apa pun dengan fetch, dan setiap generasi dibayar dengan Gems.

• 20.19+

  Node.js

• 0

  Dependensi runtime

• 28

  Model bertipe

• MIT

  Open source

Penyiapan

Pasang SDK TypeScript dan jalankan model

1. 01

   Pasang paketnya

   Tambahkan @mage-space/sdk ke proyekmu.

   npm install @mage-space/sdk

2. 02

   Atur API key-mu

   Buat kunci di API → API Keys di mage.space, lalu ekspor. Klien membaca MAGE_API_KEY.

   export MAGE_API_KEY="mage_sk_..."

3. 03

   Buat

   Panggil run dengan id model dan konfigurasinya. Fungsi ini menunggu hasilnya dan mengembalikannya; keluarannya ada di 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);

Contoh

SDK TypeScript dalam praktik

Setiap contoh dimulai dari klien yang membaca 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;
  }
}

Kenapa SDK

Yang diurus SDK untukmu

Referensi

Sekilas SDK TypeScript

Metode yang sama berlaku untuk semua model; modelnya menjadi argumen pertama.

Model

Mulai dengan model-model ini

FAQ

Pertanyaan yang sering diajukan

Mulai berkarya dengan Mage

Satu akun, satu saldo Gems, semua model. Bayar hanya untuk yang kamu buat.

Terkait

• SDK Mage
• SDK Python Mage
• Mage untuk ComfyUI
• @mage-space/sdk di npm
• Semua model API
• Dokumentasi API