Massed Compute VM API (1.0.0)
Download OpenAPI specification:Download
API documentation for our direct on-demand offering
If you are a marketplace looking to leverage our GPU inventory please contact us at techadmin@massedcompute.com
Authentication of every endpoint provided requres a API token. We leverage Bearer token authentication on our endpoints.
| Header | Value |
|---|---|
| Authorization | Bearer {{api_token}} |
If you would like to use the API, please contact us at techadmin@massedcompute.com to request a token.
Retrieve a list of avaialable GPU configurations.
An comprehensive list of all GPU types, configurations, and available inventory.
Responses
Response samples
- 200
{- "gpu_inventory": {
- "property1": {
- "instance_type": {
- "name": "string",
- "description": "string",
- "price_cents_per_hour": 0,
- "specs": {
- "vcpu_count": 0,
- "memory_gib": 0,
- "storage_gb": 0
}
}, - "regions_with_capacity_available": [
- {
- "name": "string",
- "description": "string"
}
], - "capacity_available": 0
}, - "property2": {
- "instance_type": {
- "name": "string",
- "description": "string",
- "price_cents_per_hour": 0,
- "specs": {
- "vcpu_count": 0,
- "memory_gib": 0,
- "storage_gb": 0
}
}, - "regions_with_capacity_available": [
- {
- "name": "string",
- "description": "string"
}
], - "capacity_available": 0
}
}
}Retrieve list of all running instances.
An instance is a virtual machine that is currently running.
Responses
Response samples
- 200
{- "runningInstances": [
- {
- "uuid": "8b52a46b-a892-4fde-925c-6d13226908f7",
- "name": "Halloween Test",
- "ip": "1.1.1.1",
- "username": "Ubuntu",
- "password": 123456,
- "status": "rented",
- "os_booted": 1,
- "command_startup": "",
- "created": "2024-08-07T16:41:43.000Z",
- "active": 1,
- "image": {
- "id": 7,
- "name": "Art",
- "description": "AI-powered tools specifically designed for artists and creatives, providing you with the ability to easily incorporate AI-generated content into your work. By harnessing the power of these advanced technologies, you can take your art to new heights and explore uncharted territories in the creative world. Leverage the full potential of AI and transform your artistic process today."
}, - "product": {
- "name": "gpu_1x_l40",
- "description": "1x L40",
- "gpu_count": 1,
- "vcpu": 26,
- "ram": 128,
- "storage": 625,
- "price_hr": 0.99,
- "final_price_hr": 0
}
}
]
}Retrieve single running instances.
An instance is a virtual machine that is currently running.
Responses
Response samples
- 200
{- "runningInstance": {
- "uuid": "8b52a46b-a892-4fde-925c-6d13226908f7",
- "name": "Halloween Test",
- "ip": "1.1.1.1",
- "username": "Ubuntu",
- "password": 123456,
- "status": "rented",
- "os_booted": 1,
- "command_startup": "",
- "created": "2024-08-07T16:41:43.000Z",
- "active": 1,
- "image": {
- "id": 7,
- "name": "Art",
- "description": "AI-powered tools specifically designed for artists and creatives, providing you with the ability to easily incorporate AI-generated content into your work. By harnessing the power of these advanced technologies, you can take your art to new heights and explore uncharted territories in the creative world. Leverage the full potential of AI and transform your artistic process today."
}, - "product": {
- "name": "gpu_1x_l40",
- "description": "1x L40",
- "gpu_count": 1,
- "vcpu": 26,
- "ram": 128,
- "storage": 625,
- "price_hr": "0.990000",
- "final_price_hr": "0.000000"
}
}
}Deploy new instances.
Request Body schema: application/jsonrequired
| imageId | integer The ID of the image to deploy |
| productName required | string The product name of the GPU instance you want to deploy. Example = 'gpu_1x_l40' |
| regionName required | string The region name of the GPU instance you want to deploy. Example = 'us-central-3' |
| instanceName | string The name of the instance you want to deploy |
| coupon | string The coupon code you want to apply to the instance |
| command | string The command you want to run on startup |
| sshKey | string The SSH key you want to use to connect to the instance |
Responses
Request samples
- Payload
{- "imageId": 0,
- "productName": "string",
- "regionName": "string",
- "instanceName": "string",
- "coupon": "string",
- "command": "string",
- "sshKey": "string"
}Response samples
- 202
{- "response": "8b52a46b-uuid-4fde-xxxx-6d13226908f7"
}Restart an instances.
Request Body schema: application/jsonrequired
| instanceUuids required | Array of strings The ID or IDs of instances to restart |
Responses
Request samples
- Payload
{- "instanceUuids": [
- "string"
]
}Response samples
- 202
{- "response": [
- {
- "id": "2c56cd01-5f0b-4bc2-bb72-3c8e486505e2",
- "name": "test api deploy1",
- "ip": "1.1.1.1",
- "status": "booting",
- "ssh_key_names": [
- "string"
], - "file_system_names": [
- "string"
], - "region": {
- "name": "us-central-3",
- "description": "Des Moines, IA"
}, - "instance_type": {
- "name": "gpu_1x_a6000",
- "description": "1x RTX A6000",
- "price_cents_per_hour": 0,
- "specs": {
- "vcpus": 6,
- "memory_gib": 48,
- "storage_gb": 256
}
}, - "jupyter_token": "string",
- "jupyter_url": "string"
}
]
}Terminate an instances.
Termination completely removes the instance from the system and destroys all data.
Request Body schema: application/jsonrequired
| instanceUuids required | Array of strings The ID or IDs of instances to restart |
Responses
Request samples
- Payload
{- "instanceUuids": [
- "string"
]
}Response samples
- 202
{- "response": {
- "data": {
- "terminated_instances": [
- {
- "id": "2c56cd01-5f0b-4bc2-bb72-3c8e486505e2",
- "name": "test api deploy1",
- "ip": "1.1.1.1",
- "status": "terminated",
- "ssh_key_names": [
- "string"
], - "file_system_names": [
- "string"
], - "region": {
- "name": "us-central-3",
- "description": "Des Moines, IA"
}, - "instance_type": {
- "name": "gpu_1x_a6000",
- "description": "1x RTX A6000"
}, - "jupyter_token": "",
- "jupyter_url": ""
}
]
}
}
}Retrieve information about a coupon.
A coupon is a discount code that can be applied to an instance when deployed.
Request Body schema: application/jsonrequired
| coupon | string The coupon code you want to retrieve information about |
Responses
Request samples
- Payload
{- "coupon": "string"
}Response samples
- 200
{- "coupon": {
- "code": "TestCoupon",
- "discountPercent": 0.1,
- "deactivationDate": "2024-08-07T16:41:43.000Z"
}
}Retrieve products that a coupon is valid for.
A coupon is a discount code that can be applied to an instance when deployed.
Request Body schema: application/jsonrequired
| coupon | string The coupon code you want to retrieve information about |
Responses
Request samples
- Payload
{- "coupon": "string"
}Response samples
- 200
{- "couponValidation": {
- "coupon": {
- "code": "TestCoupon",
- "discountPercent": 0.1,
- "deactivationDate": "2024-08-07T16:41:43.000Z"
}, - "productDetails": [
- [
- {
- "name": "gpu_1x_a6000",
- "description": "1x RTX A6000",
- "pricePerHour": "0.625000",
- "inventoryAvailable": true
}, - {
- "name": "gpu_2x_a6000",
- "description": "2x RTX A6000",
- "pricePerHour": "1.250000",
- "inventoryAvailable": true
}, - {
- "name": "gpu_4x_a6000",
- "description": "4x RTX A6000",
- "pricePerHour": "2.500000",
- "inventoryAvailable": true
}, - {
- "name": "gpu_8x_a6000",
- "description": "8x RTX A6000",
- "pricePerHour": "5.000000",
- "inventoryAvailable": false
}
]
]
}
}