Skip to content
Docs
Console

Page and section titles. Use your browser's find for words inside a page.

Reserved capacity

Reserve GPU groups for your organization. Capacity is shared across its models.

Authorization

Send Authorization: Bearer $BOARDWALK_API_KEY. Reads require floors:read; changes require floors:write.

Read capacity

Read reservations and rates
curl https://api.boardwalk.cloud/v1/floors \
  -H "Authorization: Bearer $BOARDWALK_API_KEY"

The endpoint accepts no query parameters or body and works at zero credits.

Response

The response has object: list, data, allowance, and card_classes. This finite capacity snapshot is unpaginated. All money is expressed as decimal-string micro-dollars; timestamps are ISO 8601 UTC.

dataobject[]
Configured groups: host_class, group_size, quantity, placed_cards, releasing_cards, rate_revision_id, published_rate_micros_per_gpu_hour, hourly_micros, rate_changes, and created_at.
allowanceobject
Organization capacity: used and allowed GPU counts.
card_classesobject[]
Published choices: name, rate_revision_id, gpus_per_host, gpu_name, memory_bytes_per_gpu, and floor_rate_micros_per_gpu_hour. A null floor rate means reservations are not offered for that class.

Set reserved capacity

PUT /v1/floors/{card_class} sets an absolute quantity. Use the name and reviewed rate revision from card_classes, and the current quantity from data (zero if the group has not been reserved).

Reserve one GPU group
curl -X PUT https://api.boardwalk.cloud/v1/floors/CARD_CLASS \
  -H "Authorization: Bearer $BOARDWALK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"group_size":1,"quantity":1,"expected_quantity":0,"rate_revision_id":"REVIEWED_RATE_REVISION_ID"}'
group_sizeintegerrequired
GPUs in each reserved group: 1, 2, 4, or 8, within the class’s GPUs per host.
quantityintegerrequired
Desired number of groups, 0–64. The group size multiplied by quantity cannot exceed 64 GPUs.
expected_quantityintegerrequired
The currently configured quantity you reviewed. Concurrent changes return 409.
rate_revision_idstring | nullrequired
Reviewed published rate revision. A price change on an increase returns 409. Reductions can send null.

Success returns 200 with the refreshed capacity snapshot. Increasing capacity needs credits and must fit the organization’s GPU allowance. Stale quantity or price returns 409; refresh, review, and submit again. Quantity zero releases capacity.

Billing

Reserved capacity can bill while models are idle, stopped, or deleted. Changing a model does not remove its organization’s reservations. Capacity reductions require no credits; releasing cards can remain visible until their current work drains. Placement is asynchronous, so configured quantity and placed cards can differ.