NetMind Power Documentation
  • NetMind Account
  • Inference
    • Model APIs
    • Dedicated Endpoints
  • Fine-tuning
  • Rent GPUs
    • Cloud Sync
    • Use Ngrok as Ingress Service
  • Rent Cluster (Comming soon)
  • API
    • API token
    • Files
    • Fine-tuning
      • List Models
      • Preparing your dataset
      • Create Job
      • Retrieve job
      • Download model
      • Cancel job
      • Deploy Checkpoint (coming soon)
    • Inference
      • Chat
      • Images
      • Haiper Inference
      • Asynchronous Inference
      • Dedicated Endpoints
      • Batch Processing
      • Embedding API
      • Deprecated Models
    • Rent GPU
      • SSH Authentication
      • List Available images
      • List Available GPU Instances
      • Create Your First Environment
      • Stop GPU instace
    • API Reference
      • Files
      • Fine-tuning
      • Rent GPU
Powered by GitBook
On this page

Was this helpful?

  1. API
  2. API Reference

Rent GPU

PreviousFine-tuning

Last updated 2 months ago

Was this helpful?

Machine List

Authentication

Images (Environment Template)

Container (Running Environment)

Get Auth List

get
Query parameters
markerintegerOptional

The marker of the last auth you got, not specified if you want to get the first page.

limitintegerOptional

The number of auths you want to get.

Default: 10
Header parameters
AuthorizationstringRequired

Your API token

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/rentgpu/auths/ HTTP/1.1
Host: api.netmind.ai
Authorization: text
Accept: */*

[
  {
    "id": 1,
    "value": "text",
    "created_at": "2025-05-02T19:31:26.495Z"
  }
]

Get Auth

get
Path parameters
auth_idintegerRequired

The ID of the container authorization you want to get.

Header parameters
AuthorizationstringRequired

Your API token

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/rentgpu/auths/{auth_id} HTTP/1.1
Host: api.netmind.ai
Authorization: text
Accept: */*

{
  "id": 1,
  "value": "text",
  "created_at": "2025-05-02T19:31:26.495Z"
}

Get Image List

get
Query parameters
image_typeall ofOptional

Image type you want to filter, the value can be OFFICIAL, PUBLIC, CUSTOM, default is OFFICIAL

Default: 0
integer · enumOptional

An enumeration.

Possible values:
markerstringOptional

The marker id of the image you got, used for pagination

limitintegerOptional

The number of images you want to get, default is 10

Default: 10
Header parameters
AuthorizationstringRequired

Your API token

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/rentgpu/images/ HTTP/1.1
Host: api.netmind.ai
Authorization: text
Accept: */*

[
  {
    "name": "text",
    "description": "text",
    "image_name": "text",
    "image_tag": "text",
    "image_label": "text",
    "docker_username": "text",
    "docker_passwd": "text",
    "docker_registry": "text",
    "public_port": "text",
    "onstart": "text",
    "options": "text",
    "image_type": 0,
    "id": 1,
    "created_at": "2025-05-02T19:31:26.495Z"
  }
]

Get Image

get
Path parameters
image_idintegerRequired

The id of the image you want to get

Header parameters
AuthorizationstringRequired

Your API token

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/rentgpu/images/{image_id} HTTP/1.1
Host: api.netmind.ai
Authorization: text
Accept: */*

{
  "name": "text",
  "description": "text",
  "image_name": "text",
  "image_tag": "text",
  "image_label": "text",
  "docker_username": "text",
  "docker_passwd": "text",
  "docker_registry": "text",
  "public_port": "text",
  "onstart": "text",
  "options": "text",
  "image_type": 0,
  "id": 1,
  "created_at": "2025-05-02T19:31:26.495Z"
}

Get Container List

get
Query parameters
limitintegerOptional

The number of containers you want to get, default is 10

Default: 10
markerintegerOptional

The marker of the last container id you got, not specified by default, you can use it to get the next page

Header parameters
AuthorizationstringRequired

