VoltageGPU API Documentation
GPU Cloud Computing API - Deploy and manage GPU pods programmatically with our powerful REST API
Base URL: https://api.voltagegpu.com🚀 Quick Start
Get started with VoltageGPU API in minutes. Here's how to list available GPU machines:
# List available GPU machines with pricing
curl -X GET "https://api.voltagegpu.com/api/volt/machines" \
-H "Content-Type: application/json"
# Response example:
{
"success": true,
"machines": [
{
"id": "rtx-4090-24gb",
"name": "NVIDIA RTX 4090",
"vram": "24GB",
"price_per_hour": 0.45,
"availability": "high"
},
{
"id": "a100-80gb",
"name": "NVIDIA A100",
"vram": "80GB",
"price_per_hour": 1.89,
"availability": "medium"
}
]
}💡 Tip: No authentication required for listing machines. Get your API key from the Browse Pods to create and manage pods.
🔐 Authentication
All authenticated endpoints require an API key in the header. Your API key identifies your account and tracks usage for billing.
# Authenticated request example - List your pods
curl -X GET "https://api.voltagegpu.com/api/volt/pods" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"
# Create a new pod
curl -X POST "https://api.voltagegpu.com/api/volt/pods" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "my-gpu-pod",
"machine_type": "rtx-4090-24gb",
"template_id": "pytorch-2.0",
"ssh_key_id": "key_abc123"
}'🔑 Get your API key from the Dashboard Settings. Keep it secure and never share it publicly.
📚 API Reference
Templates
Pre-configured environments for your GPU pods. Templates include popular ML frameworks like PyTorch, TensorFlow, and more.
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /api/volt/templates | List all available templates | ❌ |
| POST | /api/volt/templates | Create a custom template | ✅ |
| GET | /api/volt/templates/:id | Get template details by ID | ❌ |
| PUT | /api/volt/templates/:id | Update your template | ✅ |
| DELETE | /api/volt/templates/:id | Delete your template | ✅ |
Machines
Browse available GPU machines with real-time pricing and availability information.
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /api/volt/machines | List all GPU machines with pricing | ❌ |
Pods
Create, manage, and control your GPU pod instances. Pods are your running GPU environments.
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /api/volt/pods | List all your pods | ✅ |
| POST | /api/volt/pods | Create a new GPU pod | ✅ |
| GET | /api/volt/pods/:id | Get pod details and status | ✅ |
| PUT | /api/volt/pods/:id | Update pod configuration | ✅ |
| DELETE | /api/volt/pods/:id | Terminate and delete pod | ✅ |
| POST | /api/volt/pods/:id/start | Start a stopped pod | ✅ |
| POST | /api/volt/pods/:id/stop | Stop a running pod | ✅ |
SSH Keys
Manage SSH keys for secure access to your GPU pods via terminal.
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /api/volt/ssh-keys | List your SSH keys | ✅ |
| POST | /api/volt/ssh-keys | Add a new SSH key | ✅ |
| GET | /api/volt/ssh-keys/:id | Get SSH key details | ✅ |
| DELETE | /api/volt/ssh-keys/:id | Remove an SSH key | ✅ |
Docker Credentials
Store Docker registry credentials for pulling private images to your pods.
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /api/volt/docker-credentials | List Docker credentials | ✅ |
| POST | /api/volt/docker-credentials | Add Docker credential | ✅ |
| GET | /api/volt/docker-credentials/:id | Get credential details | ✅ |
| DELETE | /api/volt/docker-credentials/:id | Remove credential | ✅ |
API Keys
Manage your API keys for programmatic access to VoltageGPU services.
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /api/volt/api-keys | List your API keys | ✅ |
| POST | /api/volt/api-keys | Generate a new API key | ✅ |
| DELETE | /api/volt/api-keys/:id | Revoke an API key | ✅ |
⚠️ Error Handling
All API errors follow a consistent JSON format for easy handling in your applications:
{
"success": false,
"error": "HTTP error",
"message": "API key missing from headers",
"status_code": 401,
"timestamp": "2026-01-08T12:00:00.000Z"
}Common Status Codes
200 | Success - Request completed successfully |
201 | Created - Resource created successfully |
400 | Bad Request - Invalid parameters or request body |
401 | Unauthorized - Missing or invalid API key |
403 | Forbidden - Insufficient permissions |
404 | Not Found - Resource doesn't exist |
429 | Too Many Requests - Rate limit exceeded |
500 | Internal Server Error - Something went wrong |
🚦 Rate Limits
To ensure fair usage and service stability, the following rate limits apply:
- Public endpoints: 100 requests per minute
- Authenticated endpoints: 1000 requests per minute
- Pod creation: 10 pods per minute
Rate limit headers are included in all responses:
X-RateLimit-Limit: 1000 X-RateLimit-Remaining: 999 X-RateLimit-Reset: 1704715200
💡 If you need higher rate limits for your use case, please contact our support team.