BUILD WITH INFERMAX
Compute Access
Follow eligible offers through reservation, provisioning, observation, and verified release.
GET
/v1/compute/offersGET/v1/compute/offers/{id}GET/v1/compute/limitsGET/v1/compute/offers/{id}/storagePOST/v1/compute/quotesGET/v1/compute/storage/profilesPOST/v1/compute/storage/quotesPOST/v1/compute/storage/volumesGET/v1/compute/storage/volumesGET/v1/compute/storage/volumes/{id}POST/v1/compute/storage/volumes/{id}/commandsGET/v1/compute/budgetGET/v1/compute/waitlistPOST/v1/compute/waitlistGET/v1/compute/waitlist/{id}POST/v1/compute/waitlist/{id}/cancelPOST/v1/compute/reservationsGET/v1/compute/reservationsGET/v1/compute/reservations/{id}POST/v1/compute/reservations/{id}/cancelPOST/v1/compute/instancesGET/v1/compute/instancesGET/v1/compute/instances/{id}GET/v1/compute/instances/{id}/eventsGET/v1/compute/instances/{id}/accessDELETE/v1/compute/instances/{id}GET/v1/allocations/{id}GET/v1/infrastructure/operations/{id}List eligible offers; availability is not a hold
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
limitquery | Optional | {
"maximum": 100,
"default": 50,
"type": "number"
} |
afterquery | Optional | {
"type": "string"
} |
searchquery | Optional | {
"type": "string"
} |
regionquery | Optional | {
"type": "string"
} |
availabilityquery | Optional | {
"type": "string",
"enum": [
"AVAILABLE",
"UNAVAILABLE"
]
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"pool_id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"published": {
"type": "boolean"
},
"price_per_unit_hour": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string"
},
"rate_status": {
"type": "string",
"enum": [
"UNKNOWN",
"FIXTURE",
"ACCEPTED"
]
},
"rate_version": {
"type": "string",
"format": "uuid"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"provider_id": {
"type": "string",
"format": "uuid"
},
"gpu_model": {
"type": "string"
},
"region": {
"type": "string"
},
"unit_gpus": {
"type": "integer"
},
"execution_mode": {
"type": "string"
},
"observed_at": {
"type": "string",
"format": "date-time"
},
"available_units": {
"type": "string",
"description": "Current availability in allocation units; reservation rechecks atomically."
}
}
}
},
"nextCursor": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}GET /v1/compute/offers/{id}
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"required": [
"id",
"pool_id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"published": {
"type": "boolean"
},
"price_per_unit_hour": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string"
},
"rate_status": {
"type": "string",
"enum": [
"UNKNOWN",
"FIXTURE",
"ACCEPTED"
]
},
"rate_version": {
"type": "string",
"format": "uuid"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"provider_id": {
"type": "string",
"format": "uuid"
},
"gpu_model": {
"type": "string"
},
"region": {
"type": "string"
},
"unit_gpus": {
"type": "integer"
},
"execution_mode": {
"type": "string"
},
"observed_at": {
"type": "string",
"format": "date-time"
},
"available_units": {
"type": "string",
"description": "Current availability in allocation units; reservation rechecks atomically."
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}GET /v1/compute/limits
Authorization: Bearer · project scope · management access required
Parameters
No additional parameters are declared.
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"gpu_quota": {
"type": "integer"
},
"occupied_gpus": {
"type": "string"
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Read storage options for an offer
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"required": [
"id",
"pool_id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"published": {
"type": "boolean"
},
"price_per_unit_hour": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string"
},
"rate_status": {
"type": "string",
"enum": [
"UNKNOWN",
"FIXTURE",
"ACCEPTED"
]
},
"rate_version": {
"type": "string",
"format": "uuid"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"provider_id": {
"type": "string",
"format": "uuid"
},
"gpu_model": {
"type": "string"
},
"region": {
"type": "string"
},
"unit_gpus": {
"type": "integer"
},
"execution_mode": {
"type": "string"
},
"observed_at": {
"type": "string",
"format": "date-time"
},
"available_units": {
"type": "string",
"description": "Current availability in allocation units; reservation rechecks atomically."
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Quote a compute request
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
Request body · required
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ManagedQuoteInput"
}Responses
201 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": true
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}List eligible storage profiles
Authorization: Bearer · project scope · management access required
Parameters
No additional parameters are declared.
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": 1
},
"digest": {
"type": "string"
},
"providerId": {
"type": "string",
"format": "uuid"
},
"executionMode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL"
]
},
"controller": {
"type": "string",
"enum": [
"FIXTURE",
"DSTACK"
]
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"sizesGiB": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"supportedActions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CREATE",
"ATTACH",
"DETACH",
"RETAIN",
"DELETE"
]
}
},
"available": {
"type": "boolean"
},
"reason": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"version",
"digest",
"providerId",
"executionMode",
"controller",
"regions",
"sizesGiB",
"supportedActions",
"available",
"reason"
]
}
}
},
"required": [
"items"
]
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Quote storage
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
Request body · required
application/json
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"properties": {
"profileId": {
"type": "string",
"maxLength": 100
},
"profileVersion": {
"type": "integer",
"minimum": 1
},
"region": {
"type": "string",
"maxLength": 100
},
"sizeGiB": {
"type": "integer",
"minimum": 1,
"maximum": 1048576
},
"liabilityEndAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"profileId",
"profileVersion",
"region",
"sizeGiB",
"liabilityEndAt"
]
}Responses
201 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"provider_id": {
"type": "string",
"format": "uuid"
},
"profile_digest": {
"type": "string"
},
"execution_mode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL"
]
},
"region": {
"type": "string"
},
"size_gib": {
"type": "integer",
"minimum": 1
},
"currency": {
"type": "string",
"enum": [
"USD"
]
},
"liability_micros": {
"type": "string",
"pattern": "^[0-9]+$",
"nullable": true
},
"liability_end_at": {
"type": "string",
"format": "date-time"
},
"valid_until": {
"type": "string",
"format": "date-time"
},
"terms_digest": {
"type": "string",
"nullable": true
},
"source_ref": {
"type": "string",
"nullable": true
},
"created_by": {
"type": "string",
"format": "uuid"
},
"created_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"project_id",
"provider_id",
"profile_digest",
"execution_mode",
"region",
"size_gib",
"currency",
"liability_micros",
"liability_end_at",
"valid_until",
"terms_digest",
"source_ref",
"created_by",
"created_at"
]
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Create a storage volume
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
Request body · required
application/json
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"properties": {
"quoteId": {
"type": "string",
"format": "uuid"
},
"retainOnRelease": {
"type": "boolean"
}
},
"required": [
"quoteId",
"retainOnRelease"
]
}Responses
201 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"provider_id": {
"type": "string",
"format": "uuid"
},
"profile_digest": {
"type": "string"
},
"execution_mode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL"
]
},
"region": {
"type": "string"
},
"size_gib": {
"type": "integer",
"minimum": 1
},
"quote_id": {
"type": "string",
"format": "uuid"
},
"controller": {
"type": "string",
"enum": [
"DSTACK",
"FIXTURE"
]
},
"retain_on_release": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"REQUESTED",
"CREATING",
"AVAILABLE",
"ATTACHING",
"ATTACHED",
"DETACHING",
"RETAINED",
"DELETING",
"ABSENT",
"UNKNOWN",
"FAILED"
]
},
"liability_status": {
"type": "string",
"enum": [
"UNKNOWN",
"RETAINED",
"RELEASED"
]
},
"version": {
"type": "integer",
"minimum": 0
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"project_id",
"provider_id",
"profile_digest",
"execution_mode",
"region",
"size_gib",
"quote_id",
"controller",
"retain_on_release",
"state",
"liability_status",
"version",
"created_at",
"updated_at"
]
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}List project storage volumes
Authorization: Bearer · project scope · management access required
Parameters
No additional parameters are declared.
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"provider_id": {
"type": "string",
"format": "uuid"
},
"profile_digest": {
"type": "string"
},
"execution_mode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL"
]
},
"region": {
"type": "string"
},
"size_gib": {
"type": "integer",
"minimum": 1
},
"retain_on_release": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"REQUESTED",
"CREATING",
"AVAILABLE",
"ATTACHING",
"ATTACHED",
"DETACHING",
"RETAINED",
"DELETING",
"ABSENT",
"UNKNOWN",
"FAILED"
]
},
"liability_status": {
"type": "string",
"enum": [
"UNKNOWN",
"RETAINED",
"RELEASED"
]
},
"version": {
"type": "integer",
"minimum": 0
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"cleanup_requested": {
"type": "boolean"
},
"currency": {
"type": "string",
"enum": [
"USD"
]
},
"liability_micros": {
"type": "string",
"pattern": "^[0-9]+$",
"nullable": true
},
"liability_end_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"project_id",
"provider_id",
"profile_digest",
"execution_mode",
"region",
"size_gib",
"retain_on_release",
"state",
"liability_status",
"version",
"created_at",
"updated_at",
"cleanup_requested",
"currency",
"liability_micros",
"liability_end_at"
]
}
},
"truncated": {
"type": "boolean"
}
},
"required": [
"items",
"truncated"
]
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Read a storage volume
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"provider_id": {
"type": "string",
"format": "uuid"
},
"profile_digest": {
"type": "string"
},
"execution_mode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL"
]
},
"region": {
"type": "string"
},
"size_gib": {
"type": "integer",
"minimum": 1
},
"retain_on_release": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"REQUESTED",
"CREATING",
"AVAILABLE",
"ATTACHING",
"ATTACHED",
"DETACHING",
"RETAINED",
"DELETING",
"ABSENT",
"UNKNOWN",
"FAILED"
]
},
"liability_status": {
"type": "string",
"enum": [
"UNKNOWN",
"RETAINED",
"RELEASED"
]
},
"version": {
"type": "integer",
"minimum": 0
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"cleanup_requested": {
"type": "boolean"
},
"currency": {
"type": "string",
"enum": [
"USD"
]
},
"liability_micros": {
"type": "string",
"pattern": "^[0-9]+$",
"nullable": true
},
"liability_end_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"project_id",
"provider_id",
"profile_digest",
"execution_mode",
"region",
"size_gib",
"retain_on_release",
"state",
"liability_status",
"version",
"created_at",
"updated_at",
"cleanup_requested",
"currency",
"liability_micros",
"liability_end_at"
]
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Request a storage lifecycle command
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
Request body · required
application/json
Schema · JSON
{
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"action": {
"type": "string",
"enum": [
"ATTACH",
"DETACH"
]
},
"instanceId": {
"type": "string",
"format": "uuid"
},
"expectedVersion": {
"type": "integer",
"minimum": 0
}
},
"required": [
"action",
"instanceId",
"expectedVersion"
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"action": {
"type": "string",
"enum": [
"RETAIN",
"DELETE"
]
},
"expectedVersion": {
"type": "integer",
"minimum": 0
}
},
"required": [
"action",
"expectedVersion"
]
}
]
}Responses
201 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"provider_id": {
"type": "string",
"format": "uuid"
},
"profile_digest": {
"type": "string"
},
"execution_mode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL"
]
},
"region": {
"type": "string"
},
"size_gib": {
"type": "integer",
"minimum": 1
},
"quote_id": {
"type": "string",
"format": "uuid"
},
"controller": {
"type": "string",
"enum": [
"DSTACK",
"FIXTURE"
]
},
"retain_on_release": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"REQUESTED",
"CREATING",
"AVAILABLE",
"ATTACHING",
"ATTACHED",
"DETACHING",
"RETAINED",
"DELETING",
"ABSENT",
"UNKNOWN",
"FAILED"
]
},
"liability_status": {
"type": "string",
"enum": [
"UNKNOWN",
"RETAINED",
"RELEASED"
]
},
"version": {
"type": "integer",
"minimum": 0
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"project_id",
"provider_id",
"profile_digest",
"execution_mode",
"region",
"size_gib",
"quote_id",
"controller",
"retain_on_release",
"state",
"liability_status",
"version",
"created_at",
"updated_at"
]
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Read project compute budget
Authorization: Bearer · project scope · management access required
Parameters
No additional parameters are declared.
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": true
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}List availability alerts
Authorization: Bearer · project scope · management access required
Parameters
No additional parameters are declared.
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"intent_id": {
"type": "string",
"format": "uuid"
},
"state": {
"type": "string"
},
"email_opt_in": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"spec": {
"type": "object"
}
},
"required": [
"id",
"intent_id",
"state",
"email_opt_in",
"created_at",
"spec"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
}400 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}401 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}403 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}404 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}409 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}413 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}422 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}429 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}500 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}503 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}Create an availability alert
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
Request body · required
application/json
Schema · JSON
{
"$ref": "#/components/schemas/WaitlistInput"
}Responses
201 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"state": {
"type": "string"
},
"email_opt_in": {
"type": "boolean"
}
},
"required": [
"id",
"state",
"email_opt_in"
],
"additionalProperties": false
}400 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}401 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}403 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}404 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}409 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}413 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}422 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}429 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}500 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}503 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}Read an availability alert
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"intent_id": {
"type": "string",
"format": "uuid"
},
"state": {
"type": "string"
},
"email_opt_in": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"spec": {
"type": "object"
}
},
"required": [
"id",
"intent_id",
"state",
"email_opt_in",
"created_at",
"spec"
],
"additionalProperties": false
}400 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}401 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}403 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}404 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}409 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}413 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}422 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}429 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}500 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}503 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}Cancel an availability alert
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
Responses
201 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"state": {
"type": "string"
}
},
"required": [
"id",
"state"
],
"additionalProperties": false
}400 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}401 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}403 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}404 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}409 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}413 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}422 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}429 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}500 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}503 Fail-closed request or dependency error.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}Hold whole allocation units for five minutes
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
Request body · required
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ReservationInput"
}Responses
201 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"required": [
"id",
"state",
"expires_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"offer_id": {
"type": "string",
"format": "uuid"
},
"units": {
"type": "integer"
},
"unit_gpus": {
"type": "integer"
},
"state": {
"type": "string",
"enum": [
"HELD",
"CONSUMED",
"CANCELLED",
"EXPIRED"
]
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"requested_end_at": {
"type": "string",
"format": "date-time"
},
"price_snapshot": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string"
},
"unit": {
"type": "string"
},
"status": {
"type": "string"
},
"version": {
"type": "string",
"format": "uuid"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}GET /v1/compute/reservations
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
limitquery | Optional | {
"maximum": 100,
"default": 50,
"type": "number"
} |
afterquery | Optional | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"state",
"expires_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"offer_id": {
"type": "string",
"format": "uuid"
},
"units": {
"type": "integer"
},
"unit_gpus": {
"type": "integer"
},
"state": {
"type": "string",
"enum": [
"HELD",
"CONSUMED",
"CANCELLED",
"EXPIRED"
]
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"requested_end_at": {
"type": "string",
"format": "date-time"
},
"price_snapshot": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string"
},
"unit": {
"type": "string"
},
"status": {
"type": "string"
},
"version": {
"type": "string",
"format": "uuid"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}
},
"nextCursor": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}GET /v1/compute/reservations/{id}
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"required": [
"id",
"state",
"expires_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"offer_id": {
"type": "string",
"format": "uuid"
},
"units": {
"type": "integer"
},
"unit_gpus": {
"type": "integer"
},
"state": {
"type": "string",
"enum": [
"HELD",
"CONSUMED",
"CANCELLED",
"EXPIRED"
]
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"requested_end_at": {
"type": "string",
"format": "date-time"
},
"price_snapshot": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string"
},
"unit": {
"type": "string"
},
"status": {
"type": "string"
},
"version": {
"type": "string",
"format": "uuid"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}POST /v1/compute/reservations/{id}/cancel
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"required": [
"id",
"state",
"expires_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"offer_id": {
"type": "string",
"format": "uuid"
},
"units": {
"type": "integer"
},
"unit_gpus": {
"type": "integer"
},
"state": {
"type": "string",
"enum": [
"HELD",
"CONSUMED",
"CANCELLED",
"EXPIRED"
]
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"requested_end_at": {
"type": "string",
"format": "date-time"
},
"price_snapshot": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string"
},
"unit": {
"type": "string"
},
"status": {
"type": "string"
},
"version": {
"type": "string",
"format": "uuid"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Consume hold and enqueue provisioning; poll returned instance ID
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
Request body · required
application/json
Schema · JSON
{
"$ref": "#/components/schemas/InstanceInput"
}Responses
202 Durable intent accepted. Poll the resource; compute is not ready yet.
application/json
Schema · JSON
{
"type": "object",
"required": [
"id",
"state",
"execution_mode",
"reservation_id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"reservation_id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"units": {
"type": "integer"
},
"unit_gpus": {
"type": "integer"
},
"execution_mode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL"
]
},
"state": {
"type": "string",
"enum": [
"REQUESTED",
"PROVISIONING",
"READY",
"RECONCILING",
"DRAINING",
"RELEASED"
]
},
"external_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requested_end_at": {
"type": "string",
"format": "date-time"
},
"expiry_review_required": {
"type": "boolean"
},
"version": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"ready_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"released_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}GET /v1/compute/instances
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
limitquery | Optional | {
"maximum": 100,
"default": 50,
"type": "number"
} |
afterquery | Optional | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"state",
"execution_mode",
"reservation_id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"reservation_id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"units": {
"type": "integer"
},
"unit_gpus": {
"type": "integer"
},
"execution_mode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL"
]
},
"state": {
"type": "string",
"enum": [
"REQUESTED",
"PROVISIONING",
"READY",
"RECONCILING",
"DRAINING",
"RELEASED"
]
},
"external_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requested_end_at": {
"type": "string",
"format": "date-time"
},
"expiry_review_required": {
"type": "boolean"
},
"version": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"ready_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"released_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
},
"nextCursor": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}GET /v1/compute/instances/{id}
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"required": [
"id",
"state",
"execution_mode",
"reservation_id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"reservation_id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"units": {
"type": "integer"
},
"unit_gpus": {
"type": "integer"
},
"execution_mode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL"
]
},
"state": {
"type": "string",
"enum": [
"REQUESTED",
"PROVISIONING",
"READY",
"RECONCILING",
"DRAINING",
"RELEASED"
]
},
"external_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requested_end_at": {
"type": "string",
"format": "date-time"
},
"expiry_review_required": {
"type": "boolean"
},
"version": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"ready_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"released_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}GET /v1/compute/instances/{id}/events
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
afterquery | Optional | {
"default": 0,
"type": "number"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sequence": {
"type": "string"
},
"type": {
"type": "string"
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Access status; transport integration deferred until provider access arrives
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"instanceId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"DEFERRED"
]
},
"executionMode": {
"type": "string"
},
"connection": {
"type": "string",
"nullable": true
},
"reason": {
"type": "string"
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Request release; capacity remains occupied until cleanup is verified
Authorization: Bearer · project scope · management access required
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
Responses
202 Durable intent accepted. Poll the resource; compute is not ready yet.
application/json
Schema · JSON
{
"type": "object",
"required": [
"id",
"state",
"execution_mode",
"reservation_id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"reservation_id": {
"type": "string",
"format": "uuid"
},
"pool_id": {
"type": "string",
"format": "uuid"
},
"units": {
"type": "integer"
},
"unit_gpus": {
"type": "integer"
},
"execution_mode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL"
]
},
"state": {
"type": "string",
"enum": [
"REQUESTED",
"PROVISIONING",
"READY",
"RECONCILING",
"DRAINING",
"RELEASED"
]
},
"external_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requested_end_at": {
"type": "string",
"format": "date-time"
},
"expiry_review_required": {
"type": "boolean"
},
"version": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"ready_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"released_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Read allocation state
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": true
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Read infrastructure operation state
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": true
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Schema definitions
Expand a named definition to resolve #/components/schemas/… references in this contract. These definitions contain only schemas reachable from the published Customer operations.
ProductCatalogPage
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductCatalogItem"
},
"maxItems": 100
},
"nextCursor": {
"type": "string",
"nullable": true
}
}
}ProductCatalogItem
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"displayName",
"family",
"modalities",
"capabilities",
"limits",
"visibility",
"entitled",
"availability",
"qualification",
"metadataSource",
"price"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"displayName": {
"type": "string"
},
"family": {
"type": "string",
"nullable": true
},
"modalities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"text",
"image",
"audio",
"video"
]
},
"nullable": true
},
"capabilities": {
"$ref": "#/components/schemas/ProductCatalogCapabilities"
},
"limits": {
"$ref": "#/components/schemas/ProductCatalogLimits"
},
"visibility": {
"type": "string",
"enum": [
"PUBLISHED"
]
},
"entitled": {
"type": "boolean"
},
"availability": {
"$ref": "#/components/schemas/ProductCatalogAvailability"
},
"qualification": {
"$ref": "#/components/schemas/ProductCatalogQualification"
},
"metadataSource": {
"type": "string",
"nullable": true
},
"price": {
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency",
"unit",
"source",
"version",
"approvedAt"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^[0-9]{1,18}([.][0-9]{1,12})?$"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"unit": {
"type": "string",
"enum": [
"MILLION_INPUT_TOKENS",
"MILLION_OUTPUT_TOKENS",
"REQUEST"
]
},
"source": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"approvedAt": {
"type": "string",
"format": "date-time"
}
},
"nullable": true
}
}
}ProductCatalogCapabilities
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"tools",
"streaming",
"structuredOutput"
],
"properties": {
"tools": {
"type": "boolean",
"nullable": true
},
"streaming": {
"type": "boolean",
"nullable": true
},
"structuredOutput": {
"type": "boolean",
"nullable": true
}
}
}ProductCatalogLimits
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"contextTokens",
"maxOutputTokens"
],
"properties": {
"contextTokens": {
"type": "integer",
"minimum": 1
},
"maxOutputTokens": {
"type": "integer",
"minimum": 1
}
}
}ProductCatalogAvailability
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"status",
"reason",
"executionMode"
],
"properties": {
"status": {
"type": "string",
"enum": [
"AVAILABLE",
"UNAVAILABLE"
]
},
"reason": {
"type": "string",
"enum": [
"NOT_ENTITLED",
"REVISION_PROOF_CURRENT",
"NO_FRESH_READY_REVISION"
]
},
"executionMode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL",
null
],
"nullable": true
}
}
}ProductCatalogQualification
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"REAL_PROOF_CURRENT",
"FIXTURE_PROOF_CURRENT",
"UNVERIFIED"
]
}
}
}ProductManagementErrorEnvelope
Schema · JSON
{
"oneOf": [
{
"$ref": "#/components/schemas/ProductManagementFilterError"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"code": {
"enum": [
"RATE_LIMITED"
],
"type": "string"
}
}
}
}
}
]
}ProductManagementFilterError
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"additionalProperties": false,
"required": [
"code",
"message",
"type",
"requestId",
"retryable",
"dispatched"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"server_error",
"rate_limit_error",
"invalid_request_error"
]
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"dispatched": {
"enum": [
false
],
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}ProductCatalogDetail
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"displayName",
"family",
"modalities",
"capabilities",
"limits",
"visibility",
"entitled",
"availability",
"qualification",
"metadataSource",
"price",
"apiExample",
"configurationGuidance"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"displayName": {
"type": "string"
},
"family": {
"type": "string",
"nullable": true
},
"modalities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"text",
"image",
"audio",
"video"
]
},
"nullable": true
},
"capabilities": {
"$ref": "#/components/schemas/ProductCatalogCapabilities"
},
"limits": {
"$ref": "#/components/schemas/ProductCatalogLimits"
},
"visibility": {
"type": "string",
"enum": [
"PUBLISHED"
]
},
"entitled": {
"type": "boolean"
},
"availability": {
"$ref": "#/components/schemas/ProductCatalogAvailability"
},
"qualification": {
"$ref": "#/components/schemas/ProductCatalogQualification"
},
"metadataSource": {
"type": "string",
"nullable": true
},
"price": {
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency",
"unit",
"source",
"version",
"approvedAt"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^[0-9]{1,18}([.][0-9]{1,12})?$"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"unit": {
"type": "string",
"enum": [
"MILLION_INPUT_TOKENS",
"MILLION_OUTPUT_TOKENS",
"REQUEST"
]
},
"source": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"approvedAt": {
"type": "string",
"format": "date-time"
}
},
"nullable": true
},
"apiExample": {
"type": "object",
"additionalProperties": false,
"required": [
"method",
"path",
"body"
],
"properties": {
"method": {
"type": "string",
"enum": [
"POST"
]
},
"path": {
"type": "string",
"enum": [
"/v1/chat/completions"
]
},
"body": {
"type": "object",
"additionalProperties": false,
"required": [
"model",
"messages",
"stream",
"max_tokens"
],
"properties": {
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"role",
"content"
],
"properties": {
"role": {
"type": "string",
"enum": [
"user"
]
},
"content": {
"type": "string"
}
}
},
"minItems": 1,
"maxItems": 1
},
"stream": {
"enum": [
false
],
"type": "boolean"
},
"max_tokens": {
"type": "integer",
"minimum": 1,
"maximum": 128
}
}
}
},
"nullable": true
},
"configurationGuidance": {
"type": "array",
"items": {
"type": "string"
}
}
}
}ManagedQuoteInput
Schema · JSON
{
"type": "object",
"properties": {
"offerId": {
"type": "string"
},
"requestedEndAt": {
"type": "string"
}
},
"required": [
"offerId",
"requestedEndAt"
]
}WaitlistInput
Schema · JSON
{
"type": "object",
"properties": {
"intentId": {
"type": "string"
},
"email": {
"type": "boolean"
}
},
"required": [
"intentId",
"email"
]
}ReservationInput
Schema · JSON
{
"type": "object",
"properties": {
"acceptedQuoteId": {
"type": "string",
"description": "Exact immutable liability quote accepted for a budget-controlled allocation."
},
"acceptedPolicyId": {
"type": "string",
"description": "Exact approved compute policy accepted by customer; required for policy-backed supply."
},
"offerId": {
"type": "string"
},
"units": {
"type": "number",
"example": 1,
"description": "Whole allocation units, not fractional GPUs."
},
"requestedEndAt": {
"type": "string",
"example": "2026-11-01T12:00:00Z",
"description": "UTC end time, within 31 days. Expiry triggers operator review, not automatic destruction."
}
},
"required": [
"offerId",
"units",
"requestedEndAt"
]
}InstanceInput
Schema · JSON
{
"type": "object",
"properties": {
"reservationId": {
"type": "string"
}
},
"required": [
"reservationId"
]
}Object
Schema · JSON
{
"type": "object",
"properties": {}
}