O SDK TypeScript do Mage

Resumo rápido

O SDK TypeScript do Mage é o cliente oficial e de código aberto da API do Mage, publicado como @mage-space/sdk. Instale com "npm install @mage-space/sdk", defina MAGE_API_KEY e chame mage.run com o id de um modelo e uma configuração para obter imagens, vídeos ou áudio prontos de qualquer um dos 28 modelos. Ele roda no Node.js 20.19 ou superior, ou em qualquer runtime de servidor com fetch, e toda geração é paga em Gems.

• 20.19+

  Node.js

• 0

  Dependências de runtime

• 28

  Modelos tipados

• MIT

  Código aberto

Configuração

Instale o SDK TypeScript e rode um modelo

1. 01

   Instale o pacote

   Adicione @mage-space/sdk ao seu projeto.

   npm install @mage-space/sdk

2. 02

   Defina sua chave de API

   Crie uma chave em API → API Keys em mage.space e exporte-a. O cliente lê MAGE_API_KEY.

   export MAGE_API_KEY="mage_sk_..."

3. 03

   Gere

   Chame run com o id de um modelo e sua configuração. Ele espera o resultado e o retorna; a saída fica em 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);

Exemplos

O SDK TypeScript na prática

Cada exemplo parte de um cliente que lê 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;
  }
}

Por que usar o SDK

O que o SDK resolve para você

Referência

O SDK TypeScript em resumo

Os mesmos métodos servem para todos os modelos; o modelo é o primeiro argumento.

Modelos

Comece com estes modelos

Perguntas frequentes

Perguntas frequentes

Comece a criar com o Mage

Uma conta, um saldo de Gems, todos os modelos. Pague apenas pelo que você gerar.

Relacionados

• SDKs do Mage
• SDK Python do Mage
• Mage para ComfyUI
• @mage-space/sdk no npm
• Todos os modelos da API
• Documentação da API