Estimate machine cost

POST

pricing

estimate

curl --request POST \
  --url "https://api.bead.run/v1/pricing/estimate" \
  --header "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "size": "small",
  "duration_seconds": 3600,
  "machines": 1
}
JSON

from beadrun import pricing

quote = pricing.estimate(size="small", duration_seconds=3600)

import { pricing } from "@beadrun/sdk";

const quote = await pricing.estimate({ size: "small", duration_seconds: 3600 });

{
  "price_version": "<string>",
  "currency": "<string>",
  "cpu": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  },
  "memory": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  },
  "storage": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  },
  "desktop": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  },
  "total": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  }
}

Authentication

This endpoint is public and does not require authentication.

Request body

The JSON body is required.

string

Named machine size; use instead of vcpus and memory_mib. Allowed values: "xs", "small", "medium", "large", "xlarge".

string

Size name for a monthly workload quote. Allowed values: "xs", "small", "medium", "large", "xlarge".

integer

CPUs per machine when quoting explicit dimensions. Minimum: 1. Maximum: 128.

integer

Memory per machine in MiB for an explicit dimension quote. Minimum: 1. Maximum: 1048576.

integer

Retained disk per machine in MiB for an explicit dimension quote. Minimum: 0. Maximum: 16777216.

integer

Session length in seconds; required for sized and dimension quotes. Minimum: 1. Maximum: 86400.

integer

default:1

Number of machines in a sized or dimension quote. Minimum: 1. Maximum: 256.

integer

Retained storage bytes; required for monthly quotes, optional for sized quotes. Minimum: 0.

integer

Monthly session count; required for a monthly quote. Minimum: 0.

integer

Seconds in each monthly session; required for a monthly quote. Minimum: 0.

integer

Peak monthly concurrency; required for a monthly quote. Minimum: 0. Maximum: 10.

CPU busy fraction in basis points; required for a monthly quote. Minimum: 0. Maximum: 10000.

boolean

default:false

Quote retained storage without running CPU and memory.

boolean

default:false

Include the live desktop add-on during running time.

curl --request POST \
  --url "https://api.bead.run/v1/pricing/estimate" \
  --header "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "size": "small",
  "duration_seconds": 3600,
  "machines": 1
}
JSON

from beadrun import pricing

quote = pricing.estimate(size="small", duration_seconds=3600)

import { pricing } from "@beadrun/sdk";

const quote = await pricing.estimate({ size: "small", duration_seconds: 3600 });

Response

200

Cost estimate for the supplied workload.

string

required

Version of the tariff used for the quote.

string

required

Currency for the quoted amounts. Allowed values: "usd".

object

required

Exact charge with a decimal USD display value.

Show Properties

string

required

USD amount rendered to twelve decimal places.

string

required

Exact charge numerator in credit units; encoded as a string to preserve precision.

string

required

Denominator for the exact charge numerator, before conversion to USD.

object

required

Exact charge with a decimal USD display value.

Show Properties

string

required

USD amount rendered to twelve decimal places.

string

required

Exact charge numerator in credit units; encoded as a string to preserve precision.

string

required

Denominator for the exact charge numerator, before conversion to USD.

object

required

Exact charge with a decimal USD display value.

Show Properties

string

required

USD amount rendered to twelve decimal places.

string

required

Exact charge numerator in credit units; encoded as a string to preserve precision.

string

required

Denominator for the exact charge numerator, before conversion to USD.

object

Exact charge with a decimal USD display value.

Show Properties

string

required

USD amount rendered to twelve decimal places.

string

required

Exact charge numerator in credit units; encoded as a string to preserve precision.

string

required

Denominator for the exact charge numerator, before conversion to USD.

object

required

Exact charge with a decimal USD display value.

Show Properties

string

required

USD amount rendered to twelve decimal places.

string

required

Exact charge numerator in credit units; encoded as a string to preserve precision.

string

required

Denominator for the exact charge numerator, before conversion to USD.

Errors

Status	Meaning
400	Unknown size, invalid dimensions, non-boolean desktop, arithmetic overflow, or monthly workload above concurrency capacity.
413	Request body exceeds the route limit.
422	JSON does not match the request types or required fields.
503	Service or persistence is temporarily unavailable.

curl --request POST \
  --url "https://api.bead.run/v1/pricing/estimate" \
  --header "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "size": "small",
  "duration_seconds": 3600,
  "machines": 1
}
JSON

from beadrun import pricing

quote = pricing.estimate(size="small", duration_seconds=3600)

import { pricing } from "@beadrun/sdk";

const quote = await pricing.estimate({ size: "small", duration_seconds: 3600 });

{
  "price_version": "<string>",
  "currency": "<string>",
  "cpu": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  },
  "memory": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  },
  "storage": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  },
  "desktop": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  },
  "total": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  }
}

Start here

Endpoints

Estimate machine cost

Authentication

Request body

Response

200

Errors

​Authentication

​Request body

​Response

​200

​Errors

Authentication

Request body

Response

200

Errors