API Sandbox
Sandbox API menyediakan mesin Linux cloud terisolasi sesuai permintaan untuk kode atau agen AI Anda. Buat sandbox, jalankan perintah shell, baca dan tulis file, lalu hentikan atau hapus sandbox, semuanya melalui REST dengan x-api-key dan saldo kredit yang sama dengan yang Anda gunakan untuk membuat gambar, video, dan audio.
Berbeda dari kunci Sandbox (test). Kunci API yang dibuat dengan
is_test: truedisebut "kunci sandbox" dan mengembalikan hasil tiruan untuk endpoint pembuatan (lihat Referensi API). Sandbox API yang dijelaskan di sini membuat mesin cloud sungguhan. Kunci test dapat memanggil endpoint Sandbox API, tetapi akan mengembalikan hasil tiruan dan tidak membuat apa pun.
Ukuran dan harga
Sertakan profile saat membuat sandbox. Biaya dihitung per detik selama sandbox berjalan dan dipotong dari kredit Anda.
| Profil | Sumber daya | Harga |
|---|---|---|
small | 2 vCPU, 4 GB RAM | $0.036 / jam |
default | 4 vCPU, 8 GB RAM | $0.072 / jam |
large | 8 vCPU, 16 GB RAM | $0.144 / jam |
- Tarif per jam ditetapkan saat sandbox dibuat.
- Sandbox yang dihentikan tidak dikenai biaya. File tetap tersimpan selama sandbox dihentikan.
- Saldo Anda harus minimal $1 untuk membuat atau melanjutkan sandbox.
Mulai cepat
export MUAPI_KEY="your-api-key"
# 1. Buat sandbox
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. Jalankan perintah
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. Tulis dan baca file
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. Hentikan (penagihan dijeda)
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)
Endpoint
| Metode | Path | Deskripsi |
|---|---|---|
POST | /api/v1/sandboxes | Buat sandbox. Body: {"profile": "small" | "default" | "large"} |
GET | /api/v1/sandboxes | Tampilkan daftar sandbox Anda |
GET | /api/v1/sandboxes/{id} | Dapatkan satu sandbox |
POST | /api/v1/sandboxes/{id}/commands | Jalankan perintah shell |
GET | /api/v1/sandboxes/{id}/commands/{process_id} | Status dan keluaran perintah yang berjalan terpisah |
PUT | /api/v1/sandboxes/{id}/files | Tulis file |
GET | /api/v1/sandboxes/{id}/files?path= | Baca file |
POST | /api/v1/sandboxes/{id}/stop | Hentikan (penagihan dijeda) |
POST | /api/v1/sandboxes/{id}/resume | Lanjutkan sandbox yang dihentikan |
DELETE | /api/v1/sandboxes/{id} | Hapus sandbox beserta file-file di dalamnya |
Jalankan perintah
POST /api/v1/sandboxes/{id}/commands
| Kolom | Tipe | Default | Catatan |
|---|---|---|---|
command | string | wajib | Perintah shell, hingga 20,000 karakter |
timeout_seconds | integer | 30 | 1 hingga 600 |
detached | boolean | false | Jalankan di latar belakang; periksa statusnya menggunakan process_id yang dikembalikan |
cwd | string | . | Direktori kerja. Direktori ini harus sudah ada (misalnya, jalankan mkdir -p /home/user/workspace terlebih dahulu) |
Untuk pekerjaan yang lama, tetapkan detached: true, lalu periksa statusnya melalui GET /api/v1/sandboxes/{id}/commands/{process_id}.
File
PUT /files menerima {"path": "...", "content": "..."} dengan konten teks biasa (hingga 2,000,000 karakter). GET /files?path=... mengembalikan {"path": "...", "content": "..."}.
Siklus hidup dan penagihan
- Sandbox baru akan berstatus
runningdalam beberapa detik dan sudah dilengkapi Python 3. - Penghentian tidak langsung terjadi. Penagihan berhenti saat Anda mengajukan permintaan, tetapi jika segera dilanjutkan, permintaan mungkin ditolak dengan konflik selama beberapa detik. Permintaan penghentian menunggu hingga pengarsipan sandbox selesai sebelum memberikan respons, jadi menghentikan lalu melanjutkannya aman.
- File tetap ada setelah sandbox dihentikan dan dilanjutkan.
- Sandbox akan dihentikan secara otomatis jika saldo Anda tidak cukup untuk menutupi penggunaan, atau setelah 15 menit tanpa aktivitas.
- Sandbox yang dihentikan akan dihapus setelah 14 hari. Unduh apa pun yang Anda perlukan sebelum itu.
- Setiap akun dapat memiliki hingga 3 sandbox sekaligus.
- Perintah dan akses file berjalan sebagai pengguna biasa di dalam mesin terisolasi. Anda bertanggung jawab atas apa yang dijalankan di dalamnya.
Playground dan endpoint bergaya tugas
Setiap operasi juga tersedia di Playground dan sebagai endpoint bergaya tugas, POST /api/v1/sandbox-<operation>, dengan <operation> berupa salah satu dari create, get, run-command, command-status, write-file, read-file, stop, resume, delete. Endpoint ini menerima kolom yang sama dengan rute REST ditambah sandbox_id jika relevan, dan mengembalikan request_id yang dapat Anda baca melalui GET /api/v1/predictions/{request_id}/result, seperti model Muapi lainnya. Komputasi ditagih hanya berdasarkan waktu berjalan; permintaan ini sendiri berbiaya $0.
Error
Error menggunakan {"error": {"code": "...", "message": "..."}}.
| Status | Kode | Arti |
|---|---|---|
| 400 | INVALID_PROFILE | profile tidak dikenal |
| 402 | INSUFFICIENT_CREDITS | Saldo di bawah batas minimum $1 untuk membuat atau melanjutkan sandbox |
| 422 | INVALID_INPUT | Kolom tidak ada atau nilainya di luar rentang yang diizinkan (endpoint bergaya tugas) |
| 502 | SANDBOX_UPSTREAM_ERROR | Error backend sementara, coba lagi |
Kasus penggunaan
- Agen coding: kloning repo, instal paket, jalankan pengujian, dan perbaiki kegagalan di mesin sungguhan.
- Eksekusi kode: jalankan kode yang dihasilkan atau tidak tepercaya di luar infrastruktur Anda sendiri.
- Pipeline media: jalankan ffmpeg atau skrip khusus pada keluaran dari model gambar, video, dan audio Muapi.
- Aplikasi open-source yang di-host: jalankan aplikasi di cloud dengan kunci Muapi milik pengguna.
Lihat halaman utama Sandbox API untuk ringkasan.