Spot

Get Bids

get

Get all Spot bids for a project

Authorizations
Query parameters
next_cursorany ofOptional
anyOptional
or
nullOptional
sort_bystring · enum | nullableOptionalPossible values:
sort_dirstring · enum | nullableOptionalPossible values:
projectstringRequired
instance_typestring | nullableOptionalExample: it_abc123456
regionstring | nullableOptionalExample: us-central1-a
statusstring · enum | nullableOptionalPossible values:
limitinteger | nullableOptional
Responses
200

Successful Response

application/json
get
/v2/spot/bids
GET /v2/spot/bids?project=text HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "fid": "bid_abc123456",
      "name": "text",
      "project": "proj_abc123456",
      "created_by": "user_abc123456",
      "created_at": "2024-01-01T00:00:00Z",
      "deactivated_at": "2024-01-01T00:00:00Z",
      "limit_price": "$15.60",
      "instance_quantity": 4,
      "instance_type": "it_abc123456",
      "region": "us-central1-a",
      "instances": [
        "inst_abc123456"
      ],
      "launch_specification": {
        "volumes": [
          "vol_1234567890",
          "vol_1234567891"
        ],
        "ssh_keys": [
          "sshkey_1234567890",
          "sshkey_1234567891"
        ],
        "startup_script": "text",
        "kubernetes_cluster": "clust_abc123456",
        "image_version": "imgver_abc123456"
      },
      "status": "Open"
    }
  ],
  "next_cursor": "text"
}

Create Bid

post

Place a new Spot bid

Authorizations
Body
projectstringRequiredExample: proj_abc123456
regionstringRequiredExample: us-central1-a
instance_typestringRequiredExample: it_abc123456
limit_pricestringRequiredExample: $25.60
instance_quantityintegerRequiredExample: 4
namestringRequired
Responses
201

Successful Response

application/json
post
/v2/spot/bids
POST /v2/spot/bids HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 365

{
  "project": "proj_abc123456",
  "region": "us-central1-a",
  "instance_type": "it_abc123456",
  "limit_price": "$25.60",
  "instance_quantity": 4,
  "name": "text",
  "launch_specification": {
    "volumes": [
      "vol_1234567890",
      "vol_1234567891"
    ],
    "ssh_keys": [
      "sshkey_1234567890",
      "sshkey_1234567891"
    ],
    "startup_script": "text",
    "kubernetes_cluster": "clust_abc123456",
    "image_version": "imgver_abc123456"
  }
}
{
  "fid": "bid_abc123456",
  "name": "text",
  "project": "proj_abc123456",
  "created_by": "user_abc123456",
  "created_at": "2024-01-01T00:00:00Z",
  "deactivated_at": "2024-01-01T00:00:00Z",
  "limit_price": "$15.60",
  "instance_quantity": 4,
  "instance_type": "it_abc123456",
  "region": "us-central1-a",
  "instances": [
    "inst_abc123456"
  ],
  "launch_specification": {
    "volumes": [
      "vol_1234567890",
      "vol_1234567891"
    ],
    "ssh_keys": [
      "sshkey_1234567890",
      "sshkey_1234567891"
    ],
    "startup_script": "text",
    "kubernetes_cluster": "clust_abc123456",
    "image_version": "imgver_abc123456"
  },
  "status": "Open"
}

Get Bid

get

Get a single Spot bid by FID

Authorizations
Path parameters
bid_fidstringRequired
Responses
200

Successful Response

application/json
get
/v2/spot/bids/{bid_fid}
GET /v2/spot/bids/{bid_fid} HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "fid": "bid_abc123456",
  "name": "text",
  "project": "proj_abc123456",
  "created_by": "user_abc123456",
  "created_at": "2024-01-01T00:00:00Z",
  "deactivated_at": "2024-01-01T00:00:00Z",
  "limit_price": "$15.60",
  "instance_quantity": 4,
  "instance_type": "it_abc123456",
  "region": "us-central1-a",
  "instances": [
    "inst_abc123456"
  ],
  "launch_specification": {
    "volumes": [
      "vol_1234567890",
      "vol_1234567891"
    ],
    "ssh_keys": [
      "sshkey_1234567890",
      "sshkey_1234567891"
    ],
    "startup_script": "text",
    "kubernetes_cluster": "clust_abc123456",
    "image_version": "imgver_abc123456"
  },
  "status": "Open"
}

Cancel Bid

delete

Cancel a Spot bid

Authorizations
Path parameters
bid_fidstringRequired
Responses
204

Successful Response

No content
delete
/v2/spot/bids/{bid_fid}
DELETE /v2/spot/bids/{bid_fid} HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Bid

patch

Update the limit price of a Spot bid

Authorizations
Path parameters
bid_fidstringRequired
Body
limit_pricestring | nullableOptional
pausedboolean | nullableOptional
volumesstring[] | nullableOptional
Responses
200

Successful Response

application/json
patch
/v2/spot/bids/{bid_fid}
PATCH /v2/spot/bids/{bid_fid} HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "limit_price": "text",
  "paused": true,
  "volumes": [
    "vol_abc123456"
  ]
}
{
  "fid": "bid_abc123456",
  "name": "text",
  "project": "proj_abc123456",
  "created_by": "user_abc123456",
  "created_at": "2024-01-01T00:00:00Z",
  "deactivated_at": "2024-01-01T00:00:00Z",
  "limit_price": "$15.60",
  "instance_quantity": 4,
  "instance_type": "it_abc123456",
  "region": "us-central1-a",
  "instances": [
    "inst_abc123456"
  ],
  "launch_specification": {
    "volumes": [
      "vol_1234567890",
      "vol_1234567891"
    ],
    "ssh_keys": [
      "sshkey_1234567890",
      "sshkey_1234567891"
    ],
    "startup_script": "text",
    "kubernetes_cluster": "clust_abc123456",
    "image_version": "imgver_abc123456"
  },
  "status": "Open"
}

Get Auctions

get

Get the Spot availability across all regions.

Authorizations
Responses
200

Successful Response

application/json
get
/v2/spot/availability
GET /v2/spot/availability HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful Response

[
  {
    "fid": "auc_abc123456",
    "instance_type": "it_abc123456",
    "region": "us-central1-a",
    "capacity": 512,
    "last_instance_price": "$10.00"
  }
]
PreviousSSH KeysNextLifecycle scripts