Your API token

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/rentgpu/containers/ HTTP/1.1
Host: api.netmind.ai
Authorization: text
Accept: */*

[
  {
    "name": "text",
    "auth_id": 1,
    "gpu": 1,
    "node_name": "text",
    "image_template_id": 1,
    "enable_vscode": true,
    "enable_jupyter": true,
    "cpu": 1,
    "disk_size": 1,
    "memory": 1,
    "gpu_name": 1,
    "id": 1,
    "ssh": "text",
    "status": 0,
    "exposed_service": "text",
    "vscode_service": "text",
    "jupyter_service": "text",
    "created_at": "2025-05-02T19:31:26.495Z"
  }
]

Get Container

get
Path parameters
container_idintegerRequired

Container id you want to get

Header parameters
AuthorizationstringRequired

Your API token

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/rentgpu/containers/{container_id} HTTP/1.1
Host: api.netmind.ai
Authorization: text
Accept: */*

{
  "name": "text",
  "auth_id": 1,
  "gpu": 1,
  "node_name": "text",
  "image_template_id": 1,
  "enable_vscode": true,
  "enable_jupyter": true,
  "cpu": 1,
  "disk_size": 1,
  "memory": 1,
  "gpu_name": 1,
  "id": 1,
  "ssh": "text",
  "status": 0,
  "exposed_service": "text",
  "vscode_service": "text",
  "jupyter_service": "text",
  "created_at": "2025-05-02T19:31:26.495Z"
}

Stop Container

post
Path parameters
container_idintegerRequired

Container id you want to stop

Header parameters
AuthorizationstringRequired

Your API token

Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/rentgpu/containers/{container_id}/stop HTTP/1.1
Host: api.netmind.ai
Authorization: text
Accept: */*

{
  "name": "text",
  "auth_id": 1,
  "gpu": 1,
  "node_name": "text",
  "image_template_id": 1,
  "enable_vscode": true,
  "enable_jupyter": true,
  "cpu": 1,
  "disk_size": 1,
  "memory": 1,
  "gpu_name": 1,
  "id": 1,
  "ssh": "text",
  "status": 0,
  "exposed_service": "text",
  "vscode_service": "text",
  "jupyter_service": "text",
  "created_at": "2025-05-02T19:31:26.495Z"
}

Restart Container

post
Path parameters
container_idintegerRequired

Container id you want to restart

Header parameters
AuthorizationstringRequired

Your API token

Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/rentgpu/containers/{container_id}/restart HTTP/1.1
Host: api.netmind.ai
Authorization: text
Accept: */*

{
  "name": "text",
  "auth_id": 1,
  "gpu": 1,
  "node_name": "text",
  "image_template_id": 1,
  "enable_vscode": true,
  "enable_jupyter": true,
  "cpu": 1,
  "disk_size": 1,
  "memory": 1,
  "gpu_name": 1,
  "id": 1,
  "ssh": "text",
  "status": 0,
  "exposed_service": "text",
  "vscode_service": "text",
  "jupyter_service": "text",
  "created_at": "2025-05-02T19:31:26.495Z"
}

Delete Container

delete
Path parameters
container_idintegerRequired

Container id you want to delete

Header parameters
AuthorizationstringRequired

Your API token

Responses
200
Successful Response
application/json
422
Validation Error
application/json
delete
DELETE /v1/rentgpu/containers/{container_id} HTTP/1.1
Host: api.netmind.ai
Authorization: text
Accept: */*

{
  "name": "text",
  "auth_id": 1,
  "gpu": 1,
  "node_name": "text",
  "image_template_id": 1,
  "enable_vscode": true,
  "enable_jupyter": true,
  "cpu": 1,
  "disk_size": 1,
  "memory": 1,
  "gpu_name": 1,
  "id": 1,
  "ssh": "text",
  "status": 0,
  "exposed_service": "text",
  "vscode_service": "text",
  "jupyter_service": "text",
  "created_at": "2025-05-02T19:31:26.495Z"
}

Create Auth

post
Header parameters
AuthorizationstringRequired

Your API token

Body
valuestring · min: 8 · max: 32Required

The password of your SSH container.

Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/rentgpu/auths/ HTTP/1.1
Host: api.netmind.ai
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "value": "text"
}
{
  "id": 1,
  "value": "text",
  "created_at": "2025-05-02T19:31:26.495Z"
}

Create Custom Image

post
Header parameters
AuthorizationstringRequired

Your API token

Body
namestringRequired

The name of the image

descriptionstringOptional

The description of the image

image_namestringRequired

The name of the image, such as pytorch/pytorch or tensorflow/tensorflow.

image_tagstringRequired

The version of the image, such as 1.8.0, 2.6.0 or latest.

image_labelstringRequired

The label of the image, such as pytorch, tensorflow or unbuntu.

docker_usernamestringOptional

The username of the docker registry if it is private

docker_passwdstringOptional

The password of the docker registry if it is private

docker_registrystringOptional

The docker registry if it is private, the default is https://index.docker.io/v1/

Default: https://index.docker.io/v1/
public_portstringOptional

Public port you want to expose from this container, it's optional

onstartstringOptional

The command you want to run when the container starts, it is not required

optionsstringOptional

The options you want to pass to the container, only support --add-host, -e, -h, -w, it is not required

Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/rentgpu/images/ HTTP/1.1
Host: api.netmind.ai
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "name": "text",
  "description": "text",
  "image_name": "text",
  "image_tag": "text",
  "image_label": "text",
  "docker_username": "text",
  "docker_passwd": "text",
  "docker_registry": "text",
  "public_port": "text",
  "onstart": "text",
  "options": "text"
}
{
  "name": "text",
  "description": "text",
  "image_name": "text",
  "image_tag": "text",
  "image_label": "text",
  "docker_username": "text",
  "docker_passwd": "text",
  "docker_registry": "text",
  "public_port": "text",
  "onstart": "text",
  "options": "text",
  "image_type": 0,
  "id": 1,
  "created_at": "2025-05-02T19:31:26.495Z"
}

Create Container

post
Header parameters
AuthorizationstringRequired

Your API token

Body
namestringRequired

Your container name.

auth_idintegerRequired

Auth id, You should create a container authorization first.

gpuinteger · max: 12Required

GPU number you want to rent.

Default: 1
node_namestringRequired

Node name returned by the query machine interface.

image_template_idintegerRequired

You can choose an image template or create a new one.

payment_typeall ofRequired

Payment type, an enum value, you can choose USD, NMT or CNY, mean what currency is used from your balance deducting fees.

integer · enumOptional

An enumeration.

Possible values:
Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/rentgpu/containers/ HTTP/1.1
Host: api.netmind.ai
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "name": "text",
  "auth_id": 1,
  "gpu": 1,
  "node_name": "text",
  "image_template_id": 1,
  "payment_type": 0
}
{
  "name": "text",
  "auth_id": 1,
  "gpu": 1,
  "node_name": "text",
  "image_template_id": 1,
  "enable_vscode": true,
  "enable_jupyter": true,
  "cpu": 1,
  "disk_size": 1,
  "memory": 1,
  "gpu_name": 1,
  "id": 1,
  "ssh": "text",
  "status": 0,
  "exposed_service": "text",
  "vscode_service": "text",
  "jupyter_service": "text",
  "created_at": "2025-05-02T19:31:26.495Z"
}

List Machines

get
Query parameters
currencystring · enumOptionalDefault: USDPossible values:
regionstringOptional

Enumeration types supported: 'HK', 'SE', 'CZ', 'CA', 'RO', 'US', 'ES', 'BR', 'CN', 'JP', 'DE', 'AU', 'IT', 'RU', 'PL', 'VN', 'PH', 'TW', 'NL', 'RS', 'SG', 'AR', 'NZ', 'FI', 'IN', 'BG', 'NO', 'EE', 'MY', 'BH', 'GB', 'LT'

gpuintegerOptional

Comma-separated GPU types. Supported types are: 'NVIDIA_GeForce_RTX_3090', 'NVIDIA_GeForce_RTX_3090_Ti', 'NVIDIA_GeForce_RTX_4090', 'NVIDIA_A100_SXM4_80GB', 'NVIDIA_H100_SXM5_80GB', 'NVIDIA_A100_80GB_PCIe', 'NVIDIA_A100_PCIE_80GB', 'NVIDIA_ A800_PCIe_40GB', 'NVIDIA_A100_SXM4_40GB', 'NVIDIA_A100_PCIE_40GB', 'NVIDIA_GeForce_RTX_A6000', 'NVIDIA_Quadro_RTX_8000', 'NVIDIA_GeForce_RTX_4080', 'Tesla_V100_PCIE_32GB', 'Tesla_V100_SXM2_32GB', 'NVIDIA_Quadro_RTX_6000', 'NVIDIA_GeForce_RTX_3080', 'NVIDIA_GeForce_RTX_4070_Ti', 'Tesla_V100_PCIE_16GB', 'TITAN_RTX', 'Tesla_V100_SXM2_16GB', 'NVIDIA_GeForce_RTX_3070', 'TITAN_V', 'NVIDIA_GeForce_RTX_4060_Ti', 'NVIDIA_GeForce_RTX_2080_SUPER', 'NVIDIA_GeForce_RTX_2080_Ti', 'NVIDIA_GeForce_RTX_4060', 'NVIDIA_GeForce_RTX_2080', 'TITAN_Xp', 'NVIDIA_GeForce_RTX_2070_SUPER', 'NVIDIA_GeForce_GTX_1080_Ti', 'NVIDIA_GeForce_RTX_3060', 'TITAN_X_Pascal', 'NVIDIA_GeForce_RTX_2060_SUPER', 'NVIDIA_GeForce_RTX_2070', 'NVIDIA_GeForce_GTX_1070_Ti', 'NVIDIA_GeForce_RTX_3060_Laptop_GPU', 'NVIDIA_GeForce_GTX_1080', 'NVIDIA_GeForce_GTX_1070', 'NVIDIA_GeForce_GTX_1660_Ti', 'NVIDIA_GeForce_GTX_1060_6GB', 'Tesla_M60', 'NVIDIA_RTX_6000_Ada_Generation'.

Default: 1
gpu_namesstringOptional
min_memoryintegerOptional
max_memoryintegerOptional
min_diskintegerOptional
max_diskintegerOptional
min_priceintegerOptional
max_priceintegerOptional
Header parameters
AuthorizationstringRequired

Your API token

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/rentgpu/machines HTTP/1.1
Host: api.netmind.ai
Authorization: text
Accept: */*

[
  {
    "on_demand": "text",
    "labels": [
      "text"
    ],
    "node_name": "text",
    "cluster": "text",
    "gpu_name": "text",
    "gpu_count": 1,
    "gpu_memory": 1,
    "cpu_name": "text",
    "cpu_count": 1,
    "cpu_per_gpu": 1,
    "memory_per_gpu": 1,
    "memory_total": 1,
    "disk_per_gpu": 1,
    "disk_total": 1,
    "region": "text",
    "network_upload_speed": 1,
    "network_download_speed": 1,
    "up_time": 1,
    "online_rate": 1,
    "price": "text",
    "original_price": "text",
    "gpu_id": 1,
    "organization": "text",
    "driver_version": "text",
    "cuda_version": "text",
    "nvlink_status": true
  }
]
  • Machine List
  • GETList Machines
  • Authentication
  • POSTCreate Auth
  • GETGet Auth List
  • GETGet Auth
  • Images (Environment Template)
  • POSTCreate Custom Image
  • GETGet Image List
  • GETGet Image
  • Container (Running Environment)
  • POSTCreate Container
  • GETGet Container List
  • GETGet Container
  • POSTStop Container
  • POSTRestart Container
  • DELETEDelete Container