获取报价 | xAPI Documentation

const url = 'https://sandbox.xapi.to/v1/quotes';
const options = {
  method: 'POST',
  headers: {'XAPI-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"requirements":{"cpu":{"min":1},"memoryGiB":{"min":1},"capabilities":["exec","files"]},"maxEstimatedHourlyUsd":"0.20"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "quoteId": "eyJhbGciOiJIUzI1NiJ9.REDACTED",
  "expiresAt": "2026-08-13T08:30:00.000Z",
  "offering": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "General purpose Sandbox",
    "resources": {
      "cpu": 1,
      "memoryGiB": 1,
      "volumeGiB": 3
    },
    "capabilities": {
      "exec": true,
      "files": true,
      "ports": true
    }
  },
  "estimatedHourlyUsd": "0.07693488",
  "usageReservationUsd": "0.00641124",
  "shutdownReservationUsd": "0.00064112",
  "initialReservationUsd": "0.00705236"
}

按能力、资源和预算选择一个兼容规格并返回短期 quoteId。不会创建实例，但创建时应尽快使用返回的 quoteId。

Authentication

XAPI-Keystring

在 xAPI Console 创建的 API Key。只会发送给 *.xapi.to。

Request

This endpoint expects an object.

requirementsobjectRequired

本次任务需要的环境、资源、区域和能力约束。

maxEstimatedHourlyUsdstringOptionalformat: "^\d+(?:\.\d{1,18})?$"

每小时预估费用的硬上限，USD 十进制字符串；没有低于该上限的兼容规格时不会报价。

Response

报价成功

quoteIdstring

创建时传给 selection.quoteId 的签名报价凭证；只用于一个业务创建，同一幂等键重试可复用。

expiresAtdatetime

quoteId 失效时间（UTC ISO 8601）；过期后必须重新报价。

offeringobject

本次 requirements 匹配出的具体规格和能力快照。

estimatedHourlyUsdstring

offering 在默认运行状态下的预估小时费用，USD 十进制字符串，不是最终扣费。

usageReservationUsdstringOptional

首个滚动用量窗口预计需要预留的金额。

shutdownReservationUsdstringOptional

为实例安全销毁预留的最大关机费用金额。

initialReservationUsdstringOptional

创建前所需初始预留总额，通常等于 usageReservationUsd + shutdownReservationUsd。

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error