SDK TypeScript của Mage

Xem nhanh

SDK TypeScript của Mage là ứng dụng khách chính thức, mã nguồn mở cho API Mage, được phát hành với tên @mage-space/sdk. Cài đặt bằng "npm install @mage-space/sdk", đặt MAGE_API_KEY, rồi gọi mage.run với id mô hình và một cấu hình để nhận ảnh, video hoặc âm thanh hoàn chỉnh từ bất kỳ mô hình nào trong 28 mô hình. SDK chạy trên Node.js 20.19 trở lên, hoặc bất kỳ môi trường chạy phía máy chủ nào có fetch, và mọi lượt tạo đều được trả bằng Gems.

• 20.19+

  Node.js

• 0

  Phụ thuộc lúc chạy

• 28

  Mô hình có định kiểu

• MIT

  Mã nguồn mở

Thiết lập

Cài SDK TypeScript và chạy một mô hình

1. 01

   Cài đặt gói

   Thêm @mage-space/sdk vào dự án của bạn.

   npm install @mage-space/sdk

2. 02

   Đặt khóa API

   Tạo khóa tại API → API Keys trên mage.space rồi export khóa đó. Ứng dụng khách sẽ đọc MAGE_API_KEY.

   export MAGE_API_KEY="mage_sk_..."

3. 03

   Tạo

   Gọi run với id mô hình và cấu hình của nó. Lệnh sẽ chờ kết quả rồi trả về; đầu ra nằm ở 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);

Ví dụ

SDK TypeScript trong thực tế

Mỗi ví dụ đều bắt đầu từ một ứng dụng khách đọc 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;
  }
}

Vì sao nên dùng SDK

Những việc SDK làm giúp bạn

Tham khảo

SDK TypeScript trong một cái nhìn

Cùng một bộ phương thức dùng cho mọi mô hình; mô hình là đối số đầu tiên.

Mô hình

Bắt đầu với các mô hình này

FAQ

Câu hỏi thường gặp

Bắt đầu xây dựng với Mage

Một tài khoản, một số dư Gems, mọi mô hình. Bạn chỉ trả tiền cho những gì mình tạo.

Liên quan

• SDK của Mage
• SDK Python của Mage
• Mage cho ComfyUI
• @mage-space/sdk trên npm
• Tất cả mô hình API
• Tài liệu API