अपनी API Key प्राप्त करना
GPUnex API आपको GPU instances प्रबंधित करने, बैलेंस जाँचने और वेब डैशबोर्ड का उपयोग किए बिना अपने वर्कफ़्लो को स्वचालित करने की अनुमति देता है। कोई भी API अनुरोध करने से पहले, आपको एक API key जनरेट करनी होगी।
-
अपने GPUnex अकाउंट में लॉग इन करें और अपने Profile पेज या Dashboard सेटिंग्स पैनल पर जाएँ।
-
API Keys अनुभाग खोलें। अपनी अकाउंट सेटिंग्स में API Keys टैब या कार्ड देखें।
-
“Create New API Key” पर क्लिक करें। आपसे key को एक वर्णनात्मक नाम देने के लिए कहा जाएगा। कुछ सार्थक चुनें जो key के उद्देश्य की पहचान करे — उदाहरण के लिए, “Production Server”, “CI/CD Pipeline”, या “Local Development”। इससे बाद में कई keys का प्रबंधन आसान हो जाता है।
-
अपनी API key तुरंत कॉपी करें। एक बार key जनरेट होने के बाद, यह केवल एक बार प्रदर्शित की जाएगी। इसे कॉपी करें और इसे एक सुरक्षित स्थान जैसे पासवर्ड मैनेजर या एन्क्रिप्टेड सीक्रेट्स वॉल्ट में स्टोर करें। इस चरण के बाद आप पूरी key दोबारा नहीं देख पाएँगे।
-
Key स्कोपिंग और निरस्तीकरण को समझें। प्रत्येक API key आपके अकाउंट से जुड़ी होती है और आपके अकाउंट की अनुमतियाँ प्राप्त करती है। आप विभिन्न अनुप्रयोगों या वातावरणों के लिए कई keys बना सकते हैं। यदि कोई key से समझौता होता है या अब आवश्यकता नहीं है, तो आप इसे API Keys अनुभाग से किसी भी समय निरस्त कर सकते हैं। Key का निरस्तीकरण तत्काल और स्थायी है — उस key का उपयोग करने वाले सभी अनुरोध अस्वीकार कर दिए जाएँगे।
प्रमाणीकरण
GPUnex API के सभी अनुरोधों में Bearer token स्कीम का उपयोग करके आपकी API key के साथ एक Authorization हेडर शामिल होना चाहिए।
हेडर प्रारूप:
Authorization: Bearer YOUR_API_KEY
यदि API key अनुपस्थित, अमान्य, या निरस्त है, तो API एक 401 Unauthorized प्रतिक्रिया लौटाएगा:
{
"error": "unauthorized",
"message": "Invalid or missing API key. Please check your Authorization header."
}
सुनिश्चित करें कि आपकी key हर अनुरोध में शामिल हो। API सत्र-आधारित प्रमाणीकरण या कुकी-आधारित प्रमाणीकरण का समर्थन नहीं करता।
मुख्य Endpoints
GPUnex API RESTful संसाधनों के आसपास संगठित है। सभी endpoints बेस URL https://api.gpunex.com/v1 का उपयोग करते हैं। नीचे उपलब्ध मुख्य endpoints का सारांश है।
| Method | Endpoint | विवरण |
|---|---|---|
| GET | /v1/instances | आपके सभी सक्रिय और हाल के instances की सूची। वर्तमान स्थिति, GPU मॉडल और कॉन्फ़िगरेशन विवरण के साथ instance ऑब्जेक्ट की एक सरणी लौटाता है। |
| POST | /v1/instances | एक नया GPU instance बनाएँ। GPU मॉडल, फ्रेमवर्क और क्षेत्र निर्दिष्ट करने वाली JSON बॉडी आवश्यक है। शुल्क आपके USDC बैलेंस से काटे जाते हैं। |
| GET | /v1/instances/:id | अद्वितीय ID द्वारा एक विशिष्ट instance के बारे में विस्तृत जानकारी प्राप्त करें। SSH कनेक्शन विवरण, रनटाइम मेट्रिक्स और बिलिंग जानकारी शामिल है। |
| DELETE | /v1/instances/:id | एक चल रहे instance को समाप्त करें। Instance बंद हो जाएगा और आपसे इसके लिए अब शुल्क नहीं लिया जाएगा। Instance पर कोई भी असहेजा डेटा खो जाएगा। |
| GET | /v1/gpu-models | मार्केटप्लेस पर वर्तमान में उपलब्ध सभी GPU मॉडल की सूची। मूल्य निर्धारण, VRAM, क्षेत्र के अनुसार उपलब्धता और समर्थित फ्रेमवर्क शामिल हैं। |
| GET | /v1/balance | अपना वर्तमान USDC वॉलेट बैलेंस और हालिया लेनदेन सारांश जाँचें। |
सभी प्रतिक्रियाएँ JSON प्रारूप में लौटाई जाती हैं। सफल अनुरोध GET अनुरोधों के लिए 200 OK स्थिति कोड और संसाधन बनाने वाले POST अनुरोधों के लिए 201 Created स्थिति कोड लौटाते हैं।
उदाहरण: एक Instance बनाना
एक नया GPU instance बनाने के लिए, अपने वांछित कॉन्फ़िगरेशन को निर्दिष्ट करने वाली JSON बॉडी के साथ /v1/instances पर एक POST अनुरोध भेजें।
अनुरोध:
अनुरोध बॉडी पैरामीटर:
| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
gpu_model | string | हाँ | GPU मॉडल पहचानकर्ता। उपलब्ध विकल्प देखने के लिए /v1/gpu-models का उपयोग करें (जैसे, H100_80GB, A100_80GB, L40S_48GB, L4_24GB)। |
framework | string | हाँ | पूर्व-स्थापित फ्रेमवर्क और संस्करण (जैसे, pytorch-2.3, tensorflow-2.16, jax-0.4)। |
region | string | हाँ | Instance के लिए डेटासेंटर क्षेत्र (जैसे, us-east-1, eu-west-1, ap-southeast-1)। |
उदाहरण प्रतिक्रिया (201 Created):
{
"id": "inst_7f3a9b2c4d1e",
"status": "provisioning",
"gpu_model": "A100_80GB",
"framework": "pytorch-2.3",
"region": "us-east-1",
"ssh_command": null,
"hourly_rate": "1.89",
"currency": "USDC",
"created_at": "2026-02-15T14:32:07Z"
}
Instance शुरू में provisioning स्थिति में होगा। एक बार GPU आवंटित हो जाने और वातावरण तैयार होने पर, स्थिति running में बदल जाएगी और ssh_command फ़ील्ड आपकी कनेक्शन स्ट्रिंग से भर जाएगी। प्रोविज़निंग में आमतौर पर उपलब्धता के आधार पर 30 सेकंड से 2 मिनट लगते हैं।
उदाहरण: Instance की स्थिति जाँचना
एक बार आपने instance बना लिया, आप किसी भी समय इसकी ID के साथ instance endpoint से क्वेरी करके इसकी वर्तमान स्थिति जाँच सकते हैं।
अनुरोध:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.gpunex.com/v1/instances/inst_7f3a9b2c4d1e
उदाहरण प्रतिक्रिया (200 OK):
{
"id": "inst_7f3a9b2c4d1e",
"status": "running",
"gpu_model": "A100_80GB",
"framework": "pytorch-2.3",
"region": "us-east-1",
"ssh_command": "ssh [email protected] -p 2222",
"ip_address": "203.0.113.42",
"hourly_rate": "1.89",
"currency": "USDC",
"uptime_seconds": 3847,
"total_cost": "2.02",
"created_at": "2026-02-15T14:32:07Z",
"started_at": "2026-02-15T14:33:15Z"
}
स्थिति मान:
| स्थिति | अर्थ |
|---|---|
provisioning | Instance सेट अप किया जा रहा है। GPU संसाधन आवंटित किए जा रहे हैं और फ्रेमवर्क वातावरण तैयार किया जा रहा है। |
running | Instance सक्रिय है और उपयोग के लिए तैयार है। SSH एक्सेस उपलब्ध है। |
stopping | Instance बंद होने की प्रक्रिया में है। |
terminated | Instance बंद हो गया है और अब कोई शुल्क नहीं लग रहा है। |
error | प्रोविज़निंग या रनटाइम के दौरान एक त्रुटि हुई। यदि यह बना रहता है तो सहायता से संपर्क करें। |
Rate Limits और सर्वोत्तम प्रथाएँ
Rate Limits
GPUnex API निष्पक्ष उपयोग और प्लेटफ़ॉर्म स्थिरता सुनिश्चित करने के लिए rate limits लागू करता है। वर्तमान सीमाएँ हैं:
- सामान्य endpoints: प्रति API key प्रति मिनट 120 अनुरोध।
- Instance निर्माण: प्रति API key प्रति मिनट 10 अनुरोध।
- बैलेंस और रीड-ओनली endpoints: प्रति API key प्रति मिनट 300 अनुरोध।
यदि आप rate limit से अधिक हो जाते हैं, तो API एक 429 Too Many Requests प्रतिक्रिया लौटाएगा जिसमें एक Retry-After हेडर होगा जो बताएगा कि पुनः प्रयास करने से पहले कितने सेकंड प्रतीक्षा करनी है।
{
"error": "rate_limit_exceeded",
"message": "Too many requests. Please retry after 12 seconds.",
"retry_after": 12
}
सर्वोत्तम प्रथाएँ
अपने इंटीग्रेशन को सुरक्षित और विश्वसनीय रखने के लिए इन दिशानिर्देशों का पालन करें।
- API keys को कभी भी क्लाइंट-साइड कोड में उजागर न करें। अपनी API key को ब्राउज़र में चल रहे JavaScript, मोबाइल ऐप सोर्स कोड, या किसी भी सार्वजनिक रूप से सुलभ रिपॉज़िटरी में एम्बेड न करें। API keys का उपयोग केवल सर्वर-साइड अनुप्रयोगों में किया जाना चाहिए जहाँ अंतिम उपयोगकर्ता उनका निरीक्षण नहीं कर सकते।
महत्वपूर्ण
अपनी API key को कभी भी क्लाइंट-साइड कोड, ब्राउज़र JavaScript, या सार्वजनिक रिपॉज़िटरी में उजागर न करें। API keys का उपयोग केवल सर्वर-साइड अनुप्रयोगों में किया जाना चाहिए।
-
Environment variables का उपयोग करें। अपनी API key को अपने सोर्स फ़ाइलों में हार्डकोड करने के बजाय environment variable में स्टोर करें। उदाहरण के लिए:
export GPUNEX_API_KEY="your_api_key_here"फिर अपने कोड में इसे संदर्भित करें:
curl -H "Authorization: Bearer $GPUNEX_API_KEY" https://api.gpunex.com/v1/instances -
Keys को समय-समय पर घुमाएँ। सुरक्षा की सर्वोत्तम प्रथा के रूप में, हर 90 दिनों में एक नई API key जनरेट करें और पुरानी को निरस्त करें। यदि कोई key अनजाने में लीक हो जाती है तो इससे प्रभाव सीमित रहता है।
-
अलग-अलग वातावरणों के लिए अलग keys का उपयोग करें। डेवलपमेंट, स्टेजिंग और प्रोडक्शन के लिए अलग-अलग API keys बनाएँ। इस तरह, एक key को निरस्त करने से अन्य वातावरण प्रभावित नहीं होते।
सुझाव
डेवलपमेंट, स्टेजिंग और प्रोडक्शन के लिए अलग-अलग API keys का उपयोग करें। इस तरह, एक key को निरस्त करने से अन्य वातावरण प्रभावित नहीं होते।
-
त्रुटियों को सुचारू रूप से संभालें। अपने अनुप्रयोग में हमेशा HTTP स्थिति कोड की जाँच करें।
429और5xxप्रतिक्रियाओं के लिए exponential backoff के साथ पुनः प्रयास तर्क लागू करें।429के अलावा4xxत्रुटियों को पुनः प्रयास न करें — ये अनुरोध में ही किसी समस्या को इंगित करती हैं। -
अपने उपयोग की निगरानी करें। अपने API कॉल वॉल्यूम और instance खर्च पर नज़र रखें। अपने USDC बैलेंस की प्रोग्रामेटिक रूप से निगरानी करने के लिए
/v1/balanceendpoint का उपयोग करें और यदि यह एक सीमा से नीचे गिरता है तो अलर्ट सेट करें।