Skip to content

List GPU Instances

GET
/v1/instances
curl --request GET \
--url https://example.com/v1/instances

List available GPU instances and pricing from the pipeline API.

x-api-key
string | null

List of available GPU instances with pricing

Media type application/json
InstancesListResponse

Response containing available GPU instances.

object
data
required

List of available instances

Array<object>
Instance

A single GPU instance type.

object
id
required

Instance type ID (use this when creating finetune jobs)

string
name
required

Instance flavor name

string
description
required

Instance description

string
gpu_description
required

Clean GPU description

string
credits_per_hour
required

Cost in credits per hour

integer
driver

Compute driver that serves this type (for compute hints)

string
""
specs
required
InstanceSpecs

Hardware specifications

object
vcpus
required

Number of virtual CPUs

integer
memory_gib
required

Memory in GiB

integer
storage_gib

Storage in GiB (0 when unknown)

integer
0
gpu_count
required

Number of GPUs

integer
gpu_type
required

GPU model name

string
gpu_vram_gib

GPU VRAM per device in GiB (0 when unknown)

integer
0
regions

Available regions

Array<object>
InstanceRegion

A region where an instance is available.

object
name
required

Region identifier

string
description
required

Human-readable region name

string
region_count

Number of available regions

integer
default: 1
Example
{
"data": [
{
"driver": "",
"specs": {
"storage_gib": 0,
"gpu_vram_gib": 0
},
"region_count": 1
}
]
}

Invalid or missing API key

Media type application/json
ErrorResponse

Standard error response.

object
detail
required

Error message describing what went wrong

string
Example generated
{
"detail": "example"
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationError
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}