Bids

Get Bids

Get all Spot bids for a project

get

/v2/spot/bids

Authorizations

Query parameters

next_cursorany of

sort_bystring · enum | nullable

Options: created_at, status

sort_dirstring · enum | nullable

Options: asc, desc

projectstringrequired

instance_typestring | nullable

Example: it_abc123456

regionstring | nullable

Example: us-central1-a

statusstring · enum | nullable

Options: Open, Allocated, Preempting, Terminated

limitinteger | nullable

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.mlfoundry.com/v2/spot/bids?project=text' \
  --header 'Authorization: Bearer fkey_<key>'

200

422

200

{
  "data": [
    {
      "fid": "bid_abc123456",
      "name": "text",
      "project": "proj_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_abc123456"
        ],
        "ssh_keys": [
          "sshkey_abc123456"
        ],
        "startup_script": "text",
        "kubernetes_cluster": "clust_abc123456"
      },
      "status": "Open"
    }
  ],
  "next_cursor": "text"
}

Successful Response

Create Bid

Place a new Spot bid

post

/v2/spot/bids

Authorizations

Body

projectstringrequired

Example: proj_abc123456

regionstringrequired

Example: us-central1-a

instance_typestringrequired

Example: it_abc123456

limit_pricestringrequired

Example: $25.60

instance_quantityintegerrequired

Example: 4

namestringrequired

launch_specificationobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.mlfoundry.com/v2/spot/bids' \
  --header 'Authorization: Bearer fkey_<key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "project": "proj_abc123456",
    "region": "us-central1-a",
    "instance_type": "it_abc123456",
    "limit_price": "$25.60",
    "instance_quantity": 4,
    "name": "text",
    "launch_specification": {
      "volumes": [
        "vol_abc123456"
      ],
      "ssh_keys": [
        "sshkey_abc123456"
      ],
      "startup_script": "text",
      "kubernetes_cluster": "clust_abc123456"
    }
  }'

201

422

201

{
  "fid": "bid_abc123456",
  "name": "text",
  "project": "proj_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_abc123456"
    ],
    "ssh_keys": [
      "sshkey_abc123456"
    ],
    "startup_script": "text",
    "kubernetes_cluster": "clust_abc123456"
  },
  "status": "Open"
}

Successful Response

Cancel Bid

Cancel a Spot bid

delete

/v2/spot/bids/{bid_fid}

Authorizations

Path parameters

bid_fidstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.mlfoundry.com/v2/spot/bids/{bid_fid}' \
  --header 'Authorization: Bearer fkey_<key>'

204

422

204

No body

Successful Response

Update Bid

Update the limit price of a Spot bid

patch

/v2/spot/bids/{bid_fid}

Authorizations

Path parameters

bid_fidstringrequired

Body

limit_pricestringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.mlfoundry.com/v2/spot/bids/{bid_fid}' \
  --header 'Authorization: Bearer fkey_<key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "limit_price": "text"
  }'

200

422

200

{
  "fid": "bid_abc123456",
  "name": "text",
  "project": "proj_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_abc123456"
    ],
    "ssh_keys": [
      "sshkey_abc123456"
    ],
    "startup_script": "text",
    "kubernetes_cluster": "clust_abc123456"
  },
  "status": "Open"
}

Successful Response