De Mage TypeScript SDK

In één oogopslag

De Mage TypeScript SDK is de officiële open-sourceclient voor de Mage API, gepubliceerd als @mage-space/sdk. Installeer hem met "npm install @mage-space/sdk", stel MAGE_API_KEY in en roep mage.run aan met een model-id en een config om kant-en-klare afbeeldingen, video of audio te krijgen van een van de 28 modellen. Hij draait op Node.js 20.19 of nieuwer, of op elke serverruntime met fetch, en elke generatie wordt betaald in Gems.

• 20.19+

  Node.js

• 0

  Runtime-afhankelijkheden

• 28

  Getypeerde modellen

• MIT

  Open source

Instellen

Installeer de TypeScript SDK en draai een model

1. 01

   Installeer het pakket

   Voeg @mage-space/sdk toe aan je project.

   npm install @mage-space/sdk

2. 02

   Stel je API-sleutel in

   Maak een sleutel aan via API → API Keys op mage.space en exporteer die. De client leest MAGE_API_KEY.

   export MAGE_API_KEY="mage_sk_..."

3. 03

   Genereer

   Roep run aan met een model-id en de bijbehorende config. De functie wacht op het resultaat en geeft het terug; de output staat in 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);

Voorbeelden

De TypeScript SDK in de praktijk

Elk voorbeeld begint met een client die MAGE_API_KEY leest.

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;
  }
}

Waarom de SDK

Wat de SDK voor je regelt

Referentie

De TypeScript SDK in één oogopslag

Dezelfde methoden gelden voor elk model; het model is het eerste argument.

Modellen

Begin met deze modellen

FAQ

Veelgestelde vragen

Begin met bouwen met Mage

Eén account, één Gems-saldo, alle modellen. Je betaalt alleen voor wat je genereert.

Gerelateerd

• Mage SDK's
• Mage Python SDK
• Mage voor ComfyUI
• @mage-space/sdk op npm
• Alle API-modellen
• API-documentatie