सैंडबॉक्स API
Sandbox API आपके कोड या AI एजेंट को ज़रूरत पड़ने पर क्लाउड में एक अलग-थलग Linux मशीन देता है। एक सैंडबॉक्स बनाएँ, शेल कमांड चलाएँ, फ़ाइलें पढ़ें और लिखें, फिर उसे रोकें या मिटाएँ—यह सब REST के ज़रिए, उसी x-api-key और क्रेडिट बैलेंस का इस्तेमाल करके जो आप इमेज, वीडियो और ऑडियो जनरेशन के लिए करते हैं।
यह Sandbox (test) कुंजियों जैसा नहीं है।
is_test: trueके साथ बनाई गई API कुंजियों को “सैंडबॉक्स कुंजियाँ” कहा जाता है। ये जनरेशन एंडपॉइंट के लिए मॉक नतीजे देती हैं (देखें API संदर्भ)। यहाँ बताई गई Sandbox API असली क्लाउड मशीनें बनाती है। टेस्ट कुंजी से Sandbox API एंडपॉइंट कॉल किए जा सकते हैं, लेकिन वे मॉक नतीजा देते हैं और कुछ भी नहीं बनाते।
आकार और मूल्य निर्धारण
सैंडबॉक्स बनाते समय profile दें। सैंडबॉक्स चलते रहने के दौरान प्रति सेकंड बिलिंग होती है और शुल्क आपके क्रेडिट से लिया जाता है।
| प्रोफ़ाइल | संसाधन | मूल्य |
|---|---|---|
small | 2 vCPU, 4 GB RAM | $0.036 / घंटा |
default | 4 vCPU, 8 GB RAM | $0.072 / घंटा |
large | 8 vCPU, 16 GB RAM | $0.144 / घंटा |
- सैंडबॉक्स बनाते समय प्रति घंटे की दर तय हो जाती है।
- रोके गए सैंडबॉक्स मुफ़्त हैं। रुकने के दौरान फ़ाइलें सुरक्षित रहती हैं।
- सैंडबॉक्स बनाने या फिर से चलाने के लिए आपके बैलेंस में कम से कम $1 होना चाहिए।
जल्दी शुरू करें
export MUAPI_KEY="your-api-key"
# 1. सैंडबॉक्स बनाएँ
curl -X POST https://api.muapi.ai/api/v1/sandboxes \
-H "x-api-key: $MUAPI_KEY" -H "Content-Type: application/json" \
-d '{"profile": "default"}'
# -> {"id": "…", "state": "running", "profile": "default", "vcpu": 4, "memory_gb": 8, "price_per_hour": 0.072, …}
export ID="<id from the response>"
# 2. कमांड चलाएँ
curl -X POST https://api.muapi.ai/api/v1/sandboxes/$ID/commands \
-H "x-api-key: $MUAPI_KEY" -H "Content-Type: application/json" \
-d '{"command": "python3 --version", "timeout_seconds": 30}'
# 3. फ़ाइल लिखें और पढ़ें
curl -X PUT https://api.muapi.ai/api/v1/sandboxes/$ID/files \
-H "x-api-key: $MUAPI_KEY" -H "Content-Type: application/json" \
-d '{"path": "/home/user/hello.py", "content": "print(\"hi\")"}'
curl "https://api.muapi.ai/api/v1/sandboxes/$ID/files?path=/home/user/hello.py" \
-H "x-api-key: $MUAPI_KEY"
# 4. इसे रोकें (बिलिंग रुक जाती है)
curl -X POST https://api.muapi.ai/api/v1/sandboxes/$ID/stop \
-H "x-api-key: $MUAPI_KEY"
Python
import os, requests
BASE = "https://api.muapi.ai/api/v1/sandboxes"
H = {"x-api-key": os.environ["MUAPI_KEY"]}
sb = requests.post(BASE, headers=H, json={"profile": "small"}).json()
sid = sb["id"]
out = requests.post(f"{BASE}/{sid}/commands", headers=H,
json={"command": "echo hello && uname -a"}).json()
print(out)
requests.post(f"{BASE}/{sid}/stop", headers=H)
एंडपॉइंट
| विधि | पथ | विवरण |
|---|---|---|
POST | /api/v1/sandboxes | सैंडबॉक्स बनाएँ। बॉडी: {"profile": "small" | "default" | "large"} |
GET | /api/v1/sandboxes | अपने सैंडबॉक्स की सूची देखें |
GET | /api/v1/sandboxes/{id} | किसी एक सैंडबॉक्स की जानकारी लें |
POST | /api/v1/sandboxes/{id}/commands | शेल कमांड चलाएँ |
GET | /api/v1/sandboxes/{id}/commands/{process_id} | अलग किए गए कमांड की स्थिति और आउटपुट देखें |
PUT | /api/v1/sandboxes/{id}/files | फ़ाइल लिखें |
GET | /api/v1/sandboxes/{id}/files?path= | फ़ाइल पढ़ें |
POST | /api/v1/sandboxes/{id}/stop | रोकें (बिलिंग रुक जाती है) |
POST | /api/v1/sandboxes/{id}/resume | रुके हुए सैंडबॉक्स को फिर से चलाएँ |
DELETE | /api/v1/sandboxes/{id} | सैंडबॉक्स और उसकी फ़ाइलें मिटाएँ |
कमांड चलाएँ
POST /api/v1/sandboxes/{id}/commands
| फ़ील्ड | प्रकार | डिफ़ॉल्ट | नोट |
|---|---|---|---|
command | string | आवश्यक | शेल कमांड, अधिकतम 20,000 अक्षर |
timeout_seconds | integer | 30 | 1 से 600 |
detached | boolean | false | बैकग्राउंड में चलाएँ; मिले हुए process_id से स्थिति देखें |
cwd | string | . | काम करने वाली डायरेक्टरी। इसका पहले से मौजूद होना ज़रूरी है (उदाहरण के लिए, पहले mkdir -p /home/user/workspace चलाएँ) |
लंबे कामों के लिए detached: true सेट करें, फिर GET /api/v1/sandboxes/{id}/commands/{process_id} से स्थिति देखें।
फ़ाइलें
PUT /files में सादे टेक्स्ट वाली सामग्री के साथ {"path": "...", "content": "..."} दें (अधिकतम 2,000,000 अक्षर)। GET /files?path=... से {"path": "...", "content": "..."} मिलता है।
जीवनचक्र और बिलिंग
- नया सैंडबॉक्स कुछ ही सेकंड में
runningस्थिति में आ जाता है और उसमें Python 3 पहले से इंस्टॉल होता है। - रोकने की प्रक्रिया तुरंत पूरी नहीं होती। रोकने का अनुरोध करते ही बिलिंग रुक जाती है, लेकिन कुछ सेकंड तक तुरंत फिर से चलाने पर conflict मिल सकता है। रोकने की कॉल सैंडबॉक्स की आर्काइविंग पूरी होने तक प्रतीक्षा करती है, इसलिए रोकने के बाद फिर से चलाना सुरक्षित है।
- रोकने और फिर से चलाने के दौरान फ़ाइलें बनी रहती हैं।
- बैलेंस इस्तेमाल का शुल्क चुकाने के लिए पर्याप्त न होने पर, या 15 मिनट तक कोई गतिविधि न होने पर, सैंडबॉक्स अपने-आप रोक दिया जाता है।
- रुका हुआ सैंडबॉक्स 14 दिनों बाद मिटा दिया जाता है। उससे पहले ज़रूरी फ़ाइलें डाउनलोड कर लें।
- हर खाते में एक समय पर अधिकतम 3 सैंडबॉक्स हो सकते हैं।
- कमांड और फ़ाइलों तक पहुँच एक अलग-थलग मशीन में सामान्य उपयोगकर्ता के रूप में चलती है। उसमें क्या चलाते हैं, इसकी ज़िम्मेदारी आपकी है।
Playground और टास्क-शैली के एंडपॉइंट
हर ऑपरेशन Playground में भी उपलब्ध है और टास्क-शैली के एंडपॉइंट POST /api/v1/sandbox-<operation> के रूप में भी। <operation> के लिए इनमें से कोई एक मान दें: create, get, run-command, command-status, write-file, read-file, stop, resume, delete। इनमें REST रूट वाले ही फ़ील्ड और जहाँ ज़रूरी हो वहाँ sandbox_id दें। जवाब में एक request_id मिलता है, जिसे किसी भी दूसरे Muapi मॉडल की तरह GET /api/v1/predictions/{request_id}/result से पढ़ें। कंप्यूटिंग का शुल्क केवल चलने के समय के लिए लिया जाता है; इन अनुरोधों का अपना शुल्क $0 है।
त्रुटियाँ
त्रुटियाँ {"error": {"code": "...", "message": "..."}} के रूप में मिलती हैं।
| स्थिति | कोड | अर्थ |
|---|---|---|
| 400 | INVALID_PROFILE | अज्ञात profile |
| 402 | INSUFFICIENT_CREDITS | सैंडबॉक्स बनाने या फिर से चलाने के लिए बैलेंस $1 की न्यूनतम राशि से कम है |
| 422 | INVALID_INPUT | कोई फ़ील्ड छूटा हुआ है या उसकी वैध सीमा से बाहर है (टास्क-शैली के एंडपॉइंट) |
| 502 | SANDBOX_UPSTREAM_ERROR | अस्थायी बैकएंड त्रुटि; फिर से कोशिश करें |
उपयोग के उदाहरण
- कोडिंग एजेंट: किसी repo को क्लोन करें, पैकेज इंस्टॉल करें, असली मशीन पर टेस्ट चलाएँ और विफलताएँ ठीक करें।
- कोड चलाना: अपने इंफ़्रास्ट्रक्चर से अलग, जनरेट किया गया या अविश्वसनीय कोड चलाएँ।
- मीडिया पाइपलाइन: Muapi के इमेज, वीडियो और ऑडियो मॉडल के आउटपुट पर ffmpeg या अपनी स्क्रिप्ट चलाएँ।
- होस्ट किए गए ओपन-सोर्स ऐप: उपयोगकर्ता की अपनी Muapi कुंजी के साथ ऐप को क्लाउड में चलाएँ।
सारांश के लिए Sandbox API का लैंडिंग पेज देखें।