Mage SDK · TypeScript
Mage TypeScript SDK
Node.js से इमेज, वीडियो और ऑडियो जनरेट करें, हर Mage मॉडल के लिए टाइप्ड कॉन्फ़िग के साथ। एक ही कॉल सबमिट करती है, इंतज़ार करती है और नतीजा लौटाती है।
npm install @mage-space/sdkएक नज़र में
Mage TypeScript SDK, Mage API का आधिकारिक ओपन-सोर्स क्लाइंट है, जो @mage-space/sdk नाम से उपलब्ध है। इसे "npm install @mage-space/sdk" से इंस्टॉल करें, MAGE_API_KEY सेट करें, और मॉडल id और कॉन्फ़िग के साथ mage.run कॉल करके 37 में से किसी भी मॉडल से तैयार इमेज, वीडियो या ऑडियो पाएँ। यह Node.js 20.19 या उसके बाद के वर्शन पर, या fetch वाले किसी भी सर्वर रनटाइम पर चलता है, और हर जनरेशन का भुगतान Gems में होता है।
- 20.19+Node.js
- 0रनटाइम डिपेंडेंसी
- 37टाइप्ड मॉडल
- MITओपन सोर्स
सेटअप
TypeScript SDK इंस्टॉल करें और मॉडल चलाएँ
पैकेज इंस्टॉल करें
अपने प्रोजेक्ट में @mage-space/sdk जोड़ें।
npm install @mage-space/sdkअपनी API key सेट करें
mage.space पर API → API Keys में key बनाएँ और उसे export करें। क्लाइंट MAGE_API_KEY पढ़ता है।
export MAGE_API_KEY="mage_sk_..."जनरेट करें
मॉडल id और उसके कॉन्फ़िग के साथ run कॉल करें। यह नतीजे का इंतज़ार करके उसे लौटाता है; आउटपुट 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-v4', }); 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 आपके लिए क्या-क्या संभालता है
एक कॉल, तैयार मीडिया
run जनरेशन सबमिट करता है, API के सुझाए बैकऑफ़ के साथ पोल करता है और पूरा हुआ रिक्वेस्ट result.url के साथ लौटाता है।
ऐसे रीट्राई जिनमें दोबारा पैसे नहीं लगते
हर सबमिशन के साथ एक आइडेम्पोटेंसी की जाती है। नेटवर्क और सर्वर एरर पर बैकऑफ़ के साथ रीट्राई होता है, और दोबारा भेजे गए सबमिशन का शुल्क कभी दोबारा नहीं लगता।
एक कॉल में अपलोड
डेटा URL के लिए बहुत बड़ी फ़ाइलें साइन्ड अपलोड से जाती हैं, जिसमें टिकट, PUT और साइज़ की जाँच आपके लिए संभाली जाती है।
साफ़ एरर
API के इनकार के साथ HTTP स्टेटस, एरर कोड और रिक्वेस्ट id मिलता है; फ़ेल या रद्द हुए जनरेशन और टाइमआउट के अपने अलग एरर टाइप हैं।
हर मॉडल के लिए टाइप्ड
MangoConfig, CherryConfig और बाकी सब API रेफ़रेंस से जनरेट होते हैं, इसलिए आपका एडिटर फ़ील्ड ऑटोकम्प्लीट करता है और गलत विकल्प पकड़ लेता है।
ज़ीरो डिपेंडेंसी
ESM, बिना किसी रनटाइम डिपेंडेंसी के। यह Node.js के बिल्ट-इन fetch का इस्तेमाल करता है, और हर कॉल AbortSignal लेती है।
रेफ़रेंस
TypeScript SDK एक नज़र में
वही मेथड हर मॉडल पर काम करते हैं; मॉडल पहला आर्ग्युमेंट होता है।
| मेथड | यह क्या करता है |
|---|---|
| mage.run(model, config) | जनरेशन सबमिट करें, उसका इंतज़ार करें और पूरा हुआ रिक्वेस्ट पाएँ। |
| mage.generate(model, config) | जनरेशन सबमिट करें और रिक्वेस्ट तुरंत पाएँ। |
| mage.requests.get / cancel / wait | id से किसी रिक्वेस्ट को पढ़ें, रोकें या उसका इंतज़ार करें। |
| mage.uploads.upload(data) | 100 MB तक की फ़ाइल अपलोड करें और उसका URL पाएँ। |
| mage.characters / mage.references | सेव किए गए कैरेक्टर और रेफ़रेंस की सूची देखें, बनाएँ और हटाएँ। |
| mage.account.get() | आपका Gems बैलेंस। |
| mage.architectures.list() | विकल्पों और कीमतों के साथ लाइव मॉडल कैटलॉग। |
मॉडल
इन मॉडल से शुरू करें
Guava API
ऐसी फ़ोटोरियलिज़्म जो असली तस्वीर जैसी लगे
Mango API
हमारी फ़्लैगशिप इमेज फ़ैमिली
Nano Banana 2 API
साफ़, पढ़ने योग्य टेक्स्ट, 4K तक
Cherry API
हमारी फ़्लैगशिप वीडियो फ़ैमिली
Lemon API
वीडियो के सारे फ़ीचर, किफ़ायती दाम पर
Seed Audio API
एक ही प्रॉम्प्ट से आवाज़ें, संगीत और साउंड इफ़ेक्ट
अक्सर पूछे जाने वाले सवाल
अक्सर पूछे जाने वाले सवाल
क्या मैं Mage TypeScript SDK का इस्तेमाल ब्राउज़र में कर सकता/सकती हूँ?
क्या TypeScript SDK CommonJS के साथ काम करता है?
क्या TypeScript SDK Next.js के साथ काम करता है?
क्या Mage SDK मुफ़्त और ओपन सोर्स हैं?
क्या Mage के नए मॉडल पुराने SDK के साथ काम करते हैं?
दोबारा भेजे गए रिक्वेस्ट के लिए SDK दो बार भुगतान होने से कैसे बचाते हैं?
क्या SDK स्टेबल हैं?
Mage API की कीमत कितनी है?
क्या API इस्तेमाल करने के लिए मुझे Mage मेंबरशिप चाहिए?
क्या मैं API के आउटपुट का व्यावसायिक उपयोग कर सकता/सकती हूँ?
Mage के साथ बनाना शुरू करें
एक अकाउंट, एक Gems बैलेंस, हर मॉडल। भुगतान सिर्फ़ उतना, जितना आप जनरेट करें